public interface FileBasedKeyManagerProviderCfgClient extends KeyManagerProviderCfgClient
The File Based Key Manager Provider can be used to obtain the server certificate from a key store file on the local file system.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg> |
definition()
Get the configuration definition associated with this File Based Key Manager Provider.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getKeyStoreFile()
Gets the "key-store-file" property.
|
ValueOrExpression<String> |
getKeyStorePin()
Gets the "key-store-pin" property.
|
ValueOrExpression<String> |
getKeyStoreType()
Gets the "key-store-type" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setKeyStoreFile(ValueOrExpression<String> value)
Sets the "key-store-file" property.
|
void |
setKeyStorePin(ValueOrExpression<String> value)
Sets the "key-store-pin" property.
|
void |
setKeyStoreType(ValueOrExpression<String> value)
Sets the "key-store-type" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends FileBasedKeyManagerProviderCfgClient,? extends FileBasedKeyManagerProviderCfg> definition()
definition
in interface ConfigurationClient
definition
in interface KeyManagerProviderCfgClient
ValueOrExpression<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(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.ValueOrExpression<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 OpenDJ instance root.
Changes to this property will take effect the next time that the key manager is accessed.
void setKeyStoreFile(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "key-store-file" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getKeyStorePin()
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
void setKeyStorePin(ValueOrExpression<String> value) throws PropertyException
Specifies the clear-text PIN needed to access the File Based Key Manager Provider .
value
- The value of the "key-store-pin" property.PropertyException
- If the new value is invalid.ValueOrExpression<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(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.