org.opends.server.admin.std.client
Interface ConnectionHandlerCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
JMXConnectionHandlerCfgClient, LDAPConnectionHandlerCfgClient, LDIFConnectionHandlerCfgClient, SNMPConnectionHandlerCfgClient

public interface ConnectionHandlerCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg> definition()
          Get the configuration definition 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.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setAllowedClient(java.util.Collection<AddressMask> values)
          Sets the "allowed-client" property.
 void setDeniedClient(java.util.Collection<AddressMask> values)
          Sets the "denied-client" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg> definition()
Get the configuration definition associated with this Connection Handler.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Connection Handler.

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 the values of the "allowed-client" property.

setAllowedClient

void setAllowedClient(java.util.Collection<AddressMask> values)
                      throws IllegalPropertyValueException
Sets 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.

Parameters:
values - The values of the "allowed-client" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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 the values of the "denied-client" property.

setDeniedClient

void setDeniedClient(java.util.Collection<AddressMask> values)
                     throws IllegalPropertyValueException
Sets 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.

Parameters:
values - The values of the "denied-client" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Connection Handler is enabled.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Connection Handler is enabled.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.