public class AttributeTypeSyntax extends AttributeSyntax<AttributeTypeDescriptionAttributeSyntaxCfg> implements ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg>
Constructor and Description |
---|
AttributeTypeSyntax()
Creates a new instance of this syntax.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(AttributeTypeDescriptionAttributeSyntaxCfg configuration)
Applies the configuration changes to this change listener.
|
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(AttributeTypeDescriptionAttributeSyntaxCfg configuration,
ServerContext serverContext)
Initializes this attribute syntax based on the information in the provided configuration entry.
|
boolean |
isConfigurationChangeAcceptable(AttributeTypeDescriptionAttributeSyntaxCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
static boolean |
isStripSyntaxMinimumUpperBound()
Boolean that indicates that the minimum upper bound value should be
stripped from the Attribute Type Syntax Description.
|
equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, valueIsAcceptable
public AttributeTypeSyntax()
initializeSyntax
method.public void initializeSyntax(AttributeTypeDescriptionAttributeSyntaxCfg configuration, ServerContext serverContext) throws ConfigException, InitializationException, DirectoryException
AttributeSyntax
initializeSyntax
in class AttributeSyntax<AttributeTypeDescriptionAttributeSyntaxCfg>
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.InitializationException
- If a problem occurs during initialization that is not related to the server
configuration.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<AttributeTypeDescriptionAttributeSyntaxCfg>
schema
- Schema to use to retrieve the syntaxpublic String getName()
AttributeSyntax
getName
in class AttributeSyntax<AttributeTypeDescriptionAttributeSyntaxCfg>
public String getOID()
AttributeSyntax
getOID
in class AttributeSyntax<AttributeTypeDescriptionAttributeSyntaxCfg>
public String getDescription()
AttributeSyntax
getDescription
in class AttributeSyntax<AttributeTypeDescriptionAttributeSyntaxCfg>
public ConfigChangeResult applyConfigurationChange(AttributeTypeDescriptionAttributeSyntaxCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg>
configuration
- The new configuration containing the changes.public boolean isConfigurationChangeAcceptable(AttributeTypeDescriptionAttributeSyntaxCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg>
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 static boolean isStripSyntaxMinimumUpperBound()
Copyright 2010-2017 ForgeRock AS.