Package org.forgerock.opendj.server.config.client

Interface AdministrationConnectorCfgClient

All Superinterfaces:

ConfigurationClient

public interface AdministrationConnectorCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Administration Connector settings.

The Administration Connector is used to interact with administration tools using LDAP.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AdministrationConnectorCfgClient,? extends AdministrationConnectorCfg>	definition()	Get the configuration definition associated with this Administration Connector.
String	getKeyManagerProvider()	Gets the "key-manager-provider" property.
SortedSet<InetAddress>	getListenAddress()	Gets the "listen-address" property.
Integer	getListenPort()	Gets the "listen-port" property.
SortedSet<String>	getSSLCertNickname()	Gets the "ssl-cert-nickname" property.
SortedSet<String>	getSSLCipherSuite()	Gets the "ssl-cipher-suite" property.
SortedSet<String>	getSSLProtocol()	Gets the "ssl-protocol" property.
String	getTrustManagerProvider()	Gets the "trust-manager-provider" property.
void	setKeyManagerProvider(String value)	Sets the "key-manager-provider" property.
void	setListenAddress(Collection<InetAddress> values)	Sets the "listen-address" property.
void	setListenPort(int value)	Sets the "listen-port" property.
void	setSSLCertNickname(Collection<String> values)	Sets the "ssl-cert-nickname" property.
void	setSSLCipherSuite(Collection<String> values)	Sets the "ssl-cipher-suite" property.
void	setSSLProtocol(Collection<String> values)	Sets the "ssl-protocol" property.
void	setTrustManagerProvider(String value)	Sets the "trust-manager-provider" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends AdministrationConnectorCfgClient,? extends AdministrationConnectorCfg> definition()

Get the configuration definition associated with this Administration Connector.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Administration Connector.

getKeyManagerProvider

String getKeyManagerProvider()

Gets the "key-manager-provider" property.

Specifies the name of the key manager that is used with the Administration Connector .

Returns:

Returns the value of the "key-manager-provider" property.

setKeyManagerProvider

void setKeyManagerProvider(String value)
                    throws PropertyException

Sets the "key-manager-provider" property.

Specifies the name of the key manager that is used with the Administration Connector .

Parameters:

value - The value of the "key-manager-provider" property.

Throws:

PropertyException - If the new value is invalid.

getListenAddress

SortedSet<InetAddress> getListenAddress()

Gets the "listen-address" property.

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.

Returns:

Returns the values of the "listen-address" property.

setListenAddress

void setListenAddress(Collection<InetAddress> values)
               throws PropertyException

Sets the "listen-address" property.

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.

Parameters:

values - The values of the "listen-address" property.

Throws:

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

getListenPort

Integer getListenPort()

Gets the "listen-port" property.

Specifies the port number on which the Administration Connector will listen for connections from clients.

Only a single port number may be provided.

Returns:

Returns the value of the "listen-port" property.

setListenPort

void setListenPort(int value)
            throws PropertyException

Sets the "listen-port" property.

Specifies the port number on which the Administration Connector will listen for connections from clients.

Only a single port number may be provided.

Parameters:

value - The value of the "listen-port" property.

Throws:

PropertyException - If the new value is invalid.

getSSLCertNickname

SortedSet<String> getSSLCertNickname()

Gets the "ssl-cert-nickname" property.

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.

Returns:

Returns the values of the "ssl-cert-nickname" property.

setSSLCertNickname

void setSSLCertNickname(Collection<String> values)
                 throws PropertyException

Sets the "ssl-cert-nickname" property.

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.

Parameters:

values - The values of the "ssl-cert-nickname" property.

Throws:

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

getSSLCipherSuite

SortedSet<String> getSSLCipherSuite()

Gets the "ssl-cipher-suite" property.

Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

Returns:

Returns the values of the "ssl-cipher-suite" property.

setSSLCipherSuite

void setSSLCipherSuite(Collection<String> values)
                throws PropertyException

Sets the "ssl-cipher-suite" property.

Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

Parameters:

values - The values of the "ssl-cipher-suite" property.

Throws:

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

getSSLProtocol

SortedSet<String> getSSLProtocol()

Gets the "ssl-protocol" property.

Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.

Returns:

Returns the values of the "ssl-protocol" property.

setSSLProtocol

void setSSLProtocol(Collection<String> values)
             throws PropertyException

Sets the "ssl-protocol" property.

Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.

Parameters:

values - The values of the "ssl-protocol" property.

Throws:

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

getTrustManagerProvider

String getTrustManagerProvider()

Gets the "trust-manager-provider" property.

Specifies the name of the trust manager that is used with the Administration Connector .

Returns:

Returns the value of the "trust-manager-provider" property.

setTrustManagerProvider

void setTrustManagerProvider(String value)
                      throws PropertyException

Sets the "trust-manager-provider" property.

Specifies the name of the trust manager that is used with the Administration Connector .

Parameters:

value - The value of the "trust-manager-provider" property.

Throws:

PropertyException - If the new value is invalid.