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

Class Pkcs11TrustManagerProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<Pkcs11TrustManagerProviderCfgClient,Pkcs11TrustManagerProviderCfg>

org.forgerock.opendj.server.config.meta.Pkcs11TrustManagerProviderCfgDefn

public final class Pkcs11TrustManagerProviderCfgDefn
extends ManagedObjectDefinition<Pkcs11TrustManagerProviderCfgClient,Pkcs11TrustManagerProviderCfg>

An interface for querying the PKCS#11 Trust Manager Provider managed object definition meta information.

The PKCS#11 Trust Manager Provider enables the server to manage trust information through the PKCS11 interface

Method Summary

Modifier and Type	Method	Description
Pkcs11TrustManagerProviderCfgClient	createClientConfiguration(ManagedObject<? extends Pkcs11TrustManagerProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
Pkcs11TrustManagerProviderCfg	createServerConfiguration(ServerManagedObject<? extends Pkcs11TrustManagerProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static Pkcs11TrustManagerProviderCfgDefn	getInstance()	Get the PKCS#11 Trust Manager Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getPkcs11ProviderArgPropertyDefinition()	Get the "pkcs11-provider-arg" property definition.
StringPropertyDefinition	getPkcs11ProviderClassPropertyDefinition()	Get the "pkcs11-provider-class" property definition.
StringPropertyDefinition	getPkcs11ProviderNamePropertyDefinition()	Get the "pkcs11-provider-name" property definition.
Class<Pkcs11TrustManagerProviderCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTrustStorePinPropertyDefinition()	Get the "trust-store-pin" 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, 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 Detail

getInstance

public static Pkcs11TrustManagerProviderCfgDefn getInstance()

Get the PKCS#11 Trust Manager Provider configuration definition singleton.

Returns:

Returns the PKCS#11 Trust Manager Provider configuration definition singleton.

createClientConfiguration

public Pkcs11TrustManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends Pkcs11TrustManagerProviderCfgClient> 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<Pkcs11TrustManagerProviderCfgClient,Pkcs11TrustManagerProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<Pkcs11TrustManagerProviderCfgClient,Pkcs11TrustManagerProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<Pkcs11TrustManagerProviderCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<Pkcs11TrustManagerProviderCfgClient,Pkcs11TrustManagerProviderCfg>

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 PKCS#11 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 PKCS#11 Trust Manager Provider implementation.

Returns:

Returns the "java-class" property definition.

getPkcs11ProviderArgPropertyDefinition

public StringPropertyDefinition getPkcs11ProviderArgPropertyDefinition()

Get the "pkcs11-provider-arg" property definition.

The argument passed to configure the PKCS#11 provider.

The provider argument is often a path to a properties file which contains the detailed configuration of the provider.

Returns:

Returns the "pkcs11-provider-arg" property definition.

getPkcs11ProviderClassPropertyDefinition

public StringPropertyDefinition getPkcs11ProviderClassPropertyDefinition()

Get the "pkcs11-provider-class" property definition.

The class of the PKCS#11 provider.

The main Java class implementing the PKCS#11 provider, such as "sun.security.pkcs11.SunPKCS11".

Returns:

Returns the "pkcs11-provider-class" property definition.

getPkcs11ProviderNamePropertyDefinition

public StringPropertyDefinition getPkcs11ProviderNamePropertyDefinition()

Get the "pkcs11-provider-name" property definition.

The name of the PKCS#11 provider.

The provider name is usually the name used in the java.security file's "security.provider" list, such as "SunPKCS11".

Returns:

Returns the "pkcs11-provider-name" property definition.

getTrustStorePinPropertyDefinition

public StringPropertyDefinition getTrustStorePinPropertyDefinition()

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

Specifies the clear-text PIN needed to access the PKCS#11 Trust Manager Provider .

Returns:

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

getTrustStoreTypePropertyDefinition

public StringPropertyDefinition getTrustStoreTypePropertyDefinition()

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

The type of the PKCS#11 trust manager.

. If no type is specified, the default value of "PKCS11" will be used.

Returns:

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