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

Class FileBasedKeyManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FileBasedKeyManagerProviderCfgClient,FileBasedKeyManagerProviderCfg>

org.forgerock.opendj.server.config.meta.FileBasedKeyManagerProviderCfgDefn

public final class FileBasedKeyManagerProviderCfgDefn
extends ManagedObjectDefinition<FileBasedKeyManagerProviderCfgClient,FileBasedKeyManagerProviderCfg>

An interface for querying the File Based Key Manager Provider managed object definition meta information.

The File Based Key Manager Provider can be used to obtain the server certificate from a key store file on the local file system.

Method Summary

Modifier and Type	Method	Description
FileBasedKeyManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends FileBasedKeyManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
FileBasedKeyManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends FileBasedKeyManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static FileBasedKeyManagerProviderCfgDefn	getInstance()	Get the File Based Key Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getKeyStoreFilePropertyDefinition()	Get the "key-store-file" property definition.
StringPropertyDefinition	getKeyStorePinEnvironmentVariablePropertyDefinition()	Get the "key-store-pin-environment-variable" property definition.
StringPropertyDefinition	getKeyStorePinFilePropertyDefinition()	Get the "key-store-pin-file" property definition.
StringPropertyDefinition	getKeyStorePinPropertyDefinition()	Get the "key-store-pin" property definition.
StringPropertyDefinition	getKeyStorePinPropertyPropertyDefinition()	Get the "key-store-pin-property" property definition.
StringPropertyDefinition	getKeyStoreTypePropertyDefinition()	Get the "key-store-type" property definition.
Class<FileBasedKeyManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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 FileBasedKeyManagerProviderCfgDefn getInstance()

Get the File Based Key Manager Provider configuration definition singleton.

Returns:

Returns the File Based Key Manager Provider configuration definition singleton.

createClientConfiguration

public FileBasedKeyManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends FileBasedKeyManagerProviderCfgClient> 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<FileBasedKeyManagerProviderCfgClient,FileBasedKeyManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FileBasedKeyManagerProviderCfgClient,FileBasedKeyManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FileBasedKeyManagerProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FileBasedKeyManagerProviderCfgClient,FileBasedKeyManagerProviderCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the File Based Key Manager Provider is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.

Returns:

Returns the "java-class" property definition.

getKeyStoreFilePropertyDefinition

public StringPropertyDefinition getKeyStoreFilePropertyDefinition()

Get the "key-store-file" property definition.

Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

Changes to this property will take effect the next time that the key manager is accessed.

Returns:

Returns the "key-store-file" property definition.

getKeyStorePinPropertyDefinition

public StringPropertyDefinition getKeyStorePinPropertyDefinition()

Get the "key-store-pin" property definition.

Specifies the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

Returns the "key-store-pin" property definition.

getKeyStorePinEnvironmentVariablePropertyDefinition

public StringPropertyDefinition getKeyStorePinEnvironmentVariablePropertyDefinition()

Get the "key-store-pin-environment-variable" property definition.

Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

Returns the "key-store-pin-environment-variable" property definition.

getKeyStorePinFilePropertyDefinition

public StringPropertyDefinition getKeyStorePinFilePropertyDefinition()

Get the "key-store-pin-file" property definition.

Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

Returns the "key-store-pin-file" property definition.

getKeyStorePinPropertyPropertyDefinition

public StringPropertyDefinition getKeyStorePinPropertyPropertyDefinition()

Get the "key-store-pin-property" property definition.

Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .

Returns:

Returns the "key-store-pin-property" property definition.

getKeyStoreTypePropertyDefinition

public StringPropertyDefinition getKeyStoreTypePropertyDefinition()

Get the "key-store-type" property definition.

Specifies the format for the data in the key store file.

Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well. If no value is provided, the JVM-default value is used. Changes to this configuration attribute will take effect the next time that the key manager is accessed.

Returns:

Returns the "key-store-type" property definition.