org.forgerock.opendj.server.config.server

Interface LdifConnectionHandlerCfg

All Superinterfaces:

Configuration, ConnectionHandlerCfg

public interface LdifConnectionHandlerCfg
extends ConnectionHandlerCfg

A server-side interface for querying 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 and Description
void	addLdifChangeListener(ConfigurationChangeListener<LdifConnectionHandlerCfg> listener) Register to be notified when this LDIF Connection Handler is changed.
Class<? extends LdifConnectionHandlerCfg>	configurationClass() Gets the configuration class 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	removeLdifChangeListener(ConfigurationChangeListener<LdifConnectionHandlerCfg> listener) Deregister an existing LDIF Connection Handler configuration change listener.

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

addChangeListener, getAllowedClient, getDeniedClient, getRestrictedClient, getRestrictedClientConnectionLimit, isEnabled, removeChangeListener

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

dn, name

Method Detail

configurationClass

Class<? extends LdifConnectionHandlerCfg> configurationClass()

Gets the configuration class associated with this LDIF Connection Handler.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface ConnectionHandlerCfg

Returns:

Returns the configuration class associated with this LDIF Connection Handler.

addLdifChangeListener

void addLdifChangeListener(ConfigurationChangeListener<LdifConnectionHandlerCfg> listener)

Register to be notified when this LDIF Connection Handler is changed.

Parameters:

listener - The LDIF Connection Handler configuration change listener.

removeLdifChangeListener

void removeLdifChangeListener(ConfigurationChangeListener<LdifConnectionHandlerCfg> listener)

Deregister an existing LDIF Connection Handler configuration change listener.

Parameters:

listener - The LDIF Connection Handler configuration change listener.

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 ConnectionHandlerCfg

Returns:

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

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.

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.