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

Class PemKeyManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<PemKeyManagerProviderCfgClient,PemKeyManagerProviderCfg>

org.forgerock.opendj.server.config.meta.PemKeyManagerProviderCfgDefn

public final class PemKeyManagerProviderCfgDefn
extends ManagedObjectDefinition<PemKeyManagerProviderCfgClient,PemKeyManagerProviderCfg>

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

The Pem Key Manager Provider obtains TLS and master keys from PEM files in a file system directory.

Method Summary

Modifier and Type	Method	Description
PemKeyManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends PemKeyManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
PemKeyManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends PemKeyManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
StringPropertyDefinition	getExcludedFilenamePatternPropertyDefinition()	Get the "excluded-filename-pattern" property definition.
static PemKeyManagerProviderCfgDefn	getInstance()	Get the Pem Key Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getPemDirectoryPropertyDefinition()	Get the "pem-directory" property definition.
Class<PemKeyManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 Details

getInstance

public static PemKeyManagerProviderCfgDefn getInstance()

Get the Pem Key Manager Provider configuration definition singleton.

Returns:

Returns the Pem Key Manager Provider configuration definition singleton.

createClientConfiguration

public PemKeyManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends PemKeyManagerProviderCfgClient> 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<PemKeyManagerProviderCfgClient,PemKeyManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<PemKeyManagerProviderCfgClient,PemKeyManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<PemKeyManagerProviderCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<PemKeyManagerProviderCfgClient,PemKeyManagerProviderCfg>

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 Pem Key Manager Provider is enabled for use.

Returns:

Returns the "enabled" property definition.

getExcludedFilenamePatternPropertyDefinition

public StringPropertyDefinition getExcludedFilenamePatternPropertyDefinition()

Get the "excluded-filename-pattern" property definition.

The set of file name patterns identifying files to be excluded from the Pem Key Manager Provider.

Hidden files will always be excluded. File name patterns use the "glob" syntax defined by the Java "java.nio.file.FileSystem.getPathMatcher" method.

Returns:

Returns the "excluded-filename-pattern" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getPemDirectoryPropertyDefinition

public StringPropertyDefinition getPemDirectoryPropertyDefinition()

Get the "pem-directory" property definition.

Specifies the path to a directory containing PEM files. It can be an absolute path or a path that is relative to the OpenDJ instance root. The same directory may also be used for a PEM trust manager provider.

Returns:

Returns the "pem-directory" property definition.