|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileBasedKeyManagerProviderCfgClient
A client-side interface for reading and modifying 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 | |
---|---|
ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg> |
definition()
Get the configuration definition 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 |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setKeyStoreFile(java.lang.String value)
Sets the "key-store-file" property. |
void |
setKeyStorePin(java.lang.String value)
Sets the "key-store-pin" property. |
void |
setKeyStorePinEnvironmentVariable(java.lang.String value)
Sets the "key-store-pin-environment-variable" property. |
void |
setKeyStorePinFile(java.lang.String value)
Sets the "key-store-pin-file" property. |
void |
setKeyStorePinProperty(java.lang.String value)
Sets the "key-store-pin-property" property. |
void |
setKeyStoreType(java.lang.String value)
Sets the "key-store-type" property. |
Methods inherited from interface org.opends.server.admin.std.client.KeyManagerProviderCfgClient |
---|
isEnabled, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg> definition()
definition
in interface ConfigurationClient
definition
in interface KeyManagerProviderCfgClient
java.lang.String getJavaClass()
The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.
getJavaClass
in interface KeyManagerProviderCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
The fully-qualified name of the Java class that provides the File Based Key Manager Provider implementation.
setJavaClass
in interface KeyManagerProviderCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setKeyStoreFile(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "key-store-file" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getKeyStorePin()
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
void setKeyStorePin(java.lang.String value) throws IllegalPropertyValueException
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
value
- The value of the "key-store-pin" property.
IllegalPropertyValueException
- If the new value is invalid.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 .
void setKeyStorePinEnvironmentVariable(java.lang.String value) throws IllegalPropertyValueException
Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Key Manager Provider .
value
- The value of the "key-store-pin-environment-variable" property.
IllegalPropertyValueException
- If the new value is invalid.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 .
void setKeyStorePinFile(java.lang.String value) throws IllegalPropertyValueException
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 .
value
- The value of the "key-store-pin-file" property.
IllegalPropertyValueException
- If the new value is invalid.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 .
void setKeyStorePinProperty(java.lang.String value) throws IllegalPropertyValueException
Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Key Manager Provider .
value
- The value of the "key-store-pin-property" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setKeyStoreType(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "key-store-type" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |