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

Interface PKCS11KeyManagerProviderCfgClient

All Superinterfaces:

ConfigurationClient, KeyManagerProviderCfgClient

public interface PKCS11KeyManagerProviderCfgClient
extends KeyManagerProviderCfgClient

A client-side interface for reading and modifying PKCS11 Key Manager Provider settings.

The PKCS11 Key Manager Provider enables the server to access the private key information through the PKCS11 interface.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends PKCS11KeyManagerProviderCfgClient,? extends PKCS11KeyManagerProviderCfg>	definition()	Get the configuration definition associated with this PKCS11 Key Manager Provider.
String	getJavaClass()	Gets the "java-class" property.
String	getKeyStorePin()	Gets the "key-store-pin" property.
String	getKeyStorePinEnvironmentVariable()	Gets the "key-store-pin-environment-variable" property.
String	getKeyStorePinFile()	Gets the "key-store-pin-file" property.
String	getKeyStorePinProperty()	Gets the "key-store-pin-property" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setKeyStorePin(String value)	Sets the "key-store-pin" property.
void	setKeyStorePinEnvironmentVariable(String value)	Sets the "key-store-pin-environment-variable" property.
void	setKeyStorePinFile(String value)	Sets the "key-store-pin-file" property.
void	setKeyStorePinProperty(String value)	Sets the "key-store-pin-property" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.KeyManagerProviderCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends PKCS11KeyManagerProviderCfgClient,? extends PKCS11KeyManagerProviderCfg> definition()

Get the configuration definition associated with this PKCS11 Key Manager Provider.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface KeyManagerProviderCfgClient

Returns:

Returns the configuration definition associated with this PKCS11 Key Manager Provider.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

The fully-qualified name of the Java class that provides the PKCS11 Key Manager Provider implementation.

Specified by:

getJavaClass in interface KeyManagerProviderCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

The fully-qualified name of the Java class that provides the PKCS11 Key Manager Provider implementation.

Specified by:

setJavaClass in interface KeyManagerProviderCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getKeyStorePin

String getKeyStorePin()

Gets the "key-store-pin" property.

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

Returns:

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

setKeyStorePin

void setKeyStorePin(String value)
             throws PropertyException

Sets the "key-store-pin" property.

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

Parameters:

value - The value of the "key-store-pin" property.

Throws:

PropertyException - If the new value is invalid.

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 PKCS11 Key Manager Provider .

Returns:

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

setKeyStorePinEnvironmentVariable

void setKeyStorePinEnvironmentVariable(String value)
                                throws PropertyException

Sets the "key-store-pin-environment-variable" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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 PKCS11 Key Manager Provider .

Returns:

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

setKeyStorePinFile

void setKeyStorePinFile(String value)
                 throws PropertyException

Sets 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 PKCS11 Key Manager Provider .

Parameters:

value - The value of the "key-store-pin-file" property.

Throws:

PropertyException - If the new value is invalid.

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 PKCS11 Key Manager Provider .

Returns:

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

setKeyStorePinProperty

void setKeyStorePinProperty(String value)
                     throws PropertyException

Sets the "key-store-pin-property" property.

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

Parameters:

value - The value of the "key-store-pin-property" property.

Throws:

PropertyException - If the new value is invalid.