|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.DirectoryConfig
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class DirectoryConfig
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 |
---|
public DirectoryConfig()
Method Detail |
---|
public static CryptoManager getCryptoManager()
public static 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 java.lang.String getServerRoot()
public static long getStartTime()
public static java.lang.String getStartTimeUTC()
public static Schema getSchema()
public static java.util.Map<java.lang.String,MatchingRule> getMatchingRules()
public static MatchingRule getMatchingRule(java.lang.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 ApproximateMatchingRule getApproximateMatchingRule(java.lang.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 EqualityMatchingRule getEqualityMatchingRule(java.lang.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 OrderingMatchingRule getOrderingMatchingRule(java.lang.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 SubstringMatchingRule getSubstringMatchingRule(java.lang.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 java.util.Map<java.lang.String,ObjectClass> getObjectClasses()
public static ObjectClass getObjectClass(java.lang.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 java.util.Map<java.lang.String,AttributeType> getAttributeTypes()
public static AttributeType getAttributeType(java.lang.String lowerName, boolean returnDefault)
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.
null
if
there is no attribute with the specified type defined in
the server schema and a default type should not be
returned.public static AttributeType getObjectClassAttributeType()
public static java.util.Map<java.lang.String,AttributeSyntax> getAttributeSyntaxes()
public static AttributeSyntax getAttributeSyntax(java.lang.String oid, boolean allowDefault)
oid
- The OID of the syntax to retrieve.allowDefault
- Indicates whether to return the default
attribute syntax if the requested syntax is
unknown.
null
otherwise.public static AttributeSyntax getDefaultAttributeSyntax()
public static AttributeSyntax getDefaultBinarySyntax()
public static AttributeSyntax getDefaultBooleanSyntax()
public static AttributeSyntax getDefaultDNSyntax()
public static AttributeSyntax getDefaultIntegerSyntax()
public static AttributeSyntax getDefaultStringSyntax()
public static java.util.Map<MatchingRule,MatchingRuleUse> getMatchingRuleUses()
public static MatchingRuleUse getMatchingRuleUse(MatchingRule matchingRule)
matchingRule
- The matching rule for which to retrieve the
matching rule use.
null
if none is defined.public static java.util.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 java.util.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 java.util.Map<ObjectClass,NameForm> getNameForms()
public static 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(java.lang.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, java.lang.String alertType, Message 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 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 java.util.Set<java.lang.String> getSupportedControls()
public static boolean isSupportedControl(java.lang.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(java.lang.String controlOID)
controlOID
- The OID of the control to register as a
supported control.public static void deregisterSupportedControl(java.lang.String controlOID)
controlOID
- The OID of the control to deregister as a
supported control.public static java.util.Set<java.lang.String> getSupportedFeatures()
public static boolean isSupportedFeature(java.lang.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(java.lang.String featureOID)
featureOID
- The OID of the feature to register as a
supported feature.public static void deregisterSupportedFeature(java.lang.String featureOID)
featureOID
- The OID of the feature to deregister as a
supported feature.public static java.util.Map<java.lang.String,ExtendedOperationHandler> getSupportedExtensions()
public static ExtendedOperationHandler getExtendedOperationHandler(java.lang.String oid)
oid
- The OID of the extended operation to retrieve.
null
if there is none.public static void registerSupportedExtension(java.lang.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(java.lang.String oid)
oid
- The OID for the extended operation to deregister.public static java.util.Map<java.lang.String,SASLMechanismHandler> getSupportedSASLMechanisms()
public static SASLMechanismHandler getSASLMechanismHandler(java.lang.String name)
name
- The name of the SASL mechanism to retrieve.
null
if there is none.public static void registerSASLMechanismHandler(java.lang.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(java.lang.String name)
name
- The name of the SASL mechanism to be deregistered.public static void registerChangeNotificationListener(ChangeNotificationListener changeListener)
changeListener
- The change notification listener to
register with the Directory Server.public static void deregisterChangeNotificationListener(ChangeNotificationListener changeListener)
changeListener
- The change notification listener to
deregister with the Directory Server.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 java.lang.String getVersionString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |