org.opends.server.admin.std.client

Interface ConnectionHandlerCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

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

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg>	definition() Get the configuration definition 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	setAllowedClient(Collection<org.forgerock.opendj.ldap.AddressMask> values) Sets the "allowed-client" property.
void	setDeniedClient(Collection<org.forgerock.opendj.ldap.AddressMask> values) Sets the "denied-client" property.
void	setEnabled(boolean value) Sets the "enabled" property.
void	setJavaClass(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

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

setAllowedClient

void setAllowedClient(Collection<org.forgerock.opendj.ldap.AddressMask> values)
                      throws PropertyException

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

Parameters:

values - The values of the "allowed-client" property.

Throws:

PropertyException - If one or more of the new values are invalid.

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

setDeniedClient

void setDeniedClient(Collection<org.forgerock.opendj.ldap.AddressMask> values)
                     throws PropertyException

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

Parameters:

values - The values of the "denied-client" property.

Throws:

PropertyException - If one or more of the new values are invalid.

isEnabled

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 PropertyException

Sets the "enabled" property.

Indicates whether the Connection Handler is enabled.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

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.

setJavaClass

void setJavaClass(String value)
                  throws PropertyException

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:

PropertyException - If the new value is invalid.