Package org.opends.server.core
Interface ServerContext
-
public interface ServerContextContext for the server, giving access to global properties of the server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BackendConfigManagergetBackendConfigManager()Returns the manager of backends.CommonAuditgetCommonAudit()Returns the common audit manager.ConfigurationHandlergetConfigurationHandler()Returns the configuration handler, which provides operations to the configuration.CoreConfigManagergetCoreConfigManager()Returns the manager of core configuration.ScheduledExecutorServicegetCronExecutorService()Returns the UNIX's cron-like executor service.CryptoManagergetCryptoManager()Returns the Crypto Manager for the instance.DiskSpaceMonitorgetDiskSpaceMonitor()Returns the Disk Space Monitoring service, for checking free disk space.DirectoryEnvironmentConfiggetEnvironment()Returns the environment of the server.org.forgerock.http.routing.RoutergetHTTPRouter()Returns the HTTP request router.StringgetInstanceRoot()Returns the directory of server instance.KeyManagerProvider<?>getKeyManagerProvider(DN keyManagerProviderDN)Returns the key manager provider matching the provided DN.LoggerConfigManagergetLoggerConfigManager()Returns the logger config manager.MemoryQuotagetMemoryQuota()Returns the memory quota system for reserving long term memory.RootCfggetRootConfig()Returns the root configuration object.SchemagetSchema()Returns the schema of the server.SchemaHandlergetSchemaHandler()Returns the schema handler, which provides operations to the schema.ServerManagementContextgetServerManagementContext()Returns the server management context, which gives an entry point on configuration objects.StringgetServerRoot()Returns the root directory of server.ServiceDiscoveryMechanismConfigManagergetServiceDiscoveryMechanismConfigManager()Returns the Service Discovery Mechanism Config Manager.TrustManagerProvider<?>getTrustManagerProvider(DN trustManagerProviderDN)Returns the trust manager provider matching the provided DN.
-
-
-
Method Detail
-
getInstanceRoot
String getInstanceRoot()
Returns the directory of server instance.- Returns:
- the instance root directory
-
getServerRoot
String getServerRoot()
Returns the root directory of server.- Returns:
- the server root directory
-
getSchema
Schema getSchema()
Returns the schema of the server.The schema is immutable. Any change on the schema must be done using a
SchemaHandlerwhich is available through thegetSchemaHandler()method.- Returns:
- the schema
-
getSchemaHandler
SchemaHandler getSchemaHandler()
Returns the schema handler, which provides operations to the schema.- Returns:
- the schema handler
-
getConfigurationHandler
ConfigurationHandler getConfigurationHandler()
Returns the configuration handler, which provides operations to the configuration.- Returns:
- the configuration handler
-
getEnvironment
DirectoryEnvironmentConfig getEnvironment()
Returns the environment of the server.- Returns:
- the environment
-
getServerManagementContext
ServerManagementContext getServerManagementContext()
Returns the server management context, which gives an entry point on configuration objects.- Returns:
- the server management context
-
getRootConfig
RootCfg getRootConfig()
Returns the root configuration object.Equivalent to calling
getServerManagementContext().getRootConfiguration().- Returns:
- the root configuration object
-
getMemoryQuota
MemoryQuota getMemoryQuota()
Returns the memory quota system for reserving long term memory.- Returns:
- the memory quota system
-
getDiskSpaceMonitor
DiskSpaceMonitor getDiskSpaceMonitor()
Returns the Disk Space Monitoring service, for checking free disk space. Configure a directory to be monitored and optionally get alerted when disk space transitions from low to full to back to normal.- Returns:
- the Disk Space Monitoring service
-
getHTTPRouter
org.forgerock.http.routing.Router getHTTPRouter()
Returns the HTTP request router.- Returns:
- the HTTP Router service
-
getCommonAudit
CommonAudit getCommonAudit()
Returns the common audit manager.- Returns:
- the common audit manager
-
getServiceDiscoveryMechanismConfigManager
ServiceDiscoveryMechanismConfigManager getServiceDiscoveryMechanismConfigManager()
Returns the Service Discovery Mechanism Config Manager.- Returns:
- the Service Discovery Mechanism Config Manager
-
getLoggerConfigManager
LoggerConfigManager getLoggerConfigManager()
Returns the logger config manager.- Returns:
- the logger config manager
-
getCryptoManager
CryptoManager getCryptoManager()
Returns the Crypto Manager for the instance.- Returns:
- the Crypto Manager for the instance
-
getCronExecutorService
ScheduledExecutorService getCronExecutorService()
Returns the UNIX's cron-like executor service.- Returns:
- the UNIX's cron-like executor service
-
getBackendConfigManager
BackendConfigManager getBackendConfigManager()
Returns the manager of backends.- Returns:
- backend manager
-
getCoreConfigManager
CoreConfigManager getCoreConfigManager()
Returns the manager of core configuration.- Returns:
- core configuration manager
-
getKeyManagerProvider
KeyManagerProvider<?> getKeyManagerProvider(DN keyManagerProviderDN)
Returns the key manager provider matching the provided DN.- Parameters:
keyManagerProviderDN- the DN of the key manager provider- Returns:
- the key manager provider, or
nullif none match
-
getTrustManagerProvider
TrustManagerProvider<?> getTrustManagerProvider(DN trustManagerProviderDN)
Returns the trust manager provider matching the provided DN.- Parameters:
trustManagerProviderDN- the DN of the trust manager provider- Returns:
- the trust manager provider, or
nullif none match
-
-