Package org.forgerock.opendj.rest2ldap

Class Hdap

java.lang.Object

org.forgerock.opendj.rest2ldap.Hdap

public final class Hdap
extends Object

Lightweight REST API providing native LDAP capabilities.

Field Summary

Fields

Modifier and Type	Field	Description
static final Option<Boolean>	NORMALIZE_ATTRIBUTE_NAMES	Specifies whether HDAP should normalize attribute names in the JSON representation of the resource, or use the name provided in the request.

Method Summary

Modifier and Type	Method	Description
static Dn	dnOf(ResourcePath resourcePath, SchemaResolver schemaResolver)	Decodes the provided URL encoded resource path as a DN.
static RequestHandler	newHdapRequestHandler(Options options)	Creates a new HDAP request handler with the provided options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NORMALIZE_ATTRIBUTE_NAMES

public static final Option<Boolean> NORMALIZE_ATTRIBUTE_NAMES

Specifies whether HDAP should normalize attribute names in the JSON representation of the resource, or use the name provided in the request. By default HDAP will normalize attribute names.

Method Details

newHdapRequestHandler

public static RequestHandler newHdapRequestHandler(Options options)

Creates a new HDAP request handler with the provided options.

Parameters:

options - The options.

Returns:

The HDAP request handler.

dnOf

public static Dn dnOf(ResourcePath resourcePath,
 SchemaResolver schemaResolver)
               throws BadRequestException

Decodes the provided URL encoded resource path as a DN. The resource path is the big-endian representation of the DN where each RDN is encoded as a separate path element. For example, the DN ou=people,dc=example,dc=com will be encoded as dc=com/dc=example/ou=people.

Parameters:

resourcePath - The URL encoded resource path.

schemaResolver - The SchemaResolver used to compute the DN.

Returns:

the DN representation of the resource path.

Throws:

BadRequestException - whenever the resource path does not represent a DN.