public static final class Rest2LDAP.Builder extends Object
Modifier and Type | Method and Description |
---|---|
Rest2LDAP.Builder |
additionalLDAPAttribute(org.forgerock.opendj.ldap.Attribute attribute)
Specifies an additional LDAP attribute which should be included with
new LDAP entries when they are created.
|
Rest2LDAP.Builder |
additionalLDAPAttribute(String attribute,
Object... values)
Specifies an additional LDAP attribute which should be included with
new LDAP entries when they are created.
|
Rest2LDAP.Builder |
authorizationPolicy(AuthorizationPolicy policy)
Sets the policy which should be for performing authorization.
|
Rest2LDAP.Builder |
baseDN(org.forgerock.opendj.ldap.DN dn)
Sets the base DN beneath which LDAP entries (resources) are to be
found.
|
Rest2LDAP.Builder |
baseDN(String dn)
Sets the base DN beneath which LDAP entries (resources) are to be
found.
|
org.forgerock.json.resource.CollectionResourceProvider |
build()
Creates a new LDAP resource collection configured using this builder.
|
Rest2LDAP.Builder |
configureMapping(org.forgerock.json.fluent.JsonValue configuration)
Configures the JSON to LDAP mapping using the provided JSON
configuration.
|
Rest2LDAP.Builder |
ldapConnectionFactory(org.forgerock.opendj.ldap.ConnectionFactory factory)
Sets the LDAP connection factory to be used for accessing the LDAP
directory.
|
Rest2LDAP.Builder |
mapper(AttributeMapper mapper)
Sets the attribute mapper which should be used for mapping JSON
resources to and from LDAP entries.
|
Rest2LDAP.Builder |
proxyAuthzIdTemplate(String template)
Sets the authorization ID template which will be used for proxied
authorization.
|
Rest2LDAP.Builder |
readOnUpdatePolicy(ReadOnUpdatePolicy policy)
Sets the policy which should be used in order to read an entry before
it is deleted, or after it is added or modified.
|
Rest2LDAP.Builder |
schema(org.forgerock.opendj.ldap.schema.Schema schema)
Sets the schema which should be used when attribute types and
controls.
|
Rest2LDAP.Builder |
useClientDNNaming(org.forgerock.opendj.ldap.schema.AttributeType attribute)
Indicates that the JSON resource ID must be provided by the user, and
will be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useClientDNNaming(String attribute)
Indicates that the JSON resource ID must be provided by the user, and
will be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useClientNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute,
org.forgerock.opendj.ldap.AttributeDescription idAttribute)
Indicates that the JSON resource ID must be provided by the user, but
will not be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useClientNaming(String dnAttribute,
String idAttribute)
Indicates that the JSON resource ID must be provided by the user, but
will not be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useEtagAttribute()
Indicates that the "etag" LDAP attribute should be used for resource
versioning.
|
Rest2LDAP.Builder |
useEtagAttribute(org.forgerock.opendj.ldap.AttributeDescription attribute)
Indicates that the provided LDAP attribute should be used for
resource versioning.
|
Rest2LDAP.Builder |
useEtagAttribute(String attribute)
Indicates that the provided LDAP attribute should be used for
resource versioning.
|
Rest2LDAP.Builder |
usePermissiveModify()
Indicates that all LDAP modify operations should be performed using
the LDAP permissive modify control.
|
Rest2LDAP.Builder |
useServerEntryUUIDNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute)
Indicates that the JSON resource ID will be derived from the server
provided "entryUUID" LDAP attribute.
|
Rest2LDAP.Builder |
useServerEntryUUIDNaming(String dnAttribute)
Indicates that the JSON resource ID will be derived from the server
provided "entryUUID" LDAP attribute.
|
Rest2LDAP.Builder |
useServerNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute,
org.forgerock.opendj.ldap.AttributeDescription idAttribute)
Indicates that the JSON resource ID must not be provided by the user,
and will not be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useServerNaming(String dnAttribute,
String idAttribute)
Indicates that the JSON resource ID must not be provided by the user,
and will not be used for naming the associated LDAP entry.
|
Rest2LDAP.Builder |
useSubtreeDelete()
Indicates that all LDAP delete operations should be performed using
the LDAP subtree delete control.
|
public Rest2LDAP.Builder additionalLDAPAttribute(org.forgerock.opendj.ldap.Attribute attribute)
attribute
- The additional LDAP attribute to be included with new LDAP
entries.public Rest2LDAP.Builder additionalLDAPAttribute(String attribute, Object... values)
attribute
- The name of the additional LDAP attribute to be included
with new LDAP entries.values
- The value(s) of the additional LDAP attribute.public Rest2LDAP.Builder authorizationPolicy(AuthorizationPolicy policy)
policy
- The policy which should be for performing authorization.public Rest2LDAP.Builder baseDN(org.forgerock.opendj.ldap.DN dn)
dn
- The base DN.public Rest2LDAP.Builder baseDN(String dn)
dn
- The base DN.public org.forgerock.json.resource.CollectionResourceProvider build()
public Rest2LDAP.Builder configureMapping(org.forgerock.json.fluent.JsonValue configuration)
configuration
- The JSON configuration.IllegalArgumentException
- If the configuration is invalid.public Rest2LDAP.Builder ldapConnectionFactory(org.forgerock.opendj.ldap.ConnectionFactory factory)
factory
- The LDAP connection factory to be used for accessing the
LDAP directory.public Rest2LDAP.Builder mapper(AttributeMapper mapper)
mapper
- The attribute mapper.public Rest2LDAP.Builder proxyAuthzIdTemplate(String template)
template
- The authorization ID template which will be used for
proxied authorization.public Rest2LDAP.Builder readOnUpdatePolicy(ReadOnUpdatePolicy policy)
controls
.policy
- The policy which should be used in order to read an entry
before it is deleted, or after it is added or modified.public Rest2LDAP.Builder schema(org.forgerock.opendj.ldap.schema.Schema schema)
schema
- The schema which should be used when attribute types and
controls.public Rest2LDAP.Builder useClientDNNaming(org.forgerock.opendj.ldap.schema.AttributeType attribute)
base DN
composed of the specified attribute
type and LDAP value taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
attribute
- The LDAP attribute which will be used for naming.public Rest2LDAP.Builder useClientDNNaming(String attribute)
base DN
composed of the specified attribute
type and LDAP value taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
attribute
- The LDAP attribute which will be used for naming.public Rest2LDAP.Builder useClientNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute, org.forgerock.opendj.ldap.AttributeDescription idAttribute)
idAttribute
in the
LDAP entry, and the LDAP entry name will be derived by appending a
single RDN to the base DN
composed of the
dnAttribute
taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public Rest2LDAP.Builder useClientNaming(String dnAttribute, String idAttribute)
idAttribute
in the
LDAP entry, and the LDAP entry name will be derived by appending a
single RDN to the base DN
composed of the
dnAttribute
taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the user provides the resource name when creating new resources, which means it must be included in the resource content when not specified explicitly in the create request.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public Rest2LDAP.Builder useEtagAttribute()
public Rest2LDAP.Builder useEtagAttribute(org.forgerock.opendj.ldap.AttributeDescription attribute)
attribute
- The name of the attribute to use for versioning, or
null
if resource versioning will not supported.public Rest2LDAP.Builder useEtagAttribute(String attribute)
attribute
- The name of the attribute to use for versioning, or
null
if resource versioning will not supported.public Rest2LDAP.Builder usePermissiveModify()
public Rest2LDAP.Builder useServerEntryUUIDNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute)
base
DN
composed of the dnAttribute
taken from the LDAP entry
once attribute mapping has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.public Rest2LDAP.Builder useServerEntryUUIDNaming(String dnAttribute)
base
DN
composed of the dnAttribute
taken from the LDAP entry
once attribute mapping has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.public Rest2LDAP.Builder useServerNaming(org.forgerock.opendj.ldap.schema.AttributeType dnAttribute, org.forgerock.opendj.ldap.AttributeDescription idAttribute)
idAttribute
in
the LDAP entry, and the LDAP entry name will be derived by appending
a single RDN to the base DN
composed of the
dnAttribute
taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public Rest2LDAP.Builder useServerNaming(String dnAttribute, String idAttribute)
idAttribute
in
the LDAP entry, and the LDAP entry name will be derived by appending
a single RDN to the base DN
composed of the
dnAttribute
taken from the LDAP entry once attribute mapping
has been performed.
Note that this naming policy requires that the server provides the resource name when creating new resources, which means it must not be specified in the create request, nor included in the resource content.
dnAttribute
- The attribute which will be used for naming LDAP entries.idAttribute
- The attribute which will be used for JSON resource IDs.public Rest2LDAP.Builder useSubtreeDelete()
Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.