org.forgerock.opendj.server.config.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

Modifier and Type	Method and Description
void	addDigestMd5ChangeListener(ConfigurationChangeListener<DigestMd5SaslMechanismHandlerCfg> listener) Register to be notified when this DIGEST-MD5 SASL Mechanism Handler is changed.
Class<? extends DigestMd5SaslMechanismHandlerCfg>	configurationClass() Gets the configuration class associated with this DIGEST-MD5 SASL Mechanism Handler.
String	getIdentityMapper() Gets the "identity-mapper" property.
Dn	getIdentityMapperDn() Gets the "identity-mapper" property as a DN.
String	getJavaClass() Gets the "java-class" property.
DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection	getQualityOfProtection() Gets the "quality-of-protection" property.
String	getRealm() Gets the "realm" property.
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.forgerock.opendj.server.config.server.SaslMechanismHandlerCfg

addChangeListener, isEnabled, removeChangeListener

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Method Detail

configurationClass

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

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

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.

getQualityOfProtection

DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection getQualityOfProtection()

Gets the "quality-of-protection" property.

The name of a property that specifies the quality of protection the server will support.

Returns:

Returns the value of the "quality-of-protection" property.

getRealm

String getRealm()

Gets the "realm" property.

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

If this value is not provided, then the server defaults to use the fully qualified hostname of the machine.

Returns:

Returns the value of the "realm" property.

getServerFqdn

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.