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

Interface ConnectionHandlerCfg

All Superinterfaces:

Configuration

All Known Subinterfaces:

HTTPConnectionHandlerCfg, JMXConnectionHandlerCfg, LDAPConnectionHandlerCfg, LDIFConnectionHandlerCfg, SNMPConnectionHandlerCfg

public interface ConnectionHandlerCfg
extends Configuration

A server-side interface for querying Connection Handler settings.

Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener)	Register to be notified when this Connection Handler is changed.
Class<? extends ConnectionHandlerCfg>	configurationClass()	Gets the configuration class associated with this Connection Handler.
SortedSet<org.forgerock.opendj.ldap.AddressMask>	getAllowedClient()	Gets the "allowed-client" property.
SortedSet<org.forgerock.opendj.ldap.AddressMask>	getDeniedClient()	Gets the "denied-client" property.
String	getJavaClass()	Gets the "java-class" property.
boolean	isEnabled()	Gets the "enabled" property.
void	removeChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener)	Deregister an existing Connection Handler configuration change listener.

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

dn, name

Method Detail

configurationClass

Class<? extends ConnectionHandlerCfg> configurationClass()

Gets the configuration class associated with this Connection Handler.

Specified by:

configurationClass in interface Configuration

Returns:

Returns the configuration class associated with this Connection Handler.

addChangeListener

void addChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener)

Register to be notified when this Connection Handler is changed.

Parameters:

listener - The Connection Handler configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener)

Deregister an existing Connection Handler configuration change listener.

Parameters:

listener - The Connection Handler configuration change listener.

getAllowedClient

SortedSet<org.forgerock.opendj.ldap.AddressMask> getAllowedClient()

Gets the "allowed-client" property.

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.

Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.

Returns:

Returns an unmodifiable set containing the values of the "allowed-client" property.

getDeniedClient

SortedSet<org.forgerock.opendj.ldap.AddressMask> getDeniedClient()

Gets the "denied-client" property.

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.

Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed.

Returns:

Returns an unmodifiable set containing the values of the "denied-client" property.

isEnabled

boolean isEnabled()

Gets the "enabled" property.

Indicates whether the Connection Handler is enabled.

Returns:

Returns the value of the "enabled" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Returns:

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