Package org.forgerock.opendj.server.config.meta

Class Rest2ldapEndpointCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<Rest2ldapEndpointCfgClient,Rest2ldapEndpointCfg>

org.forgerock.opendj.server.config.meta.Rest2ldapEndpointCfgDefn

public final class Rest2ldapEndpointCfgDefn
extends ManagedObjectDefinition<Rest2ldapEndpointCfgClient,Rest2ldapEndpointCfg>

An interface for querying the Rest2LDAP Endpoint managed object definition meta information.

The Rest2LDAP Endpoint provides RESTful access to LDAP application data using a set of customizable data transformations.

Method Summary

Modifier and Type	Method	Description
Rest2ldapEndpointCfgClient	createClientConfiguration(ManagedObject<? extends Rest2ldapEndpointCfgClient> impl)	Creates a client configuration view of the provided managed object.
Rest2ldapEndpointCfg	createServerConfiguration(ServerManagedObject<? extends Rest2ldapEndpointCfg> impl)	Creates a server configuration view of the provided server managed object.
AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg>	getAuthorizationMechanismPropertyDefinition()	Get the "authorization-mechanism" property definition.
StringPropertyDefinition	getBasePathPropertyDefinition()	Get the "base-path" property definition.
StringPropertyDefinition	getConfigDirectoryPropertyDefinition()	Get the "config-directory" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static Rest2ldapEndpointCfgDefn	getInstance()	Get the Rest2LDAP Endpoint configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
BooleanPropertyDefinition	getReturnNullForMissingPropertiesPropertyDefinition()	Get the "return-null-for-missing-properties" property definition.
Class<Rest2ldapEndpointCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Rest2ldapEndpointCfgDefn getInstance()

Get the Rest2LDAP Endpoint configuration definition singleton.

Returns:

Returns the Rest2LDAP Endpoint configuration definition singleton.

createClientConfiguration

public Rest2ldapEndpointCfgClient createClientConfiguration(ManagedObject<? extends Rest2ldapEndpointCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<Rest2ldapEndpointCfgClient,Rest2ldapEndpointCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public Rest2ldapEndpointCfg createServerConfiguration(ServerManagedObject<? extends Rest2ldapEndpointCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<Rest2ldapEndpointCfgClient,Rest2ldapEndpointCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<Rest2ldapEndpointCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<Rest2ldapEndpointCfgClient,Rest2ldapEndpointCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAuthorizationMechanismPropertyDefinition

public AggregationPropertyDefinition<HttpAuthorizationMechanismCfgClient,HttpAuthorizationMechanismCfg> getAuthorizationMechanismPropertyDefinition()

Get the "authorization-mechanism" property definition.

The HTTP authorization mechanisms supported by this Rest2LDAP Endpoint.

Returns:

Returns the "authorization-mechanism" property definition.

getBasePathPropertyDefinition

public StringPropertyDefinition getBasePathPropertyDefinition()

Get the "base-path" property definition.

All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.

Returns:

Returns the "base-path" property definition.

getConfigDirectoryPropertyDefinition

public StringPropertyDefinition getConfigDirectoryPropertyDefinition()

Get the "config-directory" property definition.

The directory containing the Rest2Ldap configuration file(s) for this specific endpoint.

The directory must be readable by the server and may contain multiple configuration files, one for each supported version of the REST endpoint. If a relative path is used then it will be resolved against the server's instance directory.

Returns:

Returns the "config-directory" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Rest2LDAP Endpoint is enabled.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Rest2LDAP Endpoint implementation.

Returns:

Returns the "java-class" property definition.

getReturnNullForMissingPropertiesPropertyDefinition

public BooleanPropertyDefinition getReturnNullForMissingPropertiesPropertyDefinition()

Get the "return-null-for-missing-properties" property definition.

Indicates whether missing (unmapped) JSON properties should be included in JSON resources.

By default JSON properties that do not have a corresponding LDAP attribute are unmapped and not included in JSON resources returned by the REST endpoint. Set this option to true if unmapped JSON properties should be included with a value of null.

Returns:

Returns the "return-null-for-missing-properties" property definition.