public class DirectoryStringSyntax extends AttributeSyntax<DirectoryStringAttributeSyntaxCfg> implements ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>
Constructor and Description |
---|
DirectoryStringSyntax()
Creates a new instance of this syntax.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowZeroLengthValues()
Indicates whether zero-length values will be allowed.
|
ConfigChangeResult |
applyConfigurationChange(DirectoryStringAttributeSyntaxCfg configuration)
Applies the configuration changes to this change listener.
|
void |
finalizeSyntax()
Performs any finalization that may be necessary for this
attribute syntax.
|
String |
getDescription()
Retrieves a description for this attribute syntax.
|
String |
getName()
Retrieves the common name for this attribute syntax.
|
String |
getOID()
Retrieves the OID for this attribute syntax.
|
Syntax |
getSDKSyntax(Schema schema)
Returns the SDK Syntax equivalent to this syntax.
|
void |
initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration,
ServerContext serverContext)
Initializes this attribute syntax based on the information in the provided configuration entry.
|
boolean |
isConfigurationChangeAcceptable(DirectoryStringAttributeSyntaxCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
equals, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, valueIsAcceptable
public DirectoryStringSyntax()
initializeSyntax
method.public void initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration, ServerContext serverContext) throws ConfigException, DirectoryException
AttributeSyntax
initializeSyntax
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
configuration
- The configuration to use to initialize this attribute syntax.serverContext
- The server context.ConfigException
- If an unrecoverable problem arises in the process of performing the initialization.DirectoryException
- If an unrecoverable problem arises in the process of performing the initialization.public Syntax getSDKSyntax(Schema schema)
AttributeSyntax
This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.
getSDKSyntax
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
schema
- Schema to use to retrieve the syntaxpublic void finalizeSyntax()
AttributeSyntax
finalizeSyntax
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
public String getName()
AttributeSyntax
getName
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
public String getOID()
AttributeSyntax
getOID
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
public String getDescription()
AttributeSyntax
getDescription
in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
public boolean allowZeroLengthValues()
true
if zero-length values should be allowed for
attributes with a directory string syntax, or false
if not.public boolean isConfigurationChangeAcceptable(DirectoryStringAttributeSyntaxCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(DirectoryStringAttributeSyntaxCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>
configuration
- The new configuration containing the changes.Copyright 2010-2017 ForgeRock AS.