Package org.forgerock.opendj.rest2ldap

Class JsonPropertyMapper

java.lang.Object
org.forgerock.opendj.rest2ldap.PropertyMapper
org.forgerock.opendj.rest2ldap.JsonPropertyMapper
public final class JsonPropertyMapper extends PropertyMapper
A property mapper which provides a mapping from a JSON value to an LDAP attribute having the JSON syntax.

  • Method Details

    • defaultJsonValue

      public JsonPropertyMapper defaultJsonValue(Object defaultValue)
      Sets the default JSON value which should be substituted when the LDAP attribute is not found in the LDAP entry.
      Parameters:
      defaultValue - The default JSON value.
      Returns:
      This property mapper.

    • defaultJsonValues

      public JsonPropertyMapper defaultJsonValues(Collection<?> defaultValues)
      Sets the default JSON values which should be substituted when the LDAP attribute is not found in the LDAP entry.
      Parameters:
      defaultValues - The default JSON values.
      Returns:
      This property mapper.

    • jsonSchema

      public JsonPropertyMapper jsonSchema(org.forgerock.json.JsonValue jsonSchema)
      Sets the JSON schema corresponding to this simple property mapper. If not null, it will be returned by toJsonSchema(), otherwise a default JSON schema will be automatically generated with the information available in this property mapper.
      Parameters:
      jsonSchema - the JSON schema corresponding to this simple property mapper. Can be null
      Returns:
      This property mapper.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isRequired

      public final JsonPropertyMapper isRequired(boolean isRequired)
      Indicates that the LDAP attribute is mandatory and must be provided during create requests.
      Parameters:
      isRequired - true if this property is required.
      Returns:
      This property mapper.

    • isMultiValued

      public final JsonPropertyMapper isMultiValued(boolean isMultiValued)
      Indicates that the LDAP attribute is multi-valued and should be represented in JSON using an array of values.
      Parameters:
      isMultiValued - true if this property is multi-valued.
      Returns:
      This property mapper.

    • writability

      public final JsonPropertyMapper writability(WritabilityPolicy policy)
      Indicates whether the LDAP attribute supports updates. The default is WritabilityPolicy.READ_WRITE.
      Parameters:
      policy - The writability policy.
      Returns:
      This property mapper.

    • putWritabilityProperties

      public static void putWritabilityProperties(WritabilityPolicy writabilityPolicy, org.forgerock.json.JsonValue jsonSchema)