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

Class FileBasedTrustManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient,FileBasedTrustManagerProviderCfg>

org.forgerock.opendj.server.config.meta.FileBasedTrustManagerProviderCfgDefn

public final class FileBasedTrustManagerProviderCfgDefn
extends ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient,FileBasedTrustManagerProviderCfg>

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

The file-based trust manager provider determines whether to trust a presented certificate based on whether that certificate exists in a server trust store file.

Method Summary

Modifier and Type	Method	Description
FileBasedTrustManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends FileBasedTrustManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
FileBasedTrustManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends FileBasedTrustManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static FileBasedTrustManagerProviderCfgDefn	getInstance()	Get the File Based Trust Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<FileBasedTrustManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTrustStoreFilePropertyDefinition()	Get the "trust-store-file" property definition.
StringPropertyDefinition	getTrustStorePinEnvironmentVariablePropertyDefinition()	Get the "trust-store-pin-environment-variable" property definition.
StringPropertyDefinition	getTrustStorePinFilePropertyDefinition()	Get the "trust-store-pin-file" property definition.
StringPropertyDefinition	getTrustStorePinPropertyDefinition()	Get the "trust-store-pin" property definition.
StringPropertyDefinition	getTrustStorePinPropertyPropertyDefinition()	Get the "trust-store-pin-property" property definition.
StringPropertyDefinition	getTrustStoreTypePropertyDefinition()	Get the "trust-store-type" 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 FileBasedTrustManagerProviderCfgDefn getInstance()

Get the File Based Trust Manager Provider configuration definition singleton.

Returns:

Returns the File Based Trust Manager Provider configuration definition singleton.

createClientConfiguration

public FileBasedTrustManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends FileBasedTrustManagerProviderCfgClient> 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<FileBasedTrustManagerProviderCfgClient,FileBasedTrustManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient,FileBasedTrustManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FileBasedTrustManagerProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient,FileBasedTrustManagerProviderCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicate whether the File Based Trust 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 Trust Manager Provider implementation.

Returns:

Returns the "java-class" property definition.

getTrustStoreFilePropertyDefinition

public StringPropertyDefinition getTrustStoreFilePropertyDefinition()

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

Specifies the path to the file containing the trust information. It can be an absolute path or a path that is relative to the OpenDJ instance root.

Changes to this configuration attribute take effect the next time that the trust manager is accessed.

Returns:

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

getTrustStorePinPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyDefinition()

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

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

Returns:

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

getTrustStorePinEnvironmentVariablePropertyDefinition

public StringPropertyDefinition getTrustStorePinEnvironmentVariablePropertyDefinition()

Get the "trust-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 Trust Manager Provider .

Returns:

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

getTrustStorePinFilePropertyDefinition

public StringPropertyDefinition getTrustStorePinFilePropertyDefinition()

Get the "trust-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 Trust Manager Provider .

Returns:

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

getTrustStorePinPropertyPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyPropertyDefinition()

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

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

Returns:

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

getTrustStoreTypePropertyDefinition

public StringPropertyDefinition getTrustStoreTypePropertyDefinition()

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

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

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

Returns:

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