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

Interface Rest2ldapEndpointCfg

All Superinterfaces:

Configuration, HttpEndpointCfg

public interface Rest2ldapEndpointCfg
extends HttpEndpointCfg

A server-side interface for querying Rest2LDAP Endpoint settings.

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

Method Summary

Modifier and Type	Method	Description
void	addRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener)	Register to be notified when this Rest2LDAP Endpoint is changed.
Class<? extends Rest2ldapEndpointCfg>	configurationClass()	Gets the configuration class associated with this Rest2LDAP Endpoint.
String	getConfigDirectory()	Gets the "config-directory" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isReturnNullForMissingProperties()	Gets the "return-null-for-missing-properties" property.
void	removeRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener)	Deregister an existing Rest2LDAP Endpoint configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.HttpEndpointCfg

addChangeListener, getAuthorizationMechanism, getAuthorizationMechanismDns, getBasePath, isEnabled, removeChangeListener

Method Details

configurationClass

Class<? extends Rest2ldapEndpointCfg> configurationClass()

Gets the configuration class associated with this Rest2LDAP Endpoint.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HttpEndpointCfg

Returns:

Returns the configuration class associated with this Rest2LDAP Endpoint.

addRest2ldapEndpointChangeListener

void addRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener)

Register to be notified when this Rest2LDAP Endpoint is changed.

Parameters:

listener - The Rest2LDAP Endpoint configuration change listener.

removeRest2ldapEndpointChangeListener

void removeRest2ldapEndpointChangeListener(ConfigurationChangeListener<Rest2ldapEndpointCfg> listener)

Deregister an existing Rest2LDAP Endpoint configuration change listener.

Parameters:

listener - The Rest2LDAP Endpoint configuration change listener.

getConfigDirectory

String getConfigDirectory()

Gets the "config-directory" property.

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 value of the "config-directory" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.protocols.http.rest2ldap.Rest2LdapEndpoint

Specified by:

getJavaClass in interface HttpEndpointCfg

Returns:

Returns the value of the "java-class" property.

isReturnNullForMissingProperties

boolean isReturnNullForMissingProperties()

Gets the "return-null-for-missing-properties" property.

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.

Default value: false

Returns:

Returns the value of the "return-null-for-missing-properties" property.