org.opends.server.admin.std.client
Interface CramMD5SASLMechanismHandlerCfgClient

All Superinterfaces:
ConfigurationClient, SASLMechanismHandlerCfgClient

public interface CramMD5SASLMechanismHandlerCfgClient
extends SASLMechanismHandlerCfgClient

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

The CRAM-MD5 SASL mechanism provides the ability for clients to perform password-based authentication in a manner that does not expose their password in the clear.


Method Summary
 ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient,? extends CramMD5SASLMechanismHandlerCfg> definition()
          Get the configuration definition associated with this Cram MD5 SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setIdentityMapper(java.lang.String value)
          Sets the "identity-mapper" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.std.client.SASLMechanismHandlerCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient,? extends CramMD5SASLMechanismHandlerCfg> definition()
Get the configuration definition associated with this Cram MD5 SASL Mechanism Handler.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface SASLMechanismHandlerCfgClient
Returns:
Returns the configuration definition associated with this Cram MD5 SASL Mechanism Handler.

getIdentityMapper

java.lang.String getIdentityMapper()
Gets the "identity-mapper" property.

Specifies the name of the identity mapper used with this SASL mechanism handler to match the authentication ID included in the SASL bind request to the corresponding user in the directory.

Returns:
Returns the value of the "identity-mapper" property.

setIdentityMapper

void setIdentityMapper(java.lang.String value)
                       throws IllegalPropertyValueException
Sets the "identity-mapper" property.

Specifies the name of the identity mapper used with this SASL mechanism handler to match the authentication ID included in the SASL bind request to the corresponding user in the directory.

Parameters:
value - The value of the "identity-mapper" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

Specified by:
getJavaClass in interface SASLMechanismHandlerCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

Specified by:
setJavaClass in interface SASLMechanismHandlerCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.