org.opends.server.admin.std.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 Summary
 void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedKeyManagerProviderCfg> listener)
          Register to be notified when this File Based Key Manager Provider is changed.
 java.lang.Class<? extends FileBasedKeyManagerProviderCfg> configurationClass()
          Gets the configuration class associated with this File Based Key Manager Provider.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getKeyStoreFile()
          Gets the "key-store-file" property.
 java.lang.String getKeyStorePin()
          Gets the "key-store-pin" property.
 java.lang.String getKeyStorePinEnvironmentVariable()
          Gets the "key-store-pin-environment-variable" property.
 java.lang.String getKeyStorePinFile()
          Gets the "key-store-pin-file" property.
 java.lang.String getKeyStorePinProperty()
          Gets the "key-store-pin-property" property.
 java.lang.String getKeyStoreType()
          Gets the "key-store-type" property.
 void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedKeyManagerProviderCfg> listener)
          Deregister an existing File Based Key Manager Provider configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.KeyManagerProviderCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends FileBasedKeyManagerProviderCfg> configurationClass()
Gets the configuration class associated with this File Based Key Manager Provider.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface KeyManagerProviderCfg
Returns:
Returns the configuration class associated with this File Based Key Manager Provider.

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

java.lang.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

java.lang.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 OpenDS Directory Server 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

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.lang.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.