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

Interface FileBasedKeyManagerProviderCfg

  • All Superinterfaces:
    Configuration, KeyManagerProviderCfg
    public interface FileBasedKeyManagerProviderCfg
extends KeyManagerProviderCfg
    A server-side interface for querying File Based Key Manager Provider settings.

    The File Based Key Manager Provider can be used to obtain the server certificate from a key store file on the local file system.

    • Method Detail

      • addFileBasedChangeListener

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

      • removeFileBasedChangeListener

        void removeFileBasedChangeListener​(ConfigurationChangeListener<FileBasedKeyManagerProviderCfg> listener)
        Deregister an existing File Based Key Manager Provider configuration change listener.
        Parameters:
        listener - The File Based 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 File Based Key Manager Provider implementation.

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

      • getKeyStoreFile

        String getKeyStoreFile()
        Gets the "key-store-file" property.

        Specifies the path to the file that contains the private key information. This may be an absolute path, or a path that is relative to the OpenDJ instance root.

        Changes to this property will take effect the next time that the key manager is accessed.

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

      • getKeyStorePin

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

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

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

      • getKeyStorePinEnvironmentVariable

        String getKeyStorePinEnvironmentVariable()
        Gets the "key-store-pin-environment-variable" property.

        Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .

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

      • getKeyStorePinFile

        String getKeyStorePinFile()
        Gets the "key-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 File Based Key Manager Provider .

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

      • getKeyStorePinProperty

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

        Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .

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

      • getKeyStoreType

        String getKeyStoreType()
        Gets the "key-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. If no value is provided, the JVM-default value is used. Changes to this configuration attribute will take effect the next time that the key manager is accessed.

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