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

Interface GetSymmetricKeyExtendedOperationHandlerCfgClient

All Superinterfaces:

ConfigurationClient, ExtendedOperationHandlerCfgClient

public interface GetSymmetricKeyExtendedOperationHandlerCfgClient
extends ExtendedOperationHandlerCfgClient

A client-side interface for reading and modifying Get Symmetric Key Extended Operation Handler settings.

The Get Symmetric Key Extended Operation Handler is used by the OpenDJ cryptographic framework for creating and obtaining symmetric encryption keys.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient,? extends GetSymmetricKeyExtendedOperationHandlerCfg>	definition()	Get the configuration definition associated with this Get Symmetric Key Extended Operation Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

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

isEnabled, setEnabled

Method Details

definition

ManagedObjectDefinition<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient,? extends GetSymmetricKeyExtendedOperationHandlerCfg> definition()

Get the configuration definition associated with this Get Symmetric Key Extended Operation Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface ExtendedOperationHandlerCfgClient

Returns:

Returns the configuration definition associated with this Get Symmetric Key Extended Operation Handler.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Get Symmetric Key Extended Operation Handler implementation.

Default value: org.opends.server.crypto.GetSymmetricKeyExtendedOperation

Specified by:

getJavaClass in interface ExtendedOperationHandlerCfgClient

Returns:

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

setJavaClass

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

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Get Symmetric Key Extended Operation Handler implementation.

Specified by:

setJavaClass in interface ExtendedOperationHandlerCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.