@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 |
deregisterInvokableComponent(InvokableComponent component)
Deregisters the provided invokable component 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(DN entryDN)
Indicates whether the specified entry exists in the Directory
Server.
|
static org.forgerock.opendj.ldap.schema.MatchingRule |
getApproximateMatchingRule(String lowerName)
Retrieves the approximate matching rule with the specified name
or OID.
|
static Map<String,org.forgerock.opendj.ldap.schema.Syntax> |
getAttributeSyntaxes()
Retrieves the set of attribute syntaxes defined in the Directory
Server.
|
static Map<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 org.forgerock.opendj.ldap.schema.Syntax |
getDefaultAttributeSyntax()
Retrieves the default attribute syntax that should be used for
attributes that are not defined in the server schema.
|
static org.forgerock.opendj.ldap.schema.Syntax |
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 org.forgerock.opendj.ldap.schema.Syntax |
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 org.forgerock.opendj.ldap.schema.Syntax |
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 org.forgerock.opendj.ldap.schema.Syntax |
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 org.forgerock.opendj.ldap.schema.Syntax |
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 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 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 org.forgerock.opendj.ldap.schema.MatchingRule |
getEqualityMatchingRule(String lowerName)
Retrieves the equality matching rule with the specified name or
OID.
|
static ExtendedOperationHandler |
getExtendedOperationHandler(String oid)
Retrieves the handler for the extended operation for the provided
extended operation OID.
|
static org.forgerock.opendj.ldap.schema.MatchingRule |
getMatchingRule(String lowerName)
Retrieves the matching rule with the specified name or OID.
|
static Map<String,org.forgerock.opendj.ldap.schema.MatchingRule> |
getMatchingRules()
Retrieves the set of matching rules registered with the Directory
Server.
|
static MatchingRuleUse |
getMatchingRuleUse(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule)
Retrieves the matching rule use associated with the provided
matching rule.
|
static Map<org.forgerock.opendj.ldap.schema.MatchingRule,MatchingRuleUse> |
getMatchingRuleUses()
Retrieves the set of matching rule uses defined in the Directory
Server.
|
static List<NameForm> |
getNameForm(ObjectClass objectClass)
Retrieves the list of name forms associated with the specified
structural objectclass.
|
static NameForm |
getNameForm(String lowerName)
Retrieves the name form associated with the specified name or
OID.
|
static Map<ObjectClass,List<NameForm>> |
getNameForms()
Retrieves the set of name forms defined in the Directory Server.
|
static ObjectClass |
getObjectClass(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 Map<String,ObjectClass> |
getObjectClasses()
Retrieves the set of objectclasses registered with the Directory
Server.
|
static com.forgerock.opendj.util.OperatingSystem |
getOperatingSystem()
Retrieves the operating system on which the Directory Server is
running.
|
static org.forgerock.opendj.ldap.schema.MatchingRule |
getOrderingMatchingRule(String lowerName)
Retrieves the ordering matching rule with the specified name or
OID.
|
static SASLMechanismHandler |
getSASLMechanismHandler(String name)
Retrieves the handler for the specified SASL mechanism.
|
static Schema |
getSchema()
Retrieves a reference to the Directory Server schema.
|
static org.forgerock.opendj.ldap.ResultCode |
getServerErrorResultCode()
Retrieves the result code that should be used when the Directory
Server encounters an internal server error.
|
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 org.forgerock.opendj.ldap.schema.MatchingRule |
getSubstringMatchingRule(String lowerName)
Retrieves the substring matching rule with the specified name or
OID.
|
static Set<String> |
getSupportedControls()
Retrieves the set of OIDs for the supported controls registered
with the Directory Server.
|
static Map<String,ExtendedOperationHandler> |
getSupportedExtensions()
Retrieves the set of extended operations that may be processed by
the Directory Server.
|
static Set<String> |
getSupportedFeatures()
Retrieves the set of OIDs for the supported features registered
with the Directory Server.
|
static Map<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 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 |
registerInvokableComponent(InvokableComponent component)
Registers the provided invokable component 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 CryptoManager getCryptoManager()
public static com.forgerock.opendj.util.OperatingSystem getOperatingSystem()
public static ConfigHandler getConfigHandler()
public static ConfigEntry getConfigEntry(DN entryDN) throws ConfigException
entryDN
- The DN of the configuration entry to retrieve.ConfigException
- If a problem occurs while trying to
retrieve the requested entry.public static String getServerRoot()
public static long getStartTime()
public static String getStartTimeUTC()
public static Schema getSchema()
public static Map<String,org.forgerock.opendj.ldap.schema.MatchingRule> getMatchingRules()
public static org.forgerock.opendj.ldap.schema.MatchingRule getMatchingRule(String lowerName)
lowerName
- The lowercase name or OID for the matching
rule to retrieve.null
if no
such matching rule has been defined in the server.public static org.forgerock.opendj.ldap.schema.MatchingRule getApproximateMatchingRule(String lowerName)
lowerName
- The lowercase name or OID for the approximate
matching rule to retrieve.null
if no such matching rule has been
defined in the server.public static org.forgerock.opendj.ldap.schema.MatchingRule getEqualityMatchingRule(String lowerName)
lowerName
- The lowercase name or OID for the equality
matching rule to retrieve.null
if no such matching rule has been
defined in the server.public static org.forgerock.opendj.ldap.schema.MatchingRule getOrderingMatchingRule(String lowerName)
lowerName
- The lowercase name or OID for the ordering
matching rule to retrieve.null
if no such matching rule has been
defined in the server.public static org.forgerock.opendj.ldap.schema.MatchingRule getSubstringMatchingRule(String lowerName)
lowerName
- The lowercase name or OID for the substring
matching rule to retrieve.null
if no such matching rule has been
defined in the server.public static Map<String,ObjectClass> getObjectClasses()
public static ObjectClass getObjectClass(String lowerName, boolean returnDefault)
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.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.public static ObjectClass getTopObjectClass()
public static Map<String,AttributeType> getAttributeTypes()
public static AttributeType getObjectClassAttributeType()
public static Map<String,org.forgerock.opendj.ldap.schema.Syntax> getAttributeSyntaxes()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultAttributeSyntax()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultBinarySyntax()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultBooleanSyntax()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultDNSyntax()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultIntegerSyntax()
public static org.forgerock.opendj.ldap.schema.Syntax getDefaultStringSyntax()
public static Map<org.forgerock.opendj.ldap.schema.MatchingRule,MatchingRuleUse> getMatchingRuleUses()
public static MatchingRuleUse getMatchingRuleUse(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule)
matchingRule
- The matching rule for which to retrieve the
matching rule use.null
if none is defined.public static Map<ObjectClass,DITContentRule> getDITContentRules()
public static DITContentRule getDITContentRule(ObjectClass objectClass)
objectClass
- The objectclass for which to retrieve the
associated DIT content rule.null
if
no such rule is defined in the schema.public static Map<NameForm,DITStructureRule> getDITStructureRules()
public static DITStructureRule getDITStructureRule(int ruleID)
ruleID
- The rule ID for which to retrieve the associated
DIT structure rule.null
if no such rule is defined.public static DITStructureRule getDITStructureRule(NameForm nameForm)
nameForm
- The name form for which to retrieve the
associated DIT structure rule.null
if no such rule is defined.public static Map<ObjectClass,List<NameForm>> getNameForms()
public static List<NameForm> getNameForm(ObjectClass objectClass)
objectClass
- The structural objectclass for which to
retrieve the associated name form.null
if no such name form is defined in the schema.public static NameForm getNameForm(String lowerName)
lowerName
- The name or OID of the name form to retrieve,
formatted in all lowercase characters.null
if no such
name form is defined in the schema.public static void registerInvokableComponent(InvokableComponent component)
component
- The invokable component to register.public static void deregisterInvokableComponent(InvokableComponent component)
component
- The invokable component to deregister.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 org.forgerock.opendj.ldap.ResultCode getServerErrorResultCode()
public static Entry getEntry(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(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 Map<String,ExtendedOperationHandler> getSupportedExtensions()
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 Map<String,SASLMechanismHandler> getSupportedSASLMechanisms()
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-2015 ForgeRock AS. All Rights Reserved.