org.opends.server.api

Class AttributeSyntax<T extends AttributeSyntaxCfg>

java.lang.Object

org.opends.server.api.AttributeSyntax<T>

Type Parameters:

T - The type of configuration handled by this attribute syntax.

Direct Known Subclasses:

AciSyntax, AttributeTypeSyntax, AuthPasswordSyntax, BinarySyntax, BitStringSyntax, BooleanSyntax, CertificateExactAssertionSyntax, CertificateListSyntax, CertificatePairSyntax, CertificateSyntax, CountryStringSyntax, DeliveryMethodSyntax, DirectoryStringSyntax, DistinguishedNameSyntax, DITContentRuleSyntax, DITStructureRuleSyntax, EnhancedGuideSyntax, FaxNumberSyntax, FaxSyntax, GeneralizedTimeSyntax, GuideSyntax, IA5StringSyntax, IntegerSyntax, JPEGSyntax, LDAPSyntaxDescriptionSyntax, MatchingRuleSyntax, MatchingRuleUseSyntax, NameAndOptionalUIDSyntax, NameFormSyntax, NumericStringSyntax, ObjectClassSyntax, OctetStringSyntax, OIDSyntax, OtherMailboxSyntax, PostalAddressSyntax, PresentationAddressSyntax, PrintableStringSyntax, ProtocolInformationSyntax, SubstringAssertionSyntax, SubtreeSpecificationSyntax, SupportedAlgorithmSyntax, TelephoneNumberSyntax, TeletexTerminalIdentifierSyntax, TelexNumberSyntax, UserPasswordSyntax, UTCTimeSyntax, UUIDSyntax

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class AttributeSyntax<T extends AttributeSyntaxCfg>
extends Object

This class defines the set of methods and structures that must be implemented by a Directory Server module that implements an attribute syntax.

Constructor Summary

Constructors

Constructor and Description
AttributeSyntax()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Indicates whether the provided object is equal to this attribute syntax.
void	finalizeSyntax() Performs any finalization that may be necessary for this attribute syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getApproximateMatchingRule() Retrieves the default approximate matching rule that will be used for attributes with this syntax.
abstract String	getDescription() Retrieves a description for this attribute syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getEqualityMatchingRule() Retrieves the default equality matching rule that will be used for attributes with this syntax.
abstract String	getName() Retrieves the common name for this attribute syntax.
abstract String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getOrderingMatchingRule() Retrieves the default ordering matching rule that will be used for attributes with this syntax.
abstract org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getSubstringMatchingRule() Retrieves the default substring matching rule that will be used for attributes with this syntax.
int	hashCode() Retrieves the hash code for this attribute syntax.
void	initializeSyntax(T configuration, ServerContext serverContext) Initializes this attribute syntax based on the information in the provided configuration entry.
boolean	isBEREncodingRequired() Indicates whether this attribute syntax requires BER encoding.
boolean	isConfigurationAcceptable(AttributeSyntaxCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this attribute syntax.
boolean	isHumanReadable() Indicates whether this attribute syntax is human readable.
String	toString() Retrieves a string representation of this attribute syntax in the format defined in RFC 2252.
void	toString(StringBuilder buffer) Appends a string representation of this attribute syntax in the format defined in RFC 2252 to the provided buffer.
boolean	valueIsAcceptable(org.forgerock.opendj.ldap.ByteSequence value, LocalizableMessageBuilder invalidReason) Indicates whether the provided value is acceptable for use in an attribute with this syntax.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeSyntax

public AttributeSyntax()

Method Detail

initializeSyntax

public void initializeSyntax(T configuration,
                    ServerContext serverContext)
                      throws org.forgerock.opendj.config.server.ConfigException,
                             InitializationException

Initializes this attribute syntax based on the information in the provided configuration entry.

Parameters:

configuration - The configuration to use to initialize this attribute syntax.

serverContext - The server context.

Throws:

org.forgerock.opendj.config.server.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.

getSDKSyntax

public abstract org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

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.

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(AttributeSyntaxCfg configuration,
                                List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this attribute syntax. It should be possible to call this method on an uninitialized attribute syntax instance in order to determine whether the syntax would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Parameters:

configuration - The attribute syntax configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this attribute syntax, or false if not.

finalizeSyntax

public void finalizeSyntax()

Performs any finalization that may be necessary for this attribute syntax. By default, no finalization is performed.

getName

public abstract String getName()

Retrieves the common name for this attribute syntax.

Returns:

The common name for this attribute syntax.

getOID

public abstract String getOID()

Retrieves the OID for this attribute syntax.

Returns:

The OID for this attribute syntax.

getDescription

public abstract String getDescription()

Retrieves a description for this attribute syntax.

Returns:

A description for this attribute syntax.

getEqualityMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getEqualityMatchingRule()

Retrieves the default equality matching rule that will be used for attributes with this syntax.

Returns:

The default equality matching rule that will be used for attributes with this syntax, or null if equality matches will not be allowed for this type by default.

getOrderingMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getOrderingMatchingRule()

Retrieves the default ordering matching rule that will be used for attributes with this syntax.

Returns:

The default ordering matching rule that will be used for attributes with this syntax, or null if ordering matches will not be allowed for this type by default.

getSubstringMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getSubstringMatchingRule()

Retrieves the default substring matching rule that will be used for attributes with this syntax.

Returns:

The default substring matching rule that will be used for attributes with this syntax, or null if substring matches will not be allowed for this type by default.

getApproximateMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getApproximateMatchingRule()

Retrieves the default approximate matching rule that will be used for attributes with this syntax.

Returns:

The default approximate matching rule that will be used for attributes with this syntax, or null if approximate matches will not be allowed for this type by default.

valueIsAcceptable

public boolean valueIsAcceptable(org.forgerock.opendj.ldap.ByteSequence value,
                        LocalizableMessageBuilder invalidReason)

Indicates whether the provided value is acceptable for use in an attribute with this syntax. If it is not, then the reason may be appended to the provided buffer.

Parameters:

value - The value for which to make the determination.

invalidReason - The buffer to which the invalid reason should be appended.

Returns:

true if the provided value is acceptable for use with this syntax, or false if not.

isBEREncodingRequired

public boolean isBEREncodingRequired()

Indicates whether this attribute syntax requires BER encoding.

Returns:

true if this syntax required BER encoding.

isHumanReadable

public boolean isHumanReadable()

Indicates whether this attribute syntax is human readable.

Returns:

true if this syntax is human readable.

hashCode

public final int hashCode()

Retrieves the hash code for this attribute syntax. It will be calculated as the sum of the characters in the OID.

Overrides:

hashCode in class Object

Returns:

The hash code for this attribute syntax.

equals

public final boolean equals(Object o)

Indicates whether the provided object is equal to this attribute syntax. The provided object will be considered equal to this attribute syntax only if it is an attribute syntax with the same OID.

Overrides:

equals in class Object

Parameters:

o - The object for which to make the determination.

Returns:

true if the provided object is equal to this attribute syntax, or false if it is not.

toString

public String toString()

Retrieves a string representation of this attribute syntax in the format defined in RFC 2252.

Overrides:

toString in class Object

Returns:

A string representation of this attribute syntax in the format defined in RFC 2252.

toString

public final void toString(StringBuilder buffer)

Appends a string representation of this attribute syntax in the format defined in RFC 2252 to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.