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

Interface TrustStoreBackendCfg

  • All Superinterfaces:
    BackendCfg, Configuration, LocalBackendCfg
    public interface TrustStoreBackendCfg
extends LocalBackendCfg
    A server-side interface for querying Trust Store Backend settings.

    The Trust Store Backend provides an LDAP view of a file-based trust store. It is used by the administrative cryptographic framework.

    • Method Detail

      • addTrustStoreChangeListener

        void addTrustStoreChangeListener​(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
        Register to be notified when this Trust Store Backend is changed.
        Parameters:
        listener - The Trust Store Backend configuration change listener.

      • removeTrustStoreChangeListener

        void removeTrustStoreChangeListener​(ConfigurationChangeListener<TrustStoreBackendCfg> listener)
        Deregister an existing Trust Store Backend configuration change listener.
        Parameters:
        listener - The Trust Store Backend configuration change listener.

      • getJavaClass

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

        Specifies the fully-qualified name of the Java class that provides the backend implementation.

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

      • getTrustStoreFile

        String getTrustStoreFile()
        Gets the "trust-store-file" property.

        Specifies the path to the file that stores the trust information.

        It may be an absolute path, or a path that is relative to the OpenDJ instance root.

        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 Trust Store Backend .

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

      • getTrustStorePinEnvironmentVariable

        String getTrustStorePinEnvironmentVariable()
        Gets the "trust-store-pin-environment-variable" property.

        Specifies the name of the environment variable that contains the clear-text PIN needed to access the Trust Store Backend .

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

      • getTrustStorePinFile

        String getTrustStorePinFile()
        Gets the "trust-store-pin-file" property.

        Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the Trust Store Backend .

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

      • getTrustStorePinProperty

        String getTrustStorePinProperty()
        Gets the "trust-store-pin-property" property.

        Specifies the name of the Java property that contains the clear-text PIN needed to access the Trust Store Backend .

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

      • getTrustStoreType

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

        Specifies the format for the data in the key store file.

        Valid values should always include 'JKS' and 'PKCS12', but different implementations may allow other values as well.

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