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

Interface PKCS11KeyManagerProviderCfg

All Superinterfaces:

Configuration, KeyManagerProviderCfg

public interface PKCS11KeyManagerProviderCfg
extends KeyManagerProviderCfg

A server-side interface for querying 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
void	addPKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener)	Register to be notified when this PKCS11 Key Manager Provider is changed.
Class<? extends PKCS11KeyManagerProviderCfg>	configurationClass()	Gets the configuration class 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	removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener)	Deregister an existing PKCS11 Key Manager Provider configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.KeyManagerProviderCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends PKCS11KeyManagerProviderCfg> configurationClass()

Gets the configuration class associated with this PKCS11 Key Manager Provider.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface KeyManagerProviderCfg

Returns:

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

addPKCS11ChangeListener

void addPKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener)

Register to be notified when this PKCS11 Key Manager Provider is changed.

Parameters:

listener - The PKCS11 Key Manager Provider configuration change listener.

removePKCS11ChangeListener

void removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener)

Deregister an existing PKCS11 Key Manager Provider configuration change listener.

Parameters:

listener - The PKCS11 Key Manager Provider configuration change listener.

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 KeyManagerProviderCfg

Returns:

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

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.

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.

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.

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.