|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileBasedKeyManagerProviderCfg
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 |
---|
java.lang.Class<? extends FileBasedKeyManagerProviderCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface KeyManagerProviderCfg
void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedKeyManagerProviderCfg> listener)
listener
- The File Based Key Manager Provider configuration change listener.void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedKeyManagerProviderCfg> listener)
listener
- The File Based Key Manager Provider configuration change listener.java.lang.String getJavaClass()
The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.
getJavaClass
in interface KeyManagerProviderCfg
java.lang.String getKeyStoreFile()
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.
java.lang.String getKeyStorePin()
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
java.lang.String getKeyStorePinEnvironmentVariable()
Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .
java.lang.String getKeyStorePinFile()
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 .
java.lang.String getKeyStorePinProperty()
Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .
java.lang.String getKeyStoreType()
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |