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

Class CryptoManagerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<CryptoManagerCfgClient,CryptoManagerCfg>

org.forgerock.opendj.server.config.meta.CryptoManagerCfgDefn

public final class CryptoManagerCfgDefn
extends ManagedObjectDefinition<CryptoManagerCfgClient,CryptoManagerCfg>

An interface for querying the Crypto Manager managed object definition meta information.

The Crypto Manager provides a common interface for performing compression, decompression, hashing, encryption and other kinds of cryptographic operations.

Method Summary

Modifier and Type	Method	Description
CryptoManagerCfgClient	createClientConfiguration(ManagedObject<? extends CryptoManagerCfgClient> impl)	Creates a client configuration view of the provided managed object.
CryptoManagerCfg	createServerConfiguration(ServerManagedObject<? extends CryptoManagerCfg> impl)	Creates a server configuration view of the provided server managed object.
IntegerPropertyDefinition	getCipherKeyLengthPropertyDefinition()	Get the "cipher-key-length" property definition.
StringPropertyDefinition	getCipherTransformationPropertyDefinition()	Get the "cipher-transformation" property definition.
StringPropertyDefinition	getDigestAlgorithmPropertyDefinition()	Get the "digest-algorithm" property definition.
static CryptoManagerCfgDefn	getInstance()	Get the Crypto Manager configuration definition singleton.
StringPropertyDefinition	getKeyWrappingTransformationPropertyDefinition()	Get the "key-wrapping-transformation" property definition.
StringPropertyDefinition	getMacAlgorithmPropertyDefinition()	Get the "mac-algorithm" property definition.
IntegerPropertyDefinition	getMacKeyLengthPropertyDefinition()	Get the "mac-key-length" property definition.
Class<CryptoManagerCfg>	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.
BooleanPropertyDefinition	getSSLEncryptionPropertyDefinition()	Get the "ssl-encryption" property definition.
StringPropertyDefinition	getSSLProtocolPropertyDefinition()	Get the "ssl-protocol" 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 CryptoManagerCfgDefn getInstance()

Get the Crypto Manager configuration definition singleton.

Returns:

Returns the Crypto Manager configuration definition singleton.

createClientConfiguration

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

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<CryptoManagerCfgClient,CryptoManagerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CryptoManagerCfgClient,CryptoManagerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<CryptoManagerCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CryptoManagerCfgClient,CryptoManagerCfg>

Returns:

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

getCipherKeyLengthPropertyDefinition

public IntegerPropertyDefinition getCipherKeyLengthPropertyDefinition()

Get the "cipher-key-length" property definition.

Specifies the key length in bits for the preferred cipher.

Returns:

Returns the "cipher-key-length" property definition.

getCipherTransformationPropertyDefinition

public StringPropertyDefinition getCipherTransformationPropertyDefinition()

Get the "cipher-transformation" property definition.

Specifies the cipher for the directory server using the syntax algorithm/mode/padding.

The full transformation is required: specifying only an algorithm and allowing the cipher provider to supply the default mode and padding is not supported, because there is no guarantee these default values are the same among different implementations. Some cipher algorithms, including RC4 and ARCFOUR, do not have a mode or padding, and hence must be specified using NONE for the mode field and NoPadding for the padding field. For example, RC4/NONE/NoPadding.

Returns:

Returns the "cipher-transformation" property definition.

getDigestAlgorithmPropertyDefinition

public StringPropertyDefinition getDigestAlgorithmPropertyDefinition()

Get the "digest-algorithm" property definition.

Specifies the preferred message digest algorithm for the directory server.

Returns:

Returns the "digest-algorithm" property definition.

getKeyWrappingTransformationPropertyDefinition

public StringPropertyDefinition getKeyWrappingTransformationPropertyDefinition()

Get the "key-wrapping-transformation" property definition.

The preferred key wrapping transformation for the directory server. This value must be the same for all server instances in a replication topology.

Returns:

Returns the "key-wrapping-transformation" property definition.

getMacAlgorithmPropertyDefinition

public StringPropertyDefinition getMacAlgorithmPropertyDefinition()

Get the "mac-algorithm" property definition.

Specifies the preferred MAC algorithm for the directory server.

Returns:

Returns the "mac-algorithm" property definition.

getMacKeyLengthPropertyDefinition

public IntegerPropertyDefinition getMacKeyLengthPropertyDefinition()

Get the "mac-key-length" property definition.

Specifies the key length in bits for the preferred MAC algorithm.

Returns:

Returns the "mac-key-length" 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 Crypto Manager 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 Crypto Manager 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 or TLS communication.

Returns:

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

getSSLEncryptionPropertyDefinition

public BooleanPropertyDefinition getSSLEncryptionPropertyDefinition()

Get the "ssl-encryption" property definition.

Specifies whether SSL/TLS is used to provide encrypted communication between two OpenDJ server components.

Returns:

Returns the "ssl-encryption" 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 TLS communication.

Returns:

Returns the "ssl-protocol" property definition.