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

Interface SaslMechanismHandlerCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

AnonymousSaslMechanismHandlerCfgClient, CramMd5SaslMechanismHandlerCfgClient, DigestMd5SaslMechanismHandlerCfgClient, ExternalSaslMechanismHandlerCfgClient, GssapiSaslMechanismHandlerCfgClient, PlainSaslMechanismHandlerCfgClient, ScramSha256SaslMechanismHandlerCfgClient, ScramSha512SaslMechanismHandlerCfgClient

public interface SaslMechanismHandlerCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying SASL Mechanism Handler settings.

The SASL mechanism handler configuration entry is the parent for all SASL mechanism handlers defined in the OpenDJ directory server.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends SaslMechanismHandlerCfgClient,? extends SaslMechanismHandlerCfg>	definition()	Get the configuration definition associated with this SASL Mechanism 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 Detail

definition

ManagedObjectDefinition<? extends SaslMechanismHandlerCfgClient,? extends SaslMechanismHandlerCfg> definition()

Get the configuration definition associated with this SASL Mechanism Handler.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this SASL Mechanism Handler.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the SASL mechanism handler 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 SASL mechanism handler 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.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism 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 SASL mechanism handler implementation.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.