Interface Pkcs11KeyManagerProviderCfg
-
- All Superinterfaces:
Configuration
,KeyManagerProviderCfg
public interface Pkcs11KeyManagerProviderCfg extends KeyManagerProviderCfg
A server-side interface for querying PKCS#11 Key Manager Provider settings.The PKCS#11 Key Manager Provider enables the server to access the private key information through the PKCS11 interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
Register to be notified when this PKCS#11 Key Manager Provider is changed.Class<? extends Pkcs11KeyManagerProviderCfg>
configurationClass()
Gets the configuration class associated with this PKCS#11 Key Manager Provider.String
getJavaClass()
Gets the "java-class" property.String
getKeyStorePin()
Gets the "key-store-pin" property.String
getKeyStoreType()
Gets the "key-store-type" property.void
removePkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
Deregister an existing PKCS#11 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 PKCS#11 Key Manager Provider.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceKeyManagerProviderCfg
- Returns:
- Returns the configuration class associated with this PKCS#11 Key Manager Provider.
-
addPkcs11ChangeListener
void addPkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
Register to be notified when this PKCS#11 Key Manager Provider is changed.- Parameters:
listener
- The PKCS#11 Key Manager Provider configuration change listener.
-
removePkcs11ChangeListener
void removePkcs11ChangeListener(ConfigurationChangeListener<Pkcs11KeyManagerProviderCfg> listener)
Deregister an existing PKCS#11 Key Manager Provider configuration change listener.- Parameters:
listener
- The PKCS#11 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 PKCS#11 Key Manager Provider implementation.
Default value:
org.opends.server.extensions.PKCS11KeyManagerProvider
- Specified by:
getJavaClass
in interfaceKeyManagerProviderCfg
- 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 PKCS#11 Key Manager Provider .
Default value is undefined
- Returns:
- Returns the value of the "key-store-pin" property.
-
getKeyStoreType
String getKeyStoreType()
Gets the "key-store-type" property.Specifies the type of PKCS#11 key manager, when the specific name must be explicit.
. If no type is specified, the default value of "PKCS11" will be used.
Default value:
PKCS11
- Returns:
- Returns the value of the "key-store-type" property.
-
-