org.opends.server.admin.std.server
Interface ConnectionHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
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
 void addChangeListener(ConfigurationChangeListener<ConnectionHandlerCfg> listener)
          Register to be notified when this Connection Handler is changed.
 java.lang.Class<? extends ConnectionHandlerCfg> configurationClass()
          Gets the configuration class associated with this Connection Handler.
 java.util.SortedSet<AddressMask> getAllowedClient()
          Gets the "allowed-client" property.
 java.util.SortedSet<AddressMask> getDeniedClient()
          Gets the "denied-client" property.
 java.lang.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.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.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

java.util.SortedSet<AddressMask> getAllowedClient()
Gets the "allowed-client" property.

Specifies a set of address masks that determines the addresses of the clients that are allowed to establish connections to this connection handler.

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

getDeniedClient

java.util.SortedSet<AddressMask> getDeniedClient()
Gets the "denied-client" property.

Specifies a set of address masks that determines the addresses of the clients that are not allowed to establish connections to this connection handler.

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

java.lang.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.