public interface AdministrationConnectorCfgClient extends ConfigurationClient
The Administration Connector is used to interact with administration tools using LDAP.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends AdministrationConnectorCfgClient,? extends AdministrationConnectorCfg> |
definition()
Get the configuration definition associated with this Administration Connector.
|
SortedSet<ValueOrExpression<AddressMask>> |
getAllowedClient()
Gets the "allowed-client" property.
|
SortedSet<ValueOrExpression<AddressMask>> |
getDeniedClient()
Gets the "denied-client" property.
|
ValueOrExpression<String> |
getKeyManagerProvider()
Gets the "key-manager-provider" property.
|
SortedSet<ValueOrExpression<InetAddress>> |
getListenAddress()
Gets the "listen-address" property.
|
ValueOrExpression<Integer> |
getListenPort()
Gets the "listen-port" property.
|
SortedSet<ValueOrExpression<String>> |
getSslCertNickname()
Gets the "ssl-cert-nickname" property.
|
SortedSet<ValueOrExpression<String>> |
getSslCipherSuite()
Gets the "ssl-cipher-suite" property.
|
SortedSet<ValueOrExpression<String>> |
getSslProtocol()
Gets the "ssl-protocol" property.
|
ValueOrExpression<String> |
getTrustManagerProvider()
Gets the "trust-manager-provider" property.
|
void |
setAllowedClient(Collection<ValueOrExpression<AddressMask>> values)
Sets the "allowed-client" property.
|
void |
setDeniedClient(Collection<ValueOrExpression<AddressMask>> values)
Sets the "denied-client" property.
|
void |
setKeyManagerProvider(ValueOrExpression<String> value)
Sets the "key-manager-provider" property.
|
void |
setListenAddress(Collection<ValueOrExpression<InetAddress>> values)
Sets the "listen-address" property.
|
void |
setListenPort(ValueOrExpression<Integer> value)
Sets the "listen-port" property.
|
void |
setSslCertNickname(Collection<ValueOrExpression<String>> values)
Sets the "ssl-cert-nickname" property.
|
void |
setSslCipherSuite(Collection<ValueOrExpression<String>> values)
Sets the "ssl-cipher-suite" property.
|
void |
setSslProtocol(Collection<ValueOrExpression<String>> values)
Sets the "ssl-protocol" property.
|
void |
setTrustManagerProvider(ValueOrExpression<String> value)
Sets the "trust-manager-provider" property.
|
commit, properties
ManagedObjectDefinition<? extends AdministrationConnectorCfgClient,? extends AdministrationConnectorCfg> definition()
definition
in interface ConfigurationClient
SortedSet<ValueOrExpression<AddressMask>> getAllowedClient()
Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Administration Connector.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.
void setAllowedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Administration Connector.
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.
values
- The values of the "allowed-client" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<AddressMask>> getDeniedClient()
Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Administration Connector.
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.
void setDeniedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Administration Connector.
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.
values
- The values of the "denied-client" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getKeyManagerProvider()
Specifies the name of the key manager that is used with the Administration Connector .
void setKeyManagerProvider(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the key manager that is used with the Administration Connector .
value
- The value of the "key-manager-provider" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<InetAddress>> getListenAddress()
Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP clients.
Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the Administration Connector listens on all interfaces.
void setListenAddress(Collection<ValueOrExpression<InetAddress>> values) throws PropertyException
Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP clients.
Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the Administration Connector listens on all interfaces.
values
- The values of the "listen-address" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<Integer> getListenPort()
Specifies the port number on which the Administration Connector will listen for connections from clients.
Only a single port number may be provided.
void setListenPort(ValueOrExpression<Integer> value) throws PropertyException
Specifies the port number on which the Administration Connector will listen for connections from clients.
Only a single port number may be provided.
value
- The value of the "listen-port" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getSslCertNickname()
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Administration Connector should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
void setSslCertNickname(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies the nicknames (also called the aliases) of the keys or key pairs that the Administration Connector should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.
values
- The values of the "ssl-cert-nickname" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getSslCipherSuite()
Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.
void setSslCipherSuite(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.
values
- The values of the "ssl-cipher-suite" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<String>> getSslProtocol()
Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.
void setSslProtocol(Collection<ValueOrExpression<String>> values) throws PropertyException
Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.
values
- The values of the "ssl-protocol" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getTrustManagerProvider()
Specifies the name of the trust manager that is used with the Administration Connector .
void setTrustManagerProvider(ValueOrExpression<String> value) throws PropertyException
Specifies the name of the trust manager that is used with the Administration Connector .
value
- The value of the "trust-manager-provider" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.