Package org.forgerock.opendj.server.config.meta

Class AdministrationConnectorCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>

org.forgerock.opendj.server.config.meta.AdministrationConnectorCfgDefn

public final class AdministrationConnectorCfgDefn
extends ManagedObjectDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>

An interface for querying the Administration Connector managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
AdministrationConnectorCfgClient	createClientConfiguration(ManagedObject<? extends AdministrationConnectorCfgClient> impl)	Creates a client configuration view of the provided managed object.
AdministrationConnectorCfg	createServerConfiguration(ServerManagedObject<? extends AdministrationConnectorCfg> impl)	Creates a server configuration view of the provided server managed object.
HostPropertyDefinition	getAdvertisedListenAddressPropertyDefinition()	Get the "advertised-listen-address" property definition.
IpAddressMaskPropertyDefinition	getAllowedClientPropertyDefinition()	Get the "allowed-client" property definition.
IpAddressMaskPropertyDefinition	getDeniedClientPropertyDefinition()	Get the "denied-client" property definition.
static AdministrationConnectorCfgDefn	getInstance()	Get the Administration Connector configuration definition singleton.
AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>	getKeyManagerProviderPropertyDefinition()	Get the "key-manager-provider" property definition.
HostPropertyDefinition	getListenAddressPropertyDefinition()	Get the "listen-address" property definition.
IntegerPropertyDefinition	getListenPortPropertyDefinition()	Get the "listen-port" property definition.
IntegerPropertyDefinition	getRestrictedClientConnectionLimitPropertyDefinition()	Get the "restricted-client-connection-limit" property definition.
IpAddressMaskPropertyDefinition	getRestrictedClientPropertyDefinition()	Get the "restricted-client" property definition.
Class<AdministrationConnectorCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getSslCertNicknamePropertyDefinition()	Get the "ssl-cert-nickname" property definition.
StringPropertyDefinition	getSslCipherSuitePropertyDefinition()	Get the "ssl-cipher-suite" property definition.
StringPropertyDefinition	getSslProtocolPropertyDefinition()	Get the "ssl-protocol" property definition.
AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg>	getTrustManagerProviderPropertyDefinition()	Get the "trust-manager-provider" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static AdministrationConnectorCfgDefn getInstance()

Get the Administration Connector configuration definition singleton.

Returns:

Returns the Administration Connector configuration definition singleton.

createClientConfiguration

public AdministrationConnectorCfgClient createClientConfiguration(ManagedObject<? extends AdministrationConnectorCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public AdministrationConnectorCfg createServerConfiguration(ServerManagedObject<? extends AdministrationConnectorCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<AdministrationConnectorCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AdministrationConnectorCfgClient,AdministrationConnectorCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAdvertisedListenAddressPropertyDefinition

public HostPropertyDefinition getAdvertisedListenAddressPropertyDefinition()

Get the "advertised-listen-address" property definition.

The advertised address(es) which clients should use for connecting to this Administration Connector.

Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted.

Returns:

Returns the "advertised-listen-address" property definition.

getAllowedClientPropertyDefinition

public IpAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()

Get the "allowed-client" property definition.

A set of clients who will be 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.

Returns:

Returns the "allowed-client" property definition.

getDeniedClientPropertyDefinition

public IpAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()

Get the "denied-client" property definition.

A set of clients who 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.

Returns:

Returns the "denied-client" property definition.

getKeyManagerProviderPropertyDefinition

public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()

Get the "key-manager-provider" property definition.

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

Returns:

Returns the "key-manager-provider" property definition.

getListenAddressPropertyDefinition

public HostPropertyDefinition getListenAddressPropertyDefinition()

Get the "listen-address" property definition.

The network interface(s) on which this Administration Connector should listen for incoming client connections.

Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces.

Returns:

Returns the "listen-address" property definition.

getListenPortPropertyDefinition

public IntegerPropertyDefinition getListenPortPropertyDefinition()

Get the "listen-port" property definition.

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 "listen-port" property definition.

getRestrictedClientPropertyDefinition

public IpAddressMaskPropertyDefinition getRestrictedClientPropertyDefinition()

Get the "restricted-client" property definition.

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.

Returns:

Returns the "restricted-client" property definition.

getRestrictedClientConnectionLimitPropertyDefinition

public IntegerPropertyDefinition getRestrictedClientConnectionLimitPropertyDefinition()

Get the "restricted-client-connection-limit" property definition.

Specifies the maximum number of connections a restricted client can open at the same time to this Administration Connector.

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.

Returns:

Returns the "restricted-client-connection-limit" property definition.

getSslCertNicknamePropertyDefinition

public StringPropertyDefinition getSslCertNicknamePropertyDefinition()

Get the "ssl-cert-nickname" property definition.

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. This is only applicable when the Administration Connector is configured to use SSL.

Returns:

Returns the "ssl-cert-nickname" property definition.

getSslCipherSuitePropertyDefinition

public StringPropertyDefinition getSslCipherSuitePropertyDefinition()

Get the "ssl-cipher-suite" property definition.

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

Returns:

Returns the "ssl-cipher-suite" property definition.

getSslProtocolPropertyDefinition

public StringPropertyDefinition getSslProtocolPropertyDefinition()

Get the "ssl-protocol" property definition.

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

Returns:

Returns the "ssl-protocol" property definition.

getTrustManagerProviderPropertyDefinition

public AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()

Get the "trust-manager-provider" property definition.

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

Returns:

Returns the "trust-manager-provider" property definition.