org.forgerock.opendj.ldap.schema

Interface SyntaxImpl

public interface SyntaxImpl

This interface defines the set of methods and structures that must be implemented to define a new attribute syntax.

Method Summary

Modifier and Type	Method and Description
String	getApproximateMatchingRule() Retrieves the default approximate matching rule that will be used for attributes with this syntax.
String	getEqualityMatchingRule() Retrieves the default equality matching rule that will be used for attributes with this syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOrderingMatchingRule() Retrieves the default ordering matching rule that will be used for attributes with this syntax.
String	getSubstringMatchingRule() Retrieves the default substring matching rule that will be used for attributes with this syntax.
boolean	isBerEncodingRequired() Indicates whether this attribute syntax requires that values must be encoded using the Basic Encoding Rules (BER) used by X.500 directories and always include the binary attribute description option.
boolean	isHumanReadable() Indicates whether this attribute syntax would likely be a human readable string.
boolean	valueIsAcceptable(Schema schema, ByteSequence value, org.forgerock.i18n.LocalizableMessageBuilder invalidReason) Indicates whether the provided value is acceptable for use in an attribute with this syntax.

Method Detail

getApproximateMatchingRule

String 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.

getEqualityMatchingRule

String 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.

getName

String getName()

Retrieves the common name for this attribute syntax.

Returns:

The common name for this attribute syntax.

getOrderingMatchingRule

String 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

String 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.

isBerEncodingRequired

boolean isBerEncodingRequired()

Indicates whether this attribute syntax requires that values must be encoded using the Basic Encoding Rules (BER) used by X.500 directories and always include the binary attribute description option.

Returns:

true this attribute syntax requires that values must be BER encoded and always include the binary attribute description option, or false if not.

See Also:

RFC 4522 - Lightweight Directory Access Protocol (LDAP): The Binary Encoding Option

isHumanReadable

boolean isHumanReadable()

Indicates whether this attribute syntax would likely be a human readable string.

Returns:

true if this attribute syntax would likely be a human readable string or false if not.

valueIsAcceptable

boolean valueIsAcceptable(Schema schema,
                          ByteSequence value,
                          org.forgerock.i18n.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:

schema - The schema in which this syntax is defined.

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.