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

Interface Pkcs11KeyManagerProviderCfgClient

All Superinterfaces:
ConfigurationClient, KeyManagerProviderCfgClient
public interface Pkcs11KeyManagerProviderCfgClient extends KeyManagerProviderCfgClient
A client-side interface for reading and modifying 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

    • definition

      ManagedObjectDefinition<? extends Pkcs11KeyManagerProviderCfgClient,? extends Pkcs11KeyManagerProviderCfg> definition()
      Get the configuration definition associated with this PKCS#11 Key Manager Provider.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface KeyManagerProviderCfgClient
      Returns:
      Returns the configuration definition associated with this PKCS#11 Key Manager Provider.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<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 KeyManagerProviderCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

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

      Specified by:
      setJavaClass in interface KeyManagerProviderCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getKeyStorePin

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

    • setKeyStorePin

      void setKeyStorePin(ValueOrExpression<String> value) throws PropertyException
      Sets the "key-store-pin" property.

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

      Parameters:
      value - The value of the "key-store-pin" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getKeyStoreType

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

    • setKeyStoreType

      void setKeyStoreType(ValueOrExpression<String> value) throws PropertyException
      Sets 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.

      Parameters:
      value - The value of the "key-store-type" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getPkcs11ProviderArg

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

    • setPkcs11ProviderArg

      void setPkcs11ProviderArg(ValueOrExpression<String> value) throws PropertyException
      Sets 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.

      Parameters:
      value - The value of the "pkcs11-provider-arg" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getPkcs11ProviderClass

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

    • setPkcs11ProviderClass

      void setPkcs11ProviderClass(ValueOrExpression<String> value) throws PropertyException
      Sets 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".

      Parameters:
      value - The value of the "pkcs11-provider-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getPkcs11ProviderName

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

    • setPkcs11ProviderName

      void setPkcs11ProviderName(ValueOrExpression<String> value) throws PropertyException
      Sets 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".

      Parameters:
      value - The value of the "pkcs11-provider-name" property.
      Throws:
      PropertyException - If the new value is invalid.