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

Interface HdapEndpointCfgClient

All Superinterfaces:

ConfigurationClient, HttpEndpointCfgClient

public interface HdapEndpointCfgClient
extends HttpEndpointCfgClient

A client-side interface for reading and modifying Hdap Endpoint settings.

The Hdap Endpoint provides a lightweight REST API for accessing all directory data.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends HdapEndpointCfgClient,? extends HdapEndpointCfg>	definition()	Get the configuration definition associated with this Hdap Endpoint.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isReturnNullForMissingProperties()	Gets the "return-null-for-missing-properties" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setReturnNullForMissingProperties(ValueOrExpression<Boolean> value)	Sets the "return-null-for-missing-properties" 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 HdapEndpointCfgClient,? extends HdapEndpointCfg> definition()

Get the configuration definition associated with this Hdap Endpoint.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpEndpointCfgClient

Returns:

Returns the configuration definition associated with this Hdap Endpoint.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

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

Specified by:

getJavaClass in interface HttpEndpointCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Hdap 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.

isReturnNullForMissingProperties

ValueOrExpression<Boolean> isReturnNullForMissingProperties()

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

Indicates whether missing JSON properties should be included in JSON resources.

By default JSON properties which are not present in the target LDAP entries are not included in JSON resources returned by the REST endpoint. Set this option to true if these JSON properties should be included. LDAP attributes that are defined as SINGLE-VALUE are returned as null, or as an empty array if not.

Default value: false

Returns:

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

setReturnNullForMissingProperties

void setReturnNullForMissingProperties(ValueOrExpression<Boolean> value)
                                throws PropertyException

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

Indicates whether missing JSON properties should be included in JSON resources.

By default JSON properties which are not present in the target LDAP entries are not included in JSON resources returned by the REST endpoint. Set this option to true if these JSON properties should be included. LDAP attributes that are defined as SINGLE-VALUE are returned as null, or as an empty array if not.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.