public final class JsonPropertyMapper extends PropertyMapper
Modifier and Type | Method and Description |
---|---|
JsonPropertyMapper |
defaultJsonValue(Object defaultValue)
Sets the default JSON value which should be substituted when the LDAP attribute is not found in the LDAP entry.
|
JsonPropertyMapper |
defaultJsonValues(Collection<?> defaultValues)
Sets the default JSON values which should be substituted when the LDAP attribute is not found in the LDAP entry.
|
JsonPropertyMapper |
extensibleJsonOrderingMatchingRule(String extensibleJsonOrderingMatchingRule)
Sets the JSON ordering matching rule name that should be used for comparing JSON attributes in LDAP.
|
T |
isMultiValued(boolean isMultiValued)
Indicates that the LDAP attribute is multi-valued and should be represented in JSON using an array of values.
|
T |
isRequired(boolean isRequired)
Indicates that the LDAP attribute is mandatory and must be provided during create requests.
|
JsonPropertyMapper |
jsonQueryEqualityMatchingRule(String jsonQueryEqualityMatchingRule)
Sets the JSON query matching rule name that should be used for matching JSON attributes in LDAP.
|
JsonPropertyMapper |
jsonSchema(JsonValue jsonSchema)
Sets the JSON schema corresponding to this simple property mapper.
|
static void |
putWritabilityProperties(WritabilityPolicy writabilityPolicy,
JsonValue jsonSchema) |
String |
toString() |
JsonPropertyMapper |
useServerSideSort(boolean useServerSideSort)
Specifies whether a sort directive involving this property mapper should be forwarded to the LDAP server or if it
should be performed locally by this Rest2Ldap server.
|
T |
writability(WritabilityPolicy policy)
Indicates whether the LDAP attribute supports updates.
|
public JsonPropertyMapper jsonQueryEqualityMatchingRule(String jsonQueryEqualityMatchingRule)
JsonSchema.newJsonQueryEqualityMatchingRuleImpl(String, Options)
.
By default JSON attributes will be matched using the JsonSchema.getCaseIgnoreJsonQueryMatchingRule()
.
jsonQueryEqualityMatchingRule
- The name or OID of the JSON query matching rule.public JsonPropertyMapper extensibleJsonOrderingMatchingRule(String extensibleJsonOrderingMatchingRule)
JsonSchema.newJsonQueryEqualityMatchingRuleImpl(String, Options)
.
By default JSON attributes will be matched using the JsonSchema.getCaseIgnoreJsonQueryMatchingRule()
.
extensibleJsonOrderingMatchingRule
- The name or OID of the extensible JSON ordering matching rule.public JsonPropertyMapper useServerSideSort(boolean useServerSideSort)
You want to set this setting to false
if the LDAP server does not support the extensible matching rule
concept.
useServerSideSort
- true
if the sort directive should be forwarded to the LDAP server, false
if the sort
operation must be performed locally.extensibleJsonOrderingMatchingRule
public JsonPropertyMapper defaultJsonValue(Object defaultValue)
defaultValue
- The default JSON value.public JsonPropertyMapper defaultJsonValues(Collection<?> defaultValues)
defaultValues
- The default JSON values.public JsonPropertyMapper jsonSchema(JsonValue jsonSchema)
null
,
it will be returned by toJsonSchema()
, otherwise a default JSON schema will be
automatically generated with the information available in this property mapper.jsonSchema
- the JSON schema corresponding to this simple property mapper. Can be null
public final T isRequired(boolean isRequired)
isRequired
- true
if this property is required.public final T isMultiValued(boolean isMultiValued)
isMultiValued
- true
if this property is multi-valued.public final T writability(WritabilityPolicy policy)
WritabilityPolicy.READ_WRITE
.policy
- The writability policy.public static void putWritabilityProperties(WritabilityPolicy writabilityPolicy, JsonValue jsonSchema)
Copyright 2010-2018 ForgeRock AS.