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

Interface PKCS11TrustManagerProviderCfg

All Superinterfaces:

Configuration, TrustManagerProviderCfg

public interface PKCS11TrustManagerProviderCfg
extends TrustManagerProviderCfg

A server-side interface for querying PKCS11 Trust Manager Provider settings.

The PKCS11 Trust 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<PKCS11TrustManagerProviderCfg> listener)	Register to be notified when this PKCS11 Trust Manager Provider is changed.
Class<? extends PKCS11TrustManagerProviderCfg>	configurationClass()	Gets the configuration class associated with this PKCS11 Trust Manager Provider.
String	getJavaClass()	Gets the "java-class" property.
String	getTrustStorePin()	Gets the "trust-store-pin" property.
String	getTrustStorePinEnvironmentVariable()	Gets the "trust-store-pin-environment-variable" property.
String	getTrustStorePinFile()	Gets the "trust-store-pin-file" property.
String	getTrustStorePinProperty()	Gets the "trust-store-pin-property" property.
void	removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11TrustManagerProviderCfg> listener)	Deregister an existing PKCS11 Trust 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.TrustManagerProviderCfg

addChangeListener, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends PKCS11TrustManagerProviderCfg> configurationClass()

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

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface TrustManagerProviderCfg

Returns:

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

addPKCS11ChangeListener

void addPKCS11ChangeListener(ConfigurationChangeListener<PKCS11TrustManagerProviderCfg> listener)

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

Parameters:

listener - The PKCS11 Trust Manager Provider configuration change listener.

removePKCS11ChangeListener

void removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11TrustManagerProviderCfg> listener)

Deregister an existing PKCS11 Trust Manager Provider configuration change listener.

Parameters:

listener - The PKCS11 Trust 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 Trust Manager Provider implementation.

Specified by:

getJavaClass in interface TrustManagerProviderCfg

Returns:

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

getTrustStorePin

String getTrustStorePin()

Gets the "trust-store-pin" property.

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

Returns:

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

getTrustStorePinEnvironmentVariable

String getTrustStorePinEnvironmentVariable()

Gets the "trust-store-pin-environment-variable" property.

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

Returns:

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

getTrustStorePinFile

String getTrustStorePinFile()

Gets the "trust-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 Trust Manager Provider .

Returns:

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

getTrustStorePinProperty

String getTrustStorePinProperty()

Gets the "trust-store-pin-property" property.

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

Returns:

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