org.forgerock.opendj.server.config.meta

Class GetSymmetricKeyExtendedOperationHandlerCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient,GetSymmetricKeyExtendedOperationHandlerCfg>

org.forgerock.opendj.server.config.meta.GetSymmetricKeyExtendedOperationHandlerCfgDefn

public final class GetSymmetricKeyExtendedOperationHandlerCfgDefn
extends ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient,GetSymmetricKeyExtendedOperationHandlerCfg>

An interface for querying the Get Symmetric Key Extended Operation Handler managed object definition meta information.

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 and Description
GetSymmetricKeyExtendedOperationHandlerCfgClient	createClientConfiguration(ManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient> impl) Creates a client configuration view of the provided managed object.
GetSymmetricKeyExtendedOperationHandlerCfg	createServerConfiguration(ServerManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static GetSymmetricKeyExtendedOperationHandlerCfgDefn	getInstance() Get the Get Symmetric Key Extended Operation Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
Class<GetSymmetricKeyExtendedOperationHandlerCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static GetSymmetricKeyExtendedOperationHandlerCfgDefn getInstance()

Get the Get Symmetric Key Extended Operation Handler configuration definition singleton.

Returns:

Returns the Get Symmetric Key Extended Operation Handler configuration definition singleton.

createClientConfiguration

public GetSymmetricKeyExtendedOperationHandlerCfgClient createClientConfiguration(ManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient,GetSymmetricKeyExtendedOperationHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public GetSymmetricKeyExtendedOperationHandlerCfg createServerConfiguration(ServerManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient,GetSymmetricKeyExtendedOperationHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<GetSymmetricKeyExtendedOperationHandlerCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient,GetSymmetricKeyExtendedOperationHandlerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Get Symmetric Key Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server).

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.