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

Interface Rest2ldapEndpointCfgClient

All Superinterfaces:

ConfigurationClient, HTTPEndpointCfgClient

public interface Rest2ldapEndpointCfgClient
extends HTTPEndpointCfgClient

A client-side interface for reading and modifying 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
ManagedObjectDefinition<? extends Rest2ldapEndpointCfgClient,? extends Rest2ldapEndpointCfg>	definition()	Get the configuration definition associated with this Rest2ldap Endpoint.
String	getConfigDirectory()	Gets the "config-directory" property.
String	getJavaClass()	Gets the "java-class" property.
void	setConfigDirectory(String value)	Sets the "config-directory" property.
void	setJavaClass(String value)	Sets the "java-class" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.HTTPEndpointCfgClient

getAuthorizationMechanism, getBasePath, isEnabled, setAuthorizationMechanism, setBasePath, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends Rest2ldapEndpointCfgClient,? extends Rest2ldapEndpointCfg> definition()

Get the configuration definition associated with this Rest2ldap Endpoint.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HTTPEndpointCfgClient

Returns:

Returns the configuration definition associated with this Rest2ldap Endpoint.

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.

setConfigDirectory

void setConfigDirectory(String value)
                 throws PropertyException

Sets 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.

Parameters:

value - The value of the "config-directory" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface HTTPEndpointCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface HTTPEndpointCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.