@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class DirectoryConfig extends Object
Constructor and Description |
---|
DirectoryConfig() |
Modifier and Type | Method and Description |
---|---|
static void |
deregisterAlertGenerator(AlertGenerator alertGenerator)
Deregisters the provided alert generator with the Directory
Server.
|
static void |
deregisterSASLMechanismHandler(String name)
Deregisters the provided SASL mechanism handler with the
Directory Server.
|
static void |
deregisterShutdownListener(ServerShutdownListener listener)
Deregisters the provided shutdown listener with the Directory
Server.
|
static void |
deregisterSupportedControl(String controlOID)
Deregisters the provided OID as a supported control for the
Directory Server.
|
static void |
deregisterSupportedExtension(String oid)
Deregisters the provided extended operation handler with the
Directory Server.
|
static void |
deregisterSupportedFeature(String featureOID)
Deregisters the provided OID as a supported feature for the
Directory Server.
|
static boolean |
entryExists(org.forgerock.opendj.ldap.Dn entryDN)
Indicates whether the specified entry exists in the Directory
Server.
|
static Entry |
getEntry(org.forgerock.opendj.ldap.Dn entryDN)
Retrieves the entry with the requested DN.
|
static ExtendedOperationHandler<?> |
getExtendedOperationHandler(String oid)
Retrieves the handler for the extended operation for the provided
extended operation OID.
|
static com.forgerock.opendj.util.OperatingSystem |
getOperatingSystem()
Retrieves the operating system on which the Directory Server is
running.
|
static SASLMechanismHandler<?> |
getSASLMechanismHandler(String name)
Retrieves the handler for the specified SASL mechanism.
|
static String |
getServerRoot()
Retrieves the path to the root directory for this instance of the
Directory Server.
|
static long |
getStartTime()
Retrieves the time that the Directory Server was started, in
milliseconds since the epoch.
|
static String |
getStartTimeUTC()
Retrieves the time that the Directory Server was started,
formatted in UTC.
|
static Set<String> |
getSupportedControls()
Retrieves the set of OIDs for the supported controls registered
with the Directory Server.
|
static Set<String> |
getSupportedFeatures()
Retrieves the set of OIDs for the supported features registered
with the Directory Server.
|
static String |
getVersionString()
Retrieves the full version string for the Directory Server.
|
static boolean |
isSupportedControl(String controlOID)
Indicates whether the specified OID is registered with the
Directory Server as a supported control.
|
static boolean |
isSupportedFeature(String featureOID)
Indicates whether the specified OID is registered with the
Directory Server as a supported feature.
|
static void |
registerAlertGenerator(AlertGenerator alertGenerator)
Registers the provided alert generator with the Directory Server.
|
static void |
registerSASLMechanismHandler(String name,
SASLMechanismHandler<?> handler)
Registers the provided SASL mechanism handler with the Directory
Server.
|
static void |
registerShutdownListener(ServerShutdownListener listener)
Registers the provided shutdown listener with the Directory
Server so that it will be notified when the server shuts down.
|
static void |
registerSupportedControl(String controlOID)
Registers the provided OID as a supported control for the
Directory Server.
|
static void |
registerSupportedExtension(String oid,
ExtendedOperationHandler<?> handler)
Registers the provided extended operation handler with the
Directory Server.
|
static void |
registerSupportedFeature(String featureOID)
Registers the provided OID as a supported feature for the
Directory Server.
|
static void |
sendAlertNotification(AlertGenerator generator,
String alertType,
LocalizableMessage alertMessage)
Sends an alert notification with the provided information.
|
public DirectoryConfig()
public static com.forgerock.opendj.util.OperatingSystem getOperatingSystem()
public static String getServerRoot()
public static long getStartTime()
public static String getStartTimeUTC()
public static void registerAlertGenerator(AlertGenerator alertGenerator)
alertGenerator
- The alert generator to register.public static void deregisterAlertGenerator(AlertGenerator alertGenerator)
alertGenerator
- The alert generator to deregister.public static void sendAlertNotification(AlertGenerator generator, String alertType, LocalizableMessage alertMessage)
generator
- The alert generator that created the alert.alertType
- The alert type name for this alert.alertMessage
- A message (possibly null
) that
can provide more information about this
alert.public static Entry getEntry(org.forgerock.opendj.ldap.Dn entryDN) throws DirectoryException
entryDN
- The DN of the entry to retrieve.null
if it does not
exist.DirectoryException
- If a problem occurs while attempting
to retrieve the entry.public static boolean entryExists(org.forgerock.opendj.ldap.Dn entryDN) throws DirectoryException
entryDN
- The DN of the entry for which to make the
determination.true
if the specified entry exists in one
of the backends, or false
if it does not.DirectoryException
- If a problem occurs while attempting
to make the determination.public static Set<String> getSupportedControls()
public static boolean isSupportedControl(String controlOID)
controlOID
- The OID of the control for which to make the
determination.true
if the specified OID is registered
with the server as a supported control, or
false
if not.public static void registerSupportedControl(String controlOID)
controlOID
- The OID of the control to register as a
supported control.public static void deregisterSupportedControl(String controlOID)
controlOID
- The OID of the control to deregister as a
supported control.public static Set<String> getSupportedFeatures()
public static boolean isSupportedFeature(String featureOID)
featureOID
- The OID of the feature for which to make the
determination.true
if the specified OID is registered
with the server as a supported feature, or
false
if not.public static void registerSupportedFeature(String featureOID)
featureOID
- The OID of the feature to register as a
supported feature.public static void deregisterSupportedFeature(String featureOID)
featureOID
- The OID of the feature to deregister as a
supported feature.public static ExtendedOperationHandler<?> getExtendedOperationHandler(String oid)
oid
- The OID of the extended operation to retrieve.null
if there is none.public static void registerSupportedExtension(String oid, ExtendedOperationHandler<?> handler)
oid
- The OID for the extended operation to register.handler
- The extended operation handler to register with
the Directory Server.public static void deregisterSupportedExtension(String oid)
oid
- The OID for the extended operation to deregister.public static SASLMechanismHandler<?> getSASLMechanismHandler(String name)
name
- The name of the SASL mechanism to retrieve.null
if there is none.public static void registerSASLMechanismHandler(String name, SASLMechanismHandler<?> handler)
name
- The name of the SASL mechanism to be registered.handler
- The SASL mechanism handler to register with the
Directory Server.public static void deregisterSASLMechanismHandler(String name)
name
- The name of the SASL mechanism to be deregistered.public static void registerShutdownListener(ServerShutdownListener listener)
listener
- The shutdown listener to register with the
Directory Server.public static void deregisterShutdownListener(ServerShutdownListener listener)
listener
- The shutdown listener to deregister with the
Directory Server.public static String getVersionString()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.