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

Interface KeyManagerProviderCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

FileBasedKeyManagerProviderCfgClient, LdapKeyManagerProviderCfgClient, PemKeyManagerProviderCfgClient, Pkcs11KeyManagerProviderCfgClient

public interface KeyManagerProviderCfgClient
extends ConfigurationClient

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

Key Manager Providers are responsible for managing the key material that is used to authenticate an SSL connection to its peer.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends KeyManagerProviderCfgClient,? extends KeyManagerProviderCfg>	definition()	Get the configuration definition associated with this Key Manager Provider.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Details

definition

ManagedObjectDefinition<? extends KeyManagerProviderCfgClient,? extends KeyManagerProviderCfg> definition()

Get the configuration definition associated with this Key Manager Provider.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Key Manager Provider.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the Key Manager Provider is enabled for use.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the Key Manager Provider is enabled for use.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.