org.opends.server.types
Class DirectoryConfig

java.lang.Object
  extended by org.opends.server.types.DirectoryConfig

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class DirectoryConfig
extends java.lang.Object

This interface defines a set of methods that may be used by third-party code to obtatin information about the core Directory Server configuration and the instances of various kinds of components that have registered themselves with the server.

Note that this interface is not intended to be implemented by any third-party code. It is merely used to control which elements are intended for use by external classes.


Constructor Summary
DirectoryConfig()
           
 
Method Summary
static void deregisterAlertGenerator(AlertGenerator alertGenerator)
          Deregisters the provided alert generator with the Directory Server.
static void deregisterChangeNotificationListener(ChangeNotificationListener changeListener)
          Deregisters the provided change notification listener with the Directory Server so that it will no longer be notified of any add, delete, modify, or modify DN operations that are performed.
static void deregisterInvokableComponent(InvokableComponent component)
          Deregisters the provided invokable component with the Directory Server.
static void deregisterSASLMechanismHandler(java.lang.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(java.lang.String controlOID)
          Deregisters the provided OID as a supported control for the Directory Server.
static void deregisterSupportedExtension(java.lang.String oid)
          Deregisters the provided extended operation handler with the Directory Server.
static void deregisterSupportedFeature(java.lang.String featureOID)
          Deregisters the provided OID as a supported feature for the Directory Server.
static boolean entryExists(DN entryDN)
          Indicates whether the specified entry exists in the Directory Server.
static ApproximateMatchingRule getApproximateMatchingRule(java.lang.String lowerName)
          Retrieves the approximate matching rule with the specified name or OID.
static AttributeSyntax getAttributeSyntax(java.lang.String oid, boolean allowDefault)
          Retrieves the requested attribute syntax.
static java.util.Map<java.lang.String,AttributeSyntax> getAttributeSyntaxes()
          Retrieves the set of attribute syntaxes defined in the Directory Server.
static AttributeType getAttributeType(java.lang.String lowerName, boolean returnDefault)
          Retrieves the attribute type for the provided lowercase name or OID.
static java.util.Map<java.lang.String,AttributeType> getAttributeTypes()
          Retrieves the set of attribute type definitions that have been defined in the Directory Server.
static ConfigEntry getConfigEntry(DN entryDN)
          Retrieves the requested entry from the Directory Server configuration.
static ConfigHandler getConfigHandler()
          Retrieves a reference to the Directory Server configuration handler.
static CryptoManager getCryptoManager()
          Retrieves a reference to the Directory Server crypto manager.
static AttributeSyntax getDefaultAttributeSyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema.
static AttributeSyntax getDefaultBinarySyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store binary values.
static AttributeSyntax getDefaultBooleanSyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store Boolean values.
static AttributeSyntax getDefaultDNSyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store DN values.
static AttributeSyntax getDefaultIntegerSyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store integer values.
static AttributeSyntax getDefaultStringSyntax()
          Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store string values.
static DITContentRule getDITContentRule(ObjectClass objectClass)
          Retrieves the DIT content rule associated with the specified objectclass.
static java.util.Map<ObjectClass,DITContentRule> getDITContentRules()
          Retrieves the set of DIT content rules defined in the Directory Server.
static DITStructureRule getDITStructureRule(int ruleID)
          Retrieves the DIT structure rule associated with the provided rule ID.
static DITStructureRule getDITStructureRule(NameForm nameForm)
          Retrieves the DIT structure rule associated with the provided name form.
static java.util.Map<NameForm,DITStructureRule> getDITStructureRules()
          Retrieves the set of DIT structure rules defined in the Directory Server.
static Entry getEntry(DN entryDN)
          Retrieves the entry with the requested DN.
static EqualityMatchingRule getEqualityMatchingRule(java.lang.String lowerName)
          Retrieves the equality matching rule with the specified name or OID.
static ExtendedOperationHandler getExtendedOperationHandler(java.lang.String oid)
          Retrieves the handler for the extended operation for the provided extended operation OID.
static MatchingRule getMatchingRule(java.lang.String lowerName)
          Retrieves the matching rule with the specified name or OID.
static java.util.Map<java.lang.String,MatchingRule> getMatchingRules()
          Retrieves the set of matching rules registered with the Directory Server.
static MatchingRuleUse getMatchingRuleUse(MatchingRule matchingRule)
          Retrieves the matching rule use associated with the provided matching rule.
static java.util.Map<MatchingRule,MatchingRuleUse> getMatchingRuleUses()
          Retrieves the set of matching rule uses defined in the Directory Server.
static NameForm getNameForm(ObjectClass objectClass)
          Retrieves the name form associated with the specified structural objectclass.
static NameForm getNameForm(java.lang.String lowerName)
          Retrieves the name form associated with the specified name or OID.
static java.util.Map<ObjectClass,NameForm> getNameForms()
          Retrieves the set of name forms defined in the Directory Server.
static ObjectClass getObjectClass(java.lang.String lowerName, boolean returnDefault)
          Retrieves the objectclass for the provided lowercase name or OID.
static AttributeType getObjectClassAttributeType()
          Retrieves the attribute type for the "objectClass" attribute.
static java.util.Map<java.lang.String,ObjectClass> getObjectClasses()
          Retrieves the set of objectclasses registered with the Directory Server.
static OperatingSystem getOperatingSystem()
          Retrieves the operating system on which the Directory Server is running.
static OrderingMatchingRule getOrderingMatchingRule(java.lang.String lowerName)
          Retrieves the ordering matching rule with the specified name or OID.
static SASLMechanismHandler getSASLMechanismHandler(java.lang.String name)
          Retrieves the handler for the specified SASL mechanism.
static Schema getSchema()
          Retrieves a reference to the Directory Server schema.
static ResultCode getServerErrorResultCode()
          Retrieves the result code that should be used when the Directory Server encounters an internal server error.
static java.lang.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 java.lang.String getStartTimeUTC()
          Retrieves the time that the Directory Server was started, formatted in UTC.
static SubstringMatchingRule getSubstringMatchingRule(java.lang.String lowerName)
          Retrieves the substring matching rule with the specified name or OID.
static java.util.Set<java.lang.String> getSupportedControls()
          Retrieves the set of OIDs for the supported controls registered with the Directory Server.
static java.util.Map<java.lang.String,ExtendedOperationHandler> getSupportedExtensions()
          Retrieves the set of extended operations that may be processed by the Directory Server.
static java.util.Set<java.lang.String> getSupportedFeatures()
          Retrieves the set of OIDs for the supported features registered with the Directory Server.
static java.util.Map<java.lang.String,SASLMechanismHandler> getSupportedSASLMechanisms()
          Retrieves the set of SASL mechanisms that are supported by the Directory Server.
static ObjectClass getTopObjectClass()
          Retrieves the "top" objectClass, which should be the topmost objectclass in the inheritance chain for most other objectclasses.
static java.lang.String getVersionString()
          Retrieves the full version string for the Directory Server.
static boolean isSupportedControl(java.lang.String controlOID)
          Indicates whether the specified OID is registered with the Directory Server as a supported control.
static boolean isSupportedFeature(java.lang.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 registerChangeNotificationListener(ChangeNotificationListener changeListener)
          Registers the provided change notification listener with the Directory Server so that it will be notified of any add, delete, modify, or modify DN operations that are performed.
static void registerInvokableComponent(InvokableComponent component)
          Registers the provided invokable component with the Directory Server.
static void registerSASLMechanismHandler(java.lang.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(java.lang.String controlOID)
          Registers the provided OID as a supported control for the Directory Server.
static void registerSupportedExtension(java.lang.String oid, ExtendedOperationHandler handler)
          Registers the provided extended operation handler with the Directory Server.
static void registerSupportedFeature(java.lang.String featureOID)
          Registers the provided OID as a supported feature for the Directory Server.
static void sendAlertNotification(AlertGenerator generator, java.lang.String alertType, Message alertMessage)
          Sends an alert notification with the provided information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectoryConfig

public DirectoryConfig()
Method Detail

getCryptoManager

public static CryptoManager getCryptoManager()
Retrieves a reference to the Directory Server crypto manager.

Returns:
A reference to the Directory Server crypto manager.

getOperatingSystem

public static OperatingSystem getOperatingSystem()
Retrieves the operating system on which the Directory Server is running.

Returns:
The operating system on which the Directory Server is running.

getConfigHandler

public static ConfigHandler getConfigHandler()
Retrieves a reference to the Directory Server configuration handler.

Returns:
A reference to the Directory Server configuration handler.

getConfigEntry

public static ConfigEntry getConfigEntry(DN entryDN)
                                  throws ConfigException
Retrieves the requested entry from the Directory Server configuration.

Parameters:
entryDN - The DN of the configuration entry to retrieve.
Returns:
The requested entry from the Directory Server configuration.
Throws:
ConfigException - If a problem occurs while trying to retrieve the requested entry.

getServerRoot

public static java.lang.String getServerRoot()
Retrieves the path to the root directory for this instance of the Directory Server.

Returns:
The path to the root directory for this instance of the Directory Server.

getStartTime

public static long getStartTime()
Retrieves the time that the Directory Server was started, in milliseconds since the epoch.

Returns:
The time that the Directory Server was started, in milliseconds since the epoch.

getStartTimeUTC

public static java.lang.String getStartTimeUTC()
Retrieves the time that the Directory Server was started, formatted in UTC.

Returns:
The time that the Directory Server was started, formatted in UTC.

getSchema

public static Schema getSchema()
Retrieves a reference to the Directory Server schema.

Returns:
A reference to the Directory Server schema.

getMatchingRules

public static java.util.Map<java.lang.String,MatchingRule> getMatchingRules()
Retrieves the set of matching rules registered with the Directory Server. The mapping will be between the lowercase name or OID for each matching rule and the matching rule implementation. The same matching rule instance may be included multiple times with different keys. The returned map must not be altered by the caller.

Returns:
The set of matching rules registered with the Directory Server.

getMatchingRule

public static MatchingRule getMatchingRule(java.lang.String lowerName)
Retrieves the matching rule with the specified name or OID.

Parameters:
lowerName - The lowercase name or OID for the matching rule to retrieve.
Returns:
The requested matching rule, or null if no such matching rule has been defined in the server.

getApproximateMatchingRule

public static ApproximateMatchingRule getApproximateMatchingRule(java.lang.String lowerName)
Retrieves the approximate matching rule with the specified name or OID.

Parameters:
lowerName - The lowercase name or OID for the approximate matching rule to retrieve.
Returns:
The requested approximate matching rule, or null if no such matching rule has been defined in the server.

getEqualityMatchingRule

public static EqualityMatchingRule getEqualityMatchingRule(java.lang.String lowerName)
Retrieves the equality matching rule with the specified name or OID.

Parameters:
lowerName - The lowercase name or OID for the equality matching rule to retrieve.
Returns:
The requested equality matching rule, or null if no such matching rule has been defined in the server.

getOrderingMatchingRule

public static OrderingMatchingRule getOrderingMatchingRule(java.lang.String lowerName)
Retrieves the ordering matching rule with the specified name or OID.

Parameters:
lowerName - The lowercase name or OID for the ordering matching rule to retrieve.
Returns:
The requested ordering matching rule, or null if no such matching rule has been defined in the server.

getSubstringMatchingRule

public static SubstringMatchingRule getSubstringMatchingRule(java.lang.String lowerName)
Retrieves the substring matching rule with the specified name or OID.

Parameters:
lowerName - The lowercase name or OID for the substring matching rule to retrieve.
Returns:
The requested substring matching rule, or null if no such matching rule has been defined in the server.

getObjectClasses

public static java.util.Map<java.lang.String,ObjectClass> getObjectClasses()
Retrieves the set of objectclasses registered with the Directory Server. The mapping will be between the lowercase name or OID for each objectclass and the objectclass implementation. The same objectclass instance may be included multiple times with different keys. The returned map must not be altered by the caller.

Returns:
The set of objectclasses defined in the Directory Server.

getObjectClass

public static ObjectClass getObjectClass(java.lang.String lowerName,
                                         boolean returnDefault)
Retrieves the objectclass for the provided lowercase name or OID. It can optionally return a generated "default" version if the requested objectclass is not defined in the schema.

Parameters:
lowerName - The lowercase name or OID for the objectclass to retrieve.
returnDefault - Indicates whether to generate a default version if the requested objectclass is not defined in the server schema.
Returns:
The objectclass type, or null if there is no objectclass with the specified name or OID defined in the server schema and a default class should not be returned.

getTopObjectClass

public static ObjectClass getTopObjectClass()
Retrieves the "top" objectClass, which should be the topmost objectclass in the inheritance chain for most other objectclasses.

Returns:
The "top" objectClass.

getAttributeTypes

public static java.util.Map<java.lang.String,AttributeType> getAttributeTypes()
Retrieves the set of attribute type definitions that have been defined in the Directory Server. The mapping will be between the lowercase name or OID for each attribute type and the attribute type implementation. The same attribute type may be included multiple times with different keys. The returned map must not be altered by the caller.

Returns:
The set of attribute type definitions that have been defined in the Directory Server.

getAttributeType

public static AttributeType getAttributeType(java.lang.String lowerName,
                                             boolean returnDefault)
Retrieves the attribute type for the provided lowercase name or OID. It can optionally return a generated "default" version if the requested attribute type is not defined in the schema.

Parameters:
lowerName - The lowercase name or OID for the attribute type to retrieve.
returnDefault - Indicates whether to generate a default version if the requested attribute type is not defined in the server schema.
Returns:
The requested attribute type, or null if there is no attribute with the specified type defined in the server schema and a default type should not be returned.

getObjectClassAttributeType

public static AttributeType getObjectClassAttributeType()
Retrieves the attribute type for the "objectClass" attribute.

Returns:
The attribute type for the "objectClass" attribute.

getAttributeSyntaxes

public static java.util.Map<java.lang.String,AttributeSyntax> getAttributeSyntaxes()
Retrieves the set of attribute syntaxes defined in the Directory Server. The mapping will be between the OID and the corresponding syntax implementation. The returned map must not be altered by the caller.

Returns:
The set of attribute syntaxes defined in the Directory Server.

getAttributeSyntax

public static AttributeSyntax getAttributeSyntax(java.lang.String oid,
                                                 boolean allowDefault)
Retrieves the requested attribute syntax.

Parameters:
oid - The OID of the syntax to retrieve.
allowDefault - Indicates whether to return the default attribute syntax if the requested syntax is unknown.
Returns:
The requested attribute syntax, the default syntax if the requested syntax is unknown and the caller has indicated that the default is acceptable, or null otherwise.

getDefaultAttributeSyntax

public static AttributeSyntax getDefaultAttributeSyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema.

getDefaultBinarySyntax

public static AttributeSyntax getDefaultBinarySyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store binary values.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store binary values.

getDefaultBooleanSyntax

public static AttributeSyntax getDefaultBooleanSyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store Boolean values.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store Boolean values.

getDefaultDNSyntax

public static AttributeSyntax getDefaultDNSyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store DN values.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store DN values.

getDefaultIntegerSyntax

public static AttributeSyntax getDefaultIntegerSyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store integer values.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store integer values.

getDefaultStringSyntax

public static AttributeSyntax getDefaultStringSyntax()
Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store string values.

Returns:
The default attribute syntax that should be used for attributes that are not defined in the server schema and are meant to store string values.

getMatchingRuleUses

public static java.util.Map<MatchingRule,MatchingRuleUse> getMatchingRuleUses()
Retrieves the set of matching rule uses defined in the Directory Server. The mapping will be between the matching rule and its corresponding matching rule use. The returned map must not be altered by the caller.

Returns:
The set of matching rule uses defined in the Directory Server.

getMatchingRuleUse

public static MatchingRuleUse getMatchingRuleUse(MatchingRule matchingRule)
Retrieves the matching rule use associated with the provided matching rule.

Parameters:
matchingRule - The matching rule for which to retrieve the matching rule use.
Returns:
The matching rule use for the provided matching rule, or null if none is defined.

getDITContentRules

public static java.util.Map<ObjectClass,DITContentRule> getDITContentRules()
Retrieves the set of DIT content rules defined in the Directory Server. The mapping will be between the structural objectclass and its corresponding DIT content rule. The returned map must not be altered by the caller.

Returns:
The set of DIT content rules defined in the Directory Server.

getDITContentRule

public static DITContentRule getDITContentRule(ObjectClass objectClass)
Retrieves the DIT content rule associated with the specified objectclass.

Parameters:
objectClass - The objectclass for which to retrieve the associated DIT content rule.
Returns:
The requested DIT content rule, or null if no such rule is defined in the schema.

getDITStructureRules

public static java.util.Map<NameForm,DITStructureRule> getDITStructureRules()
Retrieves the set of DIT structure rules defined in the Directory Server. The mapping will be between the name form and its corresponding DIT structure rule. The returned map must not be altered by the caller.

Returns:
The set of DIT structure rules defined in the Directory Server.

getDITStructureRule

public static DITStructureRule getDITStructureRule(int ruleID)
Retrieves the DIT structure rule associated with the provided rule ID.

Parameters:
ruleID - The rule ID for which to retrieve the associated DIT structure rule.
Returns:
The requested DIT structure rule, or null if no such rule is defined.

getDITStructureRule

public static DITStructureRule getDITStructureRule(NameForm nameForm)
Retrieves the DIT structure rule associated with the provided name form.

Parameters:
nameForm - The name form for which to retrieve the associated DIT structure rule.
Returns:
The requested DIT structure rule, or null if no such rule is defined.

getNameForms

public static java.util.Map<ObjectClass,NameForm> getNameForms()
Retrieves the set of name forms defined in the Directory Server. The mapping will be between the structural objectclass and its corresponding name form. The returned map must not be altered by the caller.

Returns:
The set of name forms defined in the Directory Server.

getNameForm

public static NameForm getNameForm(ObjectClass objectClass)
Retrieves the name form associated with the specified structural objectclass.

Parameters:
objectClass - The structural objectclass for which to retrieve the associated name form.
Returns:
The requested name form, or null if no such name form is defined in the schema.

getNameForm

public static NameForm getNameForm(java.lang.String lowerName)
Retrieves the name form associated with the specified name or OID.

Parameters:
lowerName - The name or OID of the name form to retrieve, formatted in all lowercase characters.
Returns:
The requested name form, or null if no such name form is defined in the schema.

registerInvokableComponent

public static void registerInvokableComponent(InvokableComponent component)
Registers the provided invokable component with the Directory Server.

Parameters:
component - The invokable component to register.

deregisterInvokableComponent

public static void deregisterInvokableComponent(InvokableComponent component)
Deregisters the provided invokable component with the Directory Server.

Parameters:
component - The invokable component to deregister.

registerAlertGenerator

public static void registerAlertGenerator(AlertGenerator alertGenerator)
Registers the provided alert generator with the Directory Server.

Parameters:
alertGenerator - The alert generator to register.

deregisterAlertGenerator

public static void deregisterAlertGenerator(AlertGenerator alertGenerator)
Deregisters the provided alert generator with the Directory Server.

Parameters:
alertGenerator - The alert generator to deregister.

sendAlertNotification

public static void sendAlertNotification(AlertGenerator generator,
                                         java.lang.String alertType,
                                         Message alertMessage)
Sends an alert notification with the provided information.

Parameters:
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.

getServerErrorResultCode

public static ResultCode getServerErrorResultCode()
Retrieves the result code that should be used when the Directory Server encounters an internal server error.

Returns:
The result code that should be used when the Directory Server encounters an internal server error.

getEntry

public static Entry getEntry(DN entryDN)
                      throws DirectoryException
Retrieves the entry with the requested DN. It will first determine which backend should be used for this DN and will then use that backend to retrieve the entry. The caller must already hold the appropriate lock on the specified entry.

Parameters:
entryDN - The DN of the entry to retrieve.
Returns:
The requested entry, or null if it does not exist.
Throws:
DirectoryException - If a problem occurs while attempting to retrieve the entry.

entryExists

public static boolean entryExists(DN entryDN)
                           throws DirectoryException
Indicates whether the specified entry exists in the Directory Server. The caller is not required to hold any locks when invoking this method.

Parameters:
entryDN - The DN of the entry for which to make the determination.
Returns:
true if the specified entry exists in one of the backends, or false if it does not.
Throws:
DirectoryException - If a problem occurs while attempting to make the determination.

getSupportedControls

public static java.util.Set<java.lang.String> getSupportedControls()
Retrieves the set of OIDs for the supported controls registered with the Directory Server.

Returns:
The set of OIDS for the supported controls registered with the Directory Server.

isSupportedControl

public static boolean isSupportedControl(java.lang.String controlOID)
Indicates whether the specified OID is registered with the Directory Server as a supported control.

Parameters:
controlOID - The OID of the control for which to make the determination.
Returns:
true if the specified OID is registered with the server as a supported control, or false if not.

registerSupportedControl

public static void registerSupportedControl(java.lang.String controlOID)
Registers the provided OID as a supported control for the Directory Server. This will have no effect if the specified control OID is already present in the list of supported controls.

Parameters:
controlOID - The OID of the control to register as a supported control.

deregisterSupportedControl

public static void deregisterSupportedControl(java.lang.String controlOID)
Deregisters the provided OID as a supported control for the Directory Server. This will have no effect if the specified control OID is not present in the list of supported controls.

Parameters:
controlOID - The OID of the control to deregister as a supported control.

getSupportedFeatures

public static java.util.Set<java.lang.String> getSupportedFeatures()
Retrieves the set of OIDs for the supported features registered with the Directory Server.

Returns:
The set of OIDs for the supported features registered with the Directory Server.

isSupportedFeature

public static boolean isSupportedFeature(java.lang.String featureOID)
Indicates whether the specified OID is registered with the Directory Server as a supported feature.

Parameters:
featureOID - The OID of the feature for which to make the determination.
Returns:
true if the specified OID is registered with the server as a supported feature, or false if not.

registerSupportedFeature

public static void registerSupportedFeature(java.lang.String featureOID)
Registers the provided OID as a supported feature for the Directory Server. This will have no effect if the specified feature OID is already present in the list of supported features.

Parameters:
featureOID - The OID of the feature to register as a supported feature.

deregisterSupportedFeature

public static void deregisterSupportedFeature(java.lang.String featureOID)
Deregisters the provided OID as a supported feature for the Directory Server. This will have no effect if the specified feature OID is not present in the list of supported features.

Parameters:
featureOID - The OID of the feature to deregister as a supported feature.

getSupportedExtensions

public static java.util.Map<java.lang.String,ExtendedOperationHandler> getSupportedExtensions()
Retrieves the set of extended operations that may be processed by the Directory Server. The mapping will be between the OID and the extended operation handler providing the logic for the extended operation with that OID. The returned map must not be altered by the caller.

Returns:
The set of extended operations that may be processed by the Directory Server.

getExtendedOperationHandler

public static ExtendedOperationHandler getExtendedOperationHandler(java.lang.String oid)
Retrieves the handler for the extended operation for the provided extended operation OID.

Parameters:
oid - The OID of the extended operation to retrieve.
Returns:
The handler for the specified extended operation, or null if there is none.

registerSupportedExtension

public static void registerSupportedExtension(java.lang.String oid,
                                              ExtendedOperationHandler handler)
Registers the provided extended operation handler with the Directory Server.

Parameters:
oid - The OID for the extended operation to register.
handler - The extended operation handler to register with the Directory Server.

deregisterSupportedExtension

public static void deregisterSupportedExtension(java.lang.String oid)
Deregisters the provided extended operation handler with the Directory Server.

Parameters:
oid - The OID for the extended operation to deregister.

getSupportedSASLMechanisms

public static java.util.Map<java.lang.String,SASLMechanismHandler> getSupportedSASLMechanisms()
Retrieves the set of SASL mechanisms that are supported by the Directory Server. The mapping will be between the mechanism name and the SASL mechanism handler that implements support for that mechanism. The returned map must not be altered by the caller.

Returns:
The set of SASL mechanisms that are supported by the Directory Server.

getSASLMechanismHandler

public static SASLMechanismHandler getSASLMechanismHandler(java.lang.String name)
Retrieves the handler for the specified SASL mechanism.

Parameters:
name - The name of the SASL mechanism to retrieve.
Returns:
The handler for the specified SASL mechanism, or null if there is none.

registerSASLMechanismHandler

public static void registerSASLMechanismHandler(java.lang.String name,
                                                SASLMechanismHandler handler)
Registers the provided SASL mechanism handler with the Directory Server.

Parameters:
name - The name of the SASL mechanism to be registered.
handler - The SASL mechanism handler to register with the Directory Server.

deregisterSASLMechanismHandler

public static void deregisterSASLMechanismHandler(java.lang.String name)
Deregisters the provided SASL mechanism handler with the Directory Server.

Parameters:
name - The name of the SASL mechanism to be deregistered.

registerChangeNotificationListener

public static void registerChangeNotificationListener(ChangeNotificationListener changeListener)
Registers the provided change notification listener with the Directory Server so that it will be notified of any add, delete, modify, or modify DN operations that are performed.

Parameters:
changeListener - The change notification listener to register with the Directory Server.

deregisterChangeNotificationListener

public static void deregisterChangeNotificationListener(ChangeNotificationListener changeListener)
Deregisters the provided change notification listener with the Directory Server so that it will no longer be notified of any add, delete, modify, or modify DN operations that are performed.

Parameters:
changeListener - The change notification listener to deregister with the Directory Server.

registerShutdownListener

public 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.

Parameters:
listener - The shutdown listener to register with the Directory Server.

deregisterShutdownListener

public static void deregisterShutdownListener(ServerShutdownListener listener)
Deregisters the provided shutdown listener with the Directory Server.

Parameters:
listener - The shutdown listener to deregister with the Directory Server.

getVersionString

public static java.lang.String getVersionString()
Retrieves the full version string for the Directory Server.

Returns:
The full version string for the Directory Server.