public interface ConnectionHandlerCfgClient extends ConfigurationClient
Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg> |
definition()
Get the configuration definition associated with this Connection Handler.
|
SortedSet<ValueOrExpression<AddressMask>> |
getAllowedClient()
Gets the "allowed-client" property.
|
SortedSet<ValueOrExpression<AddressMask>> |
getDeniedClient()
Gets the "denied-client" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
SortedSet<ValueOrExpression<AddressMask>> |
getRestrictedClient()
Gets the "restricted-client" property.
|
ValueOrExpression<Integer> |
getRestrictedClientConnectionLimit()
Gets the "restricted-client-connection-limit" property.
|
ValueOrExpression<Boolean> |
isEnabled()
Gets the "enabled" property.
|
void |
setAllowedClient(Collection<ValueOrExpression<AddressMask>> values)
Sets the "allowed-client" property.
|
void |
setDeniedClient(Collection<ValueOrExpression<AddressMask>> values)
Sets the "denied-client" property.
|
void |
setEnabled(ValueOrExpression<Boolean> value)
Sets the "enabled" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setRestrictedClient(Collection<ValueOrExpression<AddressMask>> values)
Sets the "restricted-client" property.
|
void |
setRestrictedClientConnectionLimit(ValueOrExpression<Integer> value)
Sets the "restricted-client-connection-limit" property.
|
commit, properties
ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg> definition()
definition
in interface ConfigurationClient
SortedSet<ValueOrExpression<AddressMask>> getAllowedClient()
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.
void setAllowedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
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.
values
- The values of the "allowed-client" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<AddressMask>> getDeniedClient()
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.
void setDeniedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
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.
values
- The values of the "denied-client" property.PropertyException
- If one or more of the new values are invalid.@MandatoryProperty ValueOrExpression<Boolean> isEnabled()
Indicates whether the Connection Handler is enabled.
@MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the Connection Handler is enabled.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.@MandatoryProperty ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation.
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation.
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<AddressMask>> getRestrictedClient()
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.
void setRestrictedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
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.
values
- The values of the "restricted-client" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getRestrictedClientConnectionLimit()
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.
void setRestrictedClientConnectionLimit(ValueOrExpression<Integer> value) throws PropertyException
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.
value
- The value of the "restricted-client-connection-limit" property.PropertyException
- If the new value is invalid.Copyright 2010-2022 ForgeRock AS.