Package org.forgerock.opendj.server.config.client

Interface ScramSha256SaslMechanismHandlerCfgClient

All Superinterfaces:

ConfigurationClient, SaslMechanismHandlerCfgClient

public interface ScramSha256SaslMechanismHandlerCfgClient
extends SaslMechanismHandlerCfgClient

A client-side interface for reading and modifying SCRAM-SHA-256 SASL Mechanism Handler settings.

The SCRAM-SHA-256 SASL mechanism performs all processing related to SASL SCRAM-SHA-256 authentication.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ScramSha256SaslMechanismHandlerCfgClient,? extends ScramSha256SaslMechanismHandlerCfg>	definition()	Get the configuration definition associated with this SCRAM-SHA-256 SASL Mechanism Handler.
SortedSet<ValueOrExpression<String>>	getIdentityMapper()	Gets the "identity-mapper" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setIdentityMapper(Collection<ValueOrExpression<String>> values)	Sets the "identity-mapper" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" 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 ScramSha256SaslMechanismHandlerCfgClient,? extends ScramSha256SaslMechanismHandlerCfg> definition()

Get the configuration definition associated with this SCRAM-SHA-256 SASL Mechanism Handler.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface SaslMechanismHandlerCfgClient

Returns:

Returns the configuration definition associated with this SCRAM-SHA-256 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 for matching the authentication or authorization ID included in SASL bind requests with users 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 for matching the authentication or authorization ID included in SASL bind requests with users 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.ScramSha256SASLMechanismHandler

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.