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
All Methods Instance Methods Abstract Methods 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<AddressMask>
getAllowedClient()
Gets the "allowed-client" property.SortedSet<AddressMask>
getDeniedClient()
Gets the "denied-client" property.String
getJavaClass()
Gets the "java-class" property.SortedSet<AddressMask>
getRestrictedClient()
Gets the "restricted-client" property.Integer
getRestrictedClientConnectionLimit()
Gets the "restricted-client-connection-limit" 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 interfaceConfiguration
- 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<AddressMask> getAllowedClient()
Gets the "allowed-client" property.A set of clients who will be 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.
Default value is inherited from another property
- Returns:
- Returns an unmodifiable set containing the values of the "allowed-client" property.
-
getDeniedClient
SortedSet<AddressMask> getDeniedClient()
Gets the "denied-client" property.A set of clients who 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.
Default value is inherited from another property
- 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.
-
getRestrictedClient
SortedSet<AddressMask> getRestrictedClient()
Gets the "restricted-client" property.A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.
Default value is inherited from another property
- Returns:
- Returns an unmodifiable set containing the values of the "restricted-client" property.
-
getRestrictedClientConnectionLimit
Integer getRestrictedClientConnectionLimit()
Gets the "restricted-client-connection-limit" property.Specifies the maximum number of connections a restricted client can open at the same time to this Connection Handler.
Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration.
Default value is inherited from another property
- Returns:
- Returns the value of the "restricted-client-connection-limit" property.
-
-