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

Interface ExtendedOperationHandlerCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

CancelExtendedOperationHandlerCfgClient, GetConnectionIdExtendedOperationHandlerCfgClient, GetSymmetricKeyExtendedOperationHandlerCfgClient, PasswordModifyExtendedOperationHandlerCfgClient, PasswordPolicyStateExtendedOperationHandlerCfgClient, StartTlsExtendedOperationHandlerCfgClient, WhoAmIExtendedOperationHandlerCfgClient

public interface ExtendedOperationHandlerCfgClient
extends ConfigurationClient

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

Extended Operation Handlers processes the different types of extended operations in the server.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ExtendedOperationHandlerCfgClient,? extends ExtendedOperationHandlerCfg>	definition()	Get the configuration definition associated with this Extended Operation Handler.
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 ExtendedOperationHandlerCfgClient,? extends ExtendedOperationHandlerCfg> definition()

Get the configuration definition associated with this Extended Operation Handler.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Extended Operation Handler.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

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

Returns:

Returns the value of the "enabled" property.

setEnabled

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

Sets the "enabled" property.

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

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.

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

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 Extended Operation Handler implementation.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.