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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends DigestMd5SaslMechanismHandlerCfgClient,? extends DigestMd5SaslMechanismHandlerCfg>	definition()	Get the configuration definition associated with this DIGEST-MD5 SASL Mechanism Handler.
SortedSet<ValueOrExpression<String>>	getIdentityMapper()	Gets the "identity-mapper" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection>	getQualityOfProtection()	Gets the "quality-of-protection" property.
ValueOrExpression<String>	getRealm()	Gets the "realm" property.
ValueOrExpression<String>	getServerFqdn()	Gets the "server-fqdn" property.
void	setIdentityMapper(Collection<ValueOrExpression<String>> values)	Sets the "identity-mapper" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setQualityOfProtection(ValueOrExpression<DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection> value)	Sets the "quality-of-protection" property.
void	setRealm(ValueOrExpression<String> value)	Sets the "realm" property.
void	setServerFqdn(ValueOrExpression<String> value)	Sets the "server-fqdn" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.SaslMechanismHandlerCfgClient

isEnabled, setEnabled

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

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getIdentityMapper()

Gets the "identity-mapper" property.

Specifies the name(s) of the identity mappers that are 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 values of the "identity-mapper" property.

setIdentityMapper

@MandatoryProperty
void setIdentityMapper(Collection<ValueOrExpression<String>> values)
                throws PropertyException

Sets the "identity-mapper" property.

Specifies the name(s) of the identity mappers that are 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:

values - The values of the "identity-mapper" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.DigestMD5SASLMechanismHandler

Specified by:

getJavaClass in interface SaslMechanismHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

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

Specified by:

setJavaClass in interface SaslMechanismHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getQualityOfProtection

ValueOrExpression<DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection> getQualityOfProtection()

Gets the "quality-of-protection" property.

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

Default value: none

Returns:

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

setQualityOfProtection

void setQualityOfProtection(ValueOrExpression<DigestMd5SaslMechanismHandlerCfgDefn.QualityOfProtection> value)
                     throws PropertyException

Sets the "quality-of-protection" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getRealm

ValueOrExpression<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.

setRealm

void setRealm(ValueOrExpression<String> value)
       throws PropertyException

Sets 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.

Parameters:

value - The value of the "realm" property.

Throws:

PropertyException - If the new value is invalid.

getServerFqdn

ValueOrExpression<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(ValueOrExpression<String> value)
            throws PropertyException

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:

PropertyException - If the new value is invalid.