Interface FileBasedTrustManagerProviderCfgClient

All Superinterfaces:
ConfigurationClient, TrustManagerProviderCfgClient
public interface FileBasedTrustManagerProviderCfgClient extends TrustManagerProviderCfgClient
A client-side interface for reading and modifying File Based Trust Manager Provider settings.

The file-based trust manager provider obtains the trusted certificates from a trust store file.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends FileBasedTrustManagerProviderCfgClient, ? extends FileBasedTrustManagerProviderCfg> definition()
      Get the configuration definition associated with this File Based Trust Manager Provider.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface TrustManagerProviderCfgClient
      Returns:
      Returns the configuration definition associated with this File Based Trust Manager Provider.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      The fully-qualified name of the Java class that provides the File Based Trust Manager Provider implementation.

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

      Specified by:
      getJavaClass in interface TrustManagerProviderCfgClient
      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 File Based Trust Manager Provider implementation.

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

    • getProviderArg

      ValueOrExpression<String> getProviderArg()
      Gets the "provider-arg" property.

      The argument passed to configure the trust store security provider.

      The security 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 "provider-arg" property.

    • setProviderArg

      void setProviderArg(ValueOrExpression<String> value) throws PropertyException
      Sets the "provider-arg" property.

      The argument passed to configure the trust store security provider.

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

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

    • getProviderClass

      ValueOrExpression<String> getProviderClass()
      Gets the "provider-class" property.

      The class of the trust store security provider.

      The Java class that implements the trust store security provider, such as "sun.security.pkcs11.SunPKCS11".

      Default value is undefined

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

    • setProviderClass

      void setProviderClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "provider-class" property.

      The class of the trust store security provider.

      The Java class that implements the trust store security provider, such as "sun.security.pkcs11.SunPKCS11".

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

    • getProviderName

      ValueOrExpression<String> getProviderName()
      Gets the "provider-name" property.

      The name of the trust store security 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 "provider-name" property.

    • setProviderName

      void setProviderName(ValueOrExpression<String> value) throws PropertyException
      Sets the "provider-name" property.

      The name of the trust store security 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 "provider-name" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getTrustStoreFile

      @MandatoryProperty ValueOrExpression<Path> getTrustStoreFile()
      Gets the "trust-store-file" property.

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

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

      Returns:
      Returns the value of the "trust-store-file" property.

    • setTrustStoreFile

      @MandatoryProperty void setTrustStoreFile(ValueOrExpression<Path> value) throws PropertyException
      Sets the "trust-store-file" property.

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

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

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

    • getTrustStorePin

      ValueOrExpression<String> getTrustStorePin()
      Gets the "trust-store-pin" property.

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

      Default value is undefined

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

    • setTrustStorePin

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

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

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

    • getTrustStoreType

      ValueOrExpression<String> getTrustStoreType()
      Gets the "trust-store-type" property.

      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 value of the "trust-store-type" property.

    • setTrustStoreType

      void setTrustStoreType(ValueOrExpression<String> value) throws PropertyException
      Sets the "trust-store-type" property.

      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.

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