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.
String	getJavaClass()	Gets the "java-class" property.
String	getLDIFDirectory()	Gets the "ldif-directory" property.
long	getPollInterval()	Gets the "poll-interval" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLDIFDirectory(String value)	Sets the "ldif-directory" property.
void	setPollInterval(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, isEnabled, setAllowedClient, setDeniedClient, setEnabled

Method Detail

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

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface ConnectionHandlerCfgClient

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

String getLDIFDirectory()

Gets the "ldif-directory" property.

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

Returns:

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

setLDIFDirectory

void setLDIFDirectory(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

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.

Returns:

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

setPollInterval

void setPollInterval(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.