Package org.forgerock.opendj.rest2ldap

Class ReferencePropertyMapper

java.lang.Object
org.forgerock.opendj.rest2ldap.PropertyMapper
org.forgerock.opendj.rest2ldap.ReferencePropertyMapper
public final class ReferencePropertyMapper extends PropertyMapper
An property mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.

  • Method Details

    • searchFilter

      public ReferencePropertyMapper searchFilter(org.forgerock.opendj.ldap.Filter filter)
      Sets the filter which should be used when searching for referenced LDAP entries. The default is (objectClass=*).
      Parameters:
      filter - The filter which should be used when searching for referenced LDAP entries.
      Returns:
      This property mapper.

    • searchFilter

      public ReferencePropertyMapper searchFilter(String filter)
      Sets the filter which should be used when searching for referenced LDAP entries. The default is (objectClass=*).
      Parameters:
      filter - The filter which should be used when searching for referenced LDAP entries.
      Returns:
      This property mapper.

    • searchScope

      public ReferencePropertyMapper searchScope(org.forgerock.opendj.ldap.SearchScope scope)
      Sets the search scope which should be used when searching for referenced LDAP entries. The default is SearchScope.WHOLE_SUBTREE.
      Parameters:
      scope - The search scope which should be used when searching for referenced LDAP entries.
      Returns:
      This property mapper.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isRequired

      public final ReferencePropertyMapper 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 ReferencePropertyMapper 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 ReferencePropertyMapper 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)