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

Interface LdifConnectionHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ConnectionHandlerCfgClient

public interface LdifConnectionHandlerCfgClient
extends ConnectionHandlerCfgClient

A client-side interface for reading and modifying LDIF Connection Handler settings.

The LDIF Connection Handler is used to process changes in the server using internal operations, where the changes to process are read from an LDIF file.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LdifConnectionHandlerCfgClient,? extends LdifConnectionHandlerCfg>	definition()	Get the configuration definition associated with this LDIF Connection Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<String>	getLdifDirectory()	Gets the "ldif-directory" property.
ValueOrExpression<Long>	getPollInterval()	Gets the "poll-interval" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setLdifDirectory(ValueOrExpression<String> value)	Sets the "ldif-directory" property.
void	setPollInterval(ValueOrExpression<Long> value)	Sets the "poll-interval" property.

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

commit, properties

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

getAllowedClient, getDeniedClient, getRestrictedClient, getRestrictedClientConnectionLimit, isEnabled, setAllowedClient, setDeniedClient, setEnabled, setRestrictedClient, setRestrictedClientConnectionLimit

Method Details

definition

ManagedObjectDefinition<? extends LdifConnectionHandlerCfgClient,? extends LdifConnectionHandlerCfg> definition()

Get the configuration definition associated with this LDIF Connection Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ConnectionHandlerCfgClient

Returns:

Returns the configuration definition associated with this LDIF Connection Handler.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the LDIF Connection Handler implementation.

Default value: org.opends.server.protocols.LDIFConnectionHandler

Specified by:

getJavaClass in interface ConnectionHandlerCfgClient

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 LDIF Connection Handler implementation.

Specified by:

setJavaClass in interface ConnectionHandlerCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getLdifDirectory

@MandatoryProperty
ValueOrExpression<String> getLdifDirectory()

Gets the "ldif-directory" property.

Specifies the path to the directory in which the LDIF files should be placed.

Default value: config/auto-process-ldif

Returns:

Returns the value of the "ldif-directory" property.

setLdifDirectory

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

Sets the "ldif-directory" property.

Specifies the path to the directory in which the LDIF files should be placed.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getPollInterval

@MandatoryProperty
ValueOrExpression<Long> getPollInterval()

Gets the "poll-interval" property.

Specifies how frequently the LDIF connection handler should check the LDIF directory to determine whether a new LDIF file has been added.

Default value: 5 seconds

Returns:

Returns the value of the "poll-interval" property.

setPollInterval

@MandatoryProperty
void setPollInterval(ValueOrExpression<Long> value)
              throws PropertyException

Sets the "poll-interval" property.

Specifies how frequently the LDIF connection handler should check the LDIF directory to determine whether a new LDIF file has been added.

Parameters:

value - The value of the "poll-interval" property.

Throws:

PropertyException - If the new value is invalid.