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

Interface Pkcs11KeyManagerProviderCfg

All Superinterfaces:
Configuration, KeyManagerProviderCfg
public interface Pkcs11KeyManagerProviderCfg extends KeyManagerProviderCfg
A server-side interface for querying PKCS#11 Key Manager Provider settings.

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

  • Method Details

    • configurationClass

      Class<? extends Pkcs11KeyManagerProviderCfg> configurationClass()
      Gets the configuration class associated with this PKCS#11 Key Manager Provider.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface KeyManagerProviderCfg
      Returns:
      Returns the configuration class associated with this PKCS#11 Key Manager Provider.

    • addPkcs11ChangeListener

      void addPkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
      Register to be notified when this PKCS#11 Key Manager Provider is changed.
      Parameters:
      listener - The PKCS#11 Key Manager Provider configuration change listener.

    • removePkcs11ChangeListener

      void removePkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
      Deregister an existing PKCS#11 Key Manager Provider configuration change listener.
      Parameters:
      listener - The PKCS#11 Key Manager Provider configuration change listener.

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

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

      Default value: org.opends.server.extensions.PKCS11KeyManagerProvider

      Specified by:
      getJavaClass in interface KeyManagerProviderCfg
      Returns:
      Returns the value of the "java-class" property.

    • getKeyStorePin

      String getKeyStorePin()
      Gets the "key-store-pin" property.

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

      Default value is undefined

      Returns:
      Returns the value of the "key-store-pin" property.

    • getKeyStoreType

      String getKeyStoreType()
      Gets the "key-store-type" property.

      The type of the PKCS#11 key manager.

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

      Default value: PKCS11

      Returns:
      Returns the value of the "key-store-type" property.

    • getPkcs11ProviderArg

      String getPkcs11ProviderArg()
      Gets the "pkcs11-provider-arg" property.

      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.

      Default value is undefined

      Returns:
      Returns the value of the "pkcs11-provider-arg" property.

    • getPkcs11ProviderClass

      String getPkcs11ProviderClass()
      Gets the "pkcs11-provider-class" property.

      The class of the PKCS#11 provider.

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

      Default value is undefined

      Returns:
      Returns the value of the "pkcs11-provider-class" property.

    • getPkcs11ProviderName

      String getPkcs11ProviderName()
      Gets the "pkcs11-provider-name" property.

      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".

      Default value is undefined

      Returns:
      Returns the value of the "pkcs11-provider-name" property.