ServerContext (OpenDJ Public API Javadoc 6.5.6 Documentation)

```
public interface ServerContext
```
Context for the server, giving access to global properties of the server.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`deregisterMonitorProvider(MonitorProvider monitorProvider)` Deregisters the specified monitor provider from the Directory Server.
`BackendConfigManager`	`getBackendConfigManager()` Returns the manager of backends.
`CommonAudit`	`getCommonAudit()` Returns the common audit manager.
`ConfigurationHandler`	`getConfigurationHandler()` Returns the configuration handler, which provides operations to the configuration.
`CoreConfigManager`	`getCoreConfigManager()` Returns the manager of core configuration.
`ScheduledExecutorService`	`getCronExecutorService()` Returns the UNIX's cron-like executor service.
`CryptoManager`	`getCryptoManager()` Returns the Crypto Manager for the instance.
`DiskSpaceMonitor`	`getDiskSpaceMonitor()` Returns the Disk Space Monitoring service, for checking free disk space.
`DirectoryEnvironmentConfig`	`getEnvironment()` Returns the environment of the server.
`HealthChecker`	`getHealthChecker()` Returns the `HealthChecker` that aggregates all the `HealthStatusProvider` for diagnosing the global server health.
`org.forgerock.http.routing.Router`	`getHttpRouter()` Returns the HTTP request router.
`String`	`getInstanceRoot()` Returns the directory of server instance.
`KeyManagerProvider<?>`	`getKeyManagerProvider(Dn keyManagerProviderDN)` Returns the key manager provider matching the provided DN.
`RequestHandler`	`getLdapRouter()` Returns the router, which routes the LDAP requests to appropriate backend(s).
`LockManager`	`getLockManager()` Returns the lock manager which will be used for coordinating access to LDAP entries.
`LoggerConfigManager`	`getLoggerConfigManager()` Returns the logger config manager.
`MemoryQuota`	`getMemoryQuota()` Returns the memory quota system for reserving long term memory.
`MeterRegistry`	`getMeterRegistry()` Returns the global `MeterRegistry` that contains all metrics for all monitor providers.
`RootCfg`	`getRootConfig()` Returns the root configuration object.
`Schema`	`getSchema()` Returns the schema of the server.
`SchemaHandler`	`getSchemaHandler()` Returns the schema handler, which provides operations to the schema.
`ServerManagementContext`	`getServerManagementContext()` Returns the server management context, which gives an entry point on configuration objects.
`String`	`getServerRoot()` Returns the root directory of server.
`ServiceDiscoveryMechanismConfigManager`	`getServiceDiscoveryMechanismConfigManager()` Returns the Service Discovery Mechanism Config Manager.
`PrintStream`	`getStdoutAtProcessStart()` Returns the original stdout at the time the process started, before its redefinition by DJ.
`TrustManagerProvider<?>`	`getTrustManagerProvider(Dn trustManagerProviderDN)` Returns the trust manager provider matching the provided DN.
`void`	`registerMonitorProvider(MonitorProvider monitorProvider)` Registers the provided monitor provider with the Directory Server.

- 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 SchemaHandler which is available through the getSchemaHandler() 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
  - getLdapRouter
```
RequestHandler getLdapRouter()
```
    Returns the router, which routes the LDAP requests to appropriate backend(s).
    
    Returns:
    
    the reactive handler corresponding to the router
  - 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
  - getLockManager
```
LockManager getLockManager()
```
    Returns the lock manager which will be used for coordinating access to LDAP entries.
    
    Returns:
    
    the lock manager which will be used for coordinating access to LDAP entries
  - 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 null if 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 null if none match
  - getMeterRegistry
```
MeterRegistry getMeterRegistry()
```
    Returns the global MeterRegistry that contains all metrics for all monitor providers.
    
    Returns:
    
    The global MeterRegistry that contains all metrics for all monitor providers.
  - getHealthChecker
```
HealthChecker getHealthChecker()
```
    Returns the HealthChecker that aggregates all the HealthStatusProvider for diagnosing the global server health.
    
    Returns:
    
    The health-checker for diagnosing the global server health.
  - getStdoutAtProcessStart
```
PrintStream getStdoutAtProcessStart()
```
    Returns the original stdout at the time the process started, before its redefinition by DJ.
    
    Returns:
    
    the original stdout at the time the process started, before its redefinition by DJ
  - registerMonitorProvider
```
void registerMonitorProvider(MonitorProvider monitorProvider)
```
    Registers the provided monitor provider with the Directory Server. Note that if a monitor provider is already registered with the specified name, then it will be replaced with the provided implementation.
    
    Parameters:
    
    monitorProvider - The monitor provider to register with the Directory Server.
  - deregisterMonitorProvider
```
void deregisterMonitorProvider(MonitorProvider monitorProvider)
```
    Deregisters the specified monitor provider from the Directory Server. If no such monitor provider is registered, no action will be taken.
    
    Parameters:
    
    monitorProvider - The monitor provider to deregister from the Directory Server.

Interface ServerContext

Method Summary

Method Detail

getInstanceRoot

getServerRoot

getSchema

getSchemaHandler

getConfigurationHandler

getEnvironment

getServerManagementContext

getRootConfig

getLdapRouter

getMemoryQuota

getDiskSpaceMonitor

getHttpRouter

getCommonAudit

getServiceDiscoveryMechanismConfigManager

getLoggerConfigManager

getCryptoManager

getCronExecutorService

getLockManager

getBackendConfigManager

getCoreConfigManager

getKeyManagerProvider

getTrustManagerProvider

getMeterRegistry

getHealthChecker

getStdoutAtProcessStart

registerMonitorProvider

deregisterMonitorProvider