org.opends.server.admin.std.server
Interface DigestMD5SASLMechanismHandlerCfg

All Superinterfaces:
Configuration, SASLMechanismHandlerCfg

public interface DigestMD5SASLMechanismHandlerCfg
extends SASLMechanismHandlerCfg

A server-side interface for querying 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
 void addDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener)
          Register to be notified when this Digest MD5 SASL Mechanism Handler is changed.
 java.lang.Class<? extends DigestMD5SASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this Digest MD5 SASL Mechanism Handler.
 java.lang.String getIdentityMapper()
          Gets the "identity-mapper" property.
 DN getIdentityMapperDN()
          Gets the "identity-mapper" property as a DN.
 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 removeDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener)
          Deregister an existing Digest MD5 SASL Mechanism Handler configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.SASLMechanismHandlerCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends DigestMD5SASLMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this Digest MD5 SASL Mechanism Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface SASLMechanismHandlerCfg
Returns:
Returns the configuration class associated with this Digest MD5 SASL Mechanism Handler.

addDigestMD5ChangeListener

void addDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener)
Register to be notified when this Digest MD5 SASL Mechanism Handler is changed.

Parameters:
listener - The Digest MD5 SASL Mechanism Handler configuration change listener.

removeDigestMD5ChangeListener

void removeDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener)
Deregister an existing Digest MD5 SASL Mechanism Handler configuration change listener.

Parameters:
listener - The Digest MD5 SASL Mechanism Handler configuration change listener.

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.

getIdentityMapperDN

DN getIdentityMapperDN()
Gets the "identity-mapper" property as a DN.

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 DN value of the "identity-mapper" property.

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 SASLMechanismHandlerCfg
Returns:
Returns the value of the "java-class" property.

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.

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.