org.opends.server.admin.std.client

Interface SASLMechanismHandlerCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

AnonymousSASLMechanismHandlerCfgClient, CramMD5SASLMechanismHandlerCfgClient, DigestMD5SASLMechanismHandlerCfgClient, ExternalSASLMechanismHandlerCfgClient, GSSAPISASLMechanismHandlerCfgClient, PlainSASLMechanismHandlerCfgClient

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

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends SASLMechanismHandlerCfgClient,? extends SASLMechanismHandlerCfg>	definition() Get the configuration definition associated with this SASL Mechanism Handler.
String	getJavaClass() Gets the "java-class" property.
Boolean	isEnabled() Gets the "enabled" property.
void	setEnabled(boolean value) Sets the "enabled" property.
void	setJavaClass(String value) Sets the "java-class" property.

Methods inherited from interface org.opends.server.admin.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

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

void setEnabled(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

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

void setJavaClass(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.