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

Interface FileBasedTrustManagerProviderCfg

All Superinterfaces:
Configuration, TrustManagerProviderCfg
public interface FileBasedTrustManagerProviderCfg extends TrustManagerProviderCfg
A server-side interface for querying File Based Trust Manager Provider settings.

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

  • Method Details

    • configurationClass

      Class<? extends FileBasedTrustManagerProviderCfg> configurationClass()
      Gets the configuration class associated with this File Based Trust Manager Provider.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface TrustManagerProviderCfg
      Returns:
      Returns the configuration class associated with this File Based Trust Manager Provider.

    • addFileBasedChangeListener

      void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
      Register to be notified when this File Based Trust Manager Provider is changed.
      Parameters:
      listener - The File Based Trust Manager Provider configuration change listener.

    • removeFileBasedChangeListener

      void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener)
      Deregister an existing File Based Trust Manager Provider configuration change listener.
      Parameters:
      listener - The File Based Trust Manager Provider configuration change listener.

    • getJavaClass

      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 TrustManagerProviderCfg
      Returns:
      Returns the value of the "java-class" property.

    • getTrustStoreFile

      String 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 OpenDJ instance root.

      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.

    • getTrustStorePin

      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.

    • getTrustStoreType

      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.

      Default value is undefined

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