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

Class Pkcs11KeyManagerProviderCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<Pkcs11KeyManagerProviderCfgClient,Pkcs11KeyManagerProviderCfg>
org.forgerock.opendj.server.config.meta.Pkcs11KeyManagerProviderCfgDefn
public final class Pkcs11KeyManagerProviderCfgDefn extends ManagedObjectDefinition<Pkcs11KeyManagerProviderCfgClient,Pkcs11KeyManagerProviderCfg>
An interface for querying the PKCS#11 Key Manager Provider managed object definition meta information.

The PKCS#11 Key Manager Provider enables the server to access the private key information through the PKCS11 interface.

  • Method Details

    • getInstance

      public static Pkcs11KeyManagerProviderCfgDefn getInstance()
      Get the PKCS#11 Key Manager Provider configuration definition singleton.
      Returns:
      Returns the PKCS#11 Key Manager Provider configuration definition singleton.

    • createClientConfiguration

      public Pkcs11KeyManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends Pkcs11KeyManagerProviderCfgClient> 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<Pkcs11KeyManagerProviderCfgClient,Pkcs11KeyManagerProviderCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public Pkcs11KeyManagerProviderCfg createServerConfiguration(ServerManagedObject<? extends Pkcs11KeyManagerProviderCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<Pkcs11KeyManagerProviderCfgClient,Pkcs11KeyManagerProviderCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<Pkcs11KeyManagerProviderCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<Pkcs11KeyManagerProviderCfgClient,Pkcs11KeyManagerProviderCfg>
      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 PKCS#11 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 PKCS#11 Key Manager Provider implementation.

      Returns:
      Returns the "java-class" property definition.

    • getKeyStorePinPropertyDefinition

      public StringPropertyDefinition getKeyStorePinPropertyDefinition()
      Get the "key-store-pin" property definition.

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

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

    • getKeyStoreTypePropertyDefinition

      public StringPropertyDefinition getKeyStoreTypePropertyDefinition()
      Get the "key-store-type" property definition.

      The type of the PKCS#11 key manager.

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

      Returns:
      Returns the "key-store-type" 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.