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

All Superinterfaces:
ConfigurationClient, SASLMechanismHandlerCfgClient

public interface DigestMD5SASLMechanismHandlerCfgClient
extends SASLMechanismHandlerCfgClient

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

The DIGEST-MD5 SASL mechanism is used to perform all processing related to SASL DIGEST-MD5 authentication.


Method Summary
 ManagedObjectDefinition<? extends DigestMD5SASLMechanismHandlerCfgClient,? extends DigestMD5SASLMechanismHandlerCfg> definition()
          Get the configuration definition associated with this Digest MD5 SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getRealm()
          Gets the "realm" property.
 java.lang.String getServerFqdn()
          Gets the "server-fqdn" property.
 void setIdentityMapper(java.lang.String value)
          Sets the "identity-mapper" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setRealm(java.lang.String value)
          Sets the "realm" property.
 void setServerFqdn(java.lang.String value)
          Sets the "server-fqdn" 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 DigestMD5SASLMechanismHandlerCfgClient,? extends DigestMD5SASLMechanismHandlerCfg> definition()
Get the configuration definition associated with this Digest MD5 SASL Mechanism Handler.

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

getIdentityMapper

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

Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the authentication or authorization 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 that is to be used with this SASL mechanism handler to match the authentication or authorization 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.

getRealm

java.lang.String getRealm()
Gets the "realm" property.

Specifies the realm that is to be used by the server for DIGEST-MD5 authentication.

If this value is not provided, then the server defaults to use a set of realm names that correspond to the defined suffixes.

Returns:
Returns the value of the "realm" property.

setRealm

void setRealm(java.lang.String value)
              throws IllegalPropertyValueException
Sets the "realm" property.

Specifies the realm that is to be used by the server for DIGEST-MD5 authentication.

If this value is not provided, then the server defaults to use a set of realm names that correspond to the defined suffixes.

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

getServerFqdn

java.lang.String getServerFqdn()
Gets the "server-fqdn" property.

Specifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.

If this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.

Returns:
Returns the value of the "server-fqdn" property.

setServerFqdn

void setServerFqdn(java.lang.String value)
                   throws IllegalPropertyValueException
Sets the "server-fqdn" property.

Specifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.

If this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.

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