Package 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
    Description
    default ByteString
    fromJson(Schema schema, Object value)
    Decodes the JSON representation of an attribute value with this syntax.
    default String
    getApproximateMatchingRule()
    Retrieves the default approximate matching rule that will be used for attributes with this syntax.
    default 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.
    default String
    getOrderingMatchingRule()
    Retrieves the default ordering matching rule that will be used for attributes with this syntax.
    default String
    getSubstringMatchingRule()
    Retrieves the default substring matching rule that will be used for attributes with this syntax.
    default 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.
    default boolean
    isHumanReadable()
    Indicates whether this attribute syntax would likely be a human readable string.
    default Object
    toJson(Schema schema, ByteString value)
    Encodes the JSON representation of an attribute value with this syntax.
    default Map<String,Object>
    toJsonSchema(Schema schema)
    Returns the JSON schema describing this syntax.
    boolean
    valueIsAcceptable(Schema schema, ByteString value, LocalizableMessageBuilder invalidReason)
    Indicates whether the provided value is acceptable for use in an attribute with this syntax.

  • Method Details

    • getApproximateMatchingRule

      default 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

      default 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

      default 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

      default 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

      default 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:

    • isHumanReadable

      default 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, ByteString 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:
      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.

    • toJson

      default Object toJson(Schema schema, ByteString value)
      Encodes the JSON representation of an attribute value with this syntax. The default implementation is to encode the value as a UTF-8 string if the syntax is human readable, or base 64 encode the value otherwise.
      Parameters:
      schema - The schema in which this syntax is defined.
      value - The attribute value to be encoded.
      Returns:
      The encoded JSON representation.
      Throws:
      LocalizedIllegalArgumentException - If the provided attribute value does not conform to this syntax.

    • fromJson

      default ByteString fromJson(Schema schema, Object value)
      Decodes the JSON representation of an attribute value with this syntax. The default implementation is to decode the value as a UTF-8 string if the syntax is human readable, or base 64 decode the value otherwise.
      Parameters:
      schema - The schema in which this syntax is defined.
      value - The JSON representation to be decoded.
      Returns:
      The decoded attribute value.
      Throws:
      LocalizedIllegalArgumentException - If the provided JSON value does not conform to this syntax.

    • toJsonSchema

      default Map<String,Object> toJsonSchema(Schema schema)
      Returns the JSON schema describing this syntax.
      Parameters:
      schema - The schema in which this syntax is defined.
      Returns:
      The JSON schema.