OpenDJ Commons REST Adapter 3.0.0-SNAPSHOT Documentation
A B C D E I L M O P R S T U V W 

A

additionalLDAPAttribute(Attribute) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Specifies an additional LDAP attribute which should be included with new LDAP entries when they are created.
additionalLDAPAttribute(String, Object...) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Specifies an additional LDAP attribute which should be included with new LDAP entries when they are created.
asResourceException(Throwable) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Adapts a Throwable to a ResourceException.
attribute(String, AttributeMapper) - Method in class org.forgerock.opendj.rest2ldap.ObjectAttributeMapper
Creates a mapping for an attribute contained in the JSON object.
AttributeMapper - Class in org.forgerock.opendj.rest2ldap
An attribute mapper is responsible for converting JSON values to and from LDAP attributes.
AuthenticatedConnectionContext - Class in org.forgerock.opendj.rest2ldap
A Context containing a cached pre-authenticated LDAP connection which should be re-used for performing subsequent LDAP operations.
AuthenticatedConnectionContext(Context, Connection) - Constructor for class org.forgerock.opendj.rest2ldap.AuthenticatedConnectionContext
Creates a new pre-authenticated cached LDAP connection context having the provided parent and an ID automatically generated using UUID.randomUUID().
AuthenticatedConnectionContext(String, Context, Connection) - Constructor for class org.forgerock.opendj.rest2ldap.AuthenticatedConnectionContext
Creates a new pre-authenticated cached LDAP connection context having the provided ID and parent.
AuthorizationPolicy - Enum in org.forgerock.opendj.rest2ldap
The policy which should be for performing authorization.
authorizationPolicy(AuthorizationPolicy) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the policy which should be for performing authorization.

B

baseDN(DN) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the base DN beneath which LDAP entries (resources) are to be found.
baseDN(String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the base DN beneath which LDAP entries (resources) are to be found.
build() - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Creates a new LDAP resource collection configured using this builder.
builder() - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns a builder for incrementally constructing LDAP resource collections.

C

configureConnectionFactory(JsonValue, String, ClassLoader) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Creates a new connection factory using the named configuration in the provided JSON list of factory configurations.
configureConnectionFactory(JsonValue, String) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Creates a new connection factory using the named configuration in the provided JSON list of factory configurations.
configureMapping(JsonValue) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Configures the JSON to LDAP mapping using the provided JSON configuration.
constant(Object) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which maps a single JSON attribute to a JSON constant.

D

decoder(Function<ByteString, ?, NeverThrowsException>) - Method in class org.forgerock.opendj.rest2ldap.SimpleAttributeMapper
Sets the decoder which will be used for converting LDAP attribute values to JSON values.
defaultJSONValue(Object) - Method in class org.forgerock.opendj.rest2ldap.SimpleAttributeMapper
Sets the default JSON value which should be substituted when the LDAP attribute is not found in the LDAP entry.

E

encoder(Function<Object, ByteString, NeverThrowsException>) - Method in class org.forgerock.opendj.rest2ldap.SimpleAttributeMapper
Sets the encoder which will be used for converting JSON values to LDAP attribute values.

I

isBinary() - Method in class org.forgerock.opendj.rest2ldap.SimpleAttributeMapper
Indicates that JSON values are base 64 encodings of binary data.

L

ldapConnectionFactory(ConnectionFactory) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the LDAP connection factory to be used for accessing the LDAP directory.

M

mapper(AttributeMapper) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the attribute mapper which should be used for mapping JSON resources to and from LDAP entries.

O

object() - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which maps JSON objects to LDAP attributes.
ObjectAttributeMapper - Class in org.forgerock.opendj.rest2ldap
An attribute mapper which maps JSON objects to LDAP attributes.
org.forgerock.opendj.rest2ldap - package org.forgerock.opendj.rest2ldap
APIs for implementing REST to LDAP gateways.

P

proxyAuthzIdTemplate(String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the authorization ID template which will be used for proxied authorization.

R

ReadOnUpdatePolicy - Enum in org.forgerock.opendj.rest2ldap
The policy which should be used in order to read an entry before it is deleted, or after it is added or modified.
readOnUpdatePolicy(ReadOnUpdatePolicy) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the policy which should be used in order to read an entry before it is deleted, or after it is added or modified.
reference(AttributeDescription, DN, AttributeDescription, AttributeMapper) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
reference(String, String, String, AttributeMapper) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
ReferenceAttributeMapper - Class in org.forgerock.opendj.rest2ldap
An attribute mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
Rest2LDAP - Class in org.forgerock.opendj.rest2ldap
Provides core factory methods and builders for constructing LDAP resource collections.
Rest2LDAP.Builder - Class in org.forgerock.opendj.rest2ldap
A builder for incrementally constructing LDAP resource collections.

S

saveToJson(JsonValue, PersistenceConfig) - Method in class org.forgerock.opendj.rest2ldap.AuthenticatedConnectionContext
schema(Schema) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Sets the schema which should be used when attribute types and controls.
searchFilter(Filter) - Method in class org.forgerock.opendj.rest2ldap.ReferenceAttributeMapper
Sets the filter which should be used when searching for referenced LDAP entries.
searchFilter(String) - Method in class org.forgerock.opendj.rest2ldap.ReferenceAttributeMapper
Sets the filter which should be used when searching for referenced LDAP entries.
searchScope(SearchScope) - Method in class org.forgerock.opendj.rest2ldap.ReferenceAttributeMapper
Sets the search scope which should be used when searching for referenced LDAP entries.
simple(AttributeDescription) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which provides a simple mapping from a JSON value to a single LDAP attribute.
simple(String) - Static method in class org.forgerock.opendj.rest2ldap.Rest2LDAP
Returns an attribute mapper which provides a simple mapping from a JSON value to a single LDAP attribute.
SimpleAttributeMapper - Class in org.forgerock.opendj.rest2ldap
An attribute mapper which provides a simple mapping from a JSON value to a single LDAP attribute.

T

toString() - Method in class org.forgerock.opendj.rest2ldap.ObjectAttributeMapper
 
toString() - Method in class org.forgerock.opendj.rest2ldap.ReferenceAttributeMapper
 
toString() - Method in class org.forgerock.opendj.rest2ldap.SimpleAttributeMapper
 

U

useClientDNNaming(AttributeType) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must be provided by the user, and will be used for naming the associated LDAP entry.
useClientDNNaming(String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must be provided by the user, and will be used for naming the associated LDAP entry.
useClientNaming(AttributeType, AttributeDescription) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must be provided by the user, but will not be used for naming the associated LDAP entry.
useClientNaming(String, String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must be provided by the user, but will not be used for naming the associated LDAP entry.
useEtagAttribute() - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the "etag" LDAP attribute should be used for resource versioning.
useEtagAttribute(AttributeDescription) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the provided LDAP attribute should be used for resource versioning.
useEtagAttribute(String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the provided LDAP attribute should be used for resource versioning.
usePermissiveModify() - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that all LDAP modify operations should be performed using the LDAP permissive modify control.
useServerEntryUUIDNaming(AttributeType) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID will be derived from the server provided "entryUUID" LDAP attribute.
useServerEntryUUIDNaming(String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID will be derived from the server provided "entryUUID" LDAP attribute.
useServerNaming(AttributeType, AttributeDescription) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must not be provided by the user, and will not be used for naming the associated LDAP entry.
useServerNaming(String, String) - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that the JSON resource ID must not be provided by the user, and will not be used for naming the associated LDAP entry.
useSubtreeDelete() - Method in class org.forgerock.opendj.rest2ldap.Rest2LDAP.Builder
Indicates that all LDAP delete operations should be performed using the LDAP subtree delete control.

V

valueOf(String) - Static method in enum org.forgerock.opendj.rest2ldap.AuthorizationPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.rest2ldap.ReadOnUpdatePolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.opendj.rest2ldap.WritabilityPolicy
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.forgerock.opendj.rest2ldap.AuthorizationPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.rest2ldap.ReadOnUpdatePolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.opendj.rest2ldap.WritabilityPolicy
Returns an array containing the constants of this enum type, in the order they are declared.

W

WritabilityPolicy - Enum in org.forgerock.opendj.rest2ldap
The writability policy determines whether or not an attribute supports updates.
A B C D E I L M O P R S T U V W 
OpenDJ Commons REST Adapter 3.0.0-SNAPSHOT Documentation

Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.