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

Interface ScramSha512SaslMechanismHandlerCfg

All Superinterfaces:

Configuration, SaslMechanismHandlerCfg

public interface ScramSha512SaslMechanismHandlerCfg
extends SaslMechanismHandlerCfg

A server-side interface for querying SCRAM-SHA-512 SASL Mechanism Handler settings.

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

Method Summary

Modifier and Type	Method	Description
void	addScramSha512ChangeListener(ConfigurationChangeListener<ScramSha512SaslMechanismHandlerCfg> listener)	Register to be notified when this SCRAM-SHA-512 SASL Mechanism Handler is changed.
Class<? extends ScramSha512SaslMechanismHandlerCfg>	configurationClass()	Gets the configuration class associated with this SCRAM-SHA-512 SASL Mechanism Handler.
SortedSet<String>	getIdentityMapper()	Gets the "identity-mapper" property.
SortedSet<Dn>	getIdentityMapperDns()	Gets the "identity-mapper" property as a set of DNs.
String	getJavaClass()	Gets the "java-class" property.
void	removeScramSha512ChangeListener(ConfigurationChangeListener<ScramSha512SaslMechanismHandlerCfg> listener)	Deregister an existing SCRAM-SHA-512 SASL Mechanism Handler configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.SaslMechanismHandlerCfg

addChangeListener, isEnabled, removeChangeListener

Method Details

configurationClass

Class<? extends ScramSha512SaslMechanismHandlerCfg> configurationClass()

Gets the configuration class associated with this SCRAM-SHA-512 SASL Mechanism Handler.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface SaslMechanismHandlerCfg

Returns:

Returns the configuration class associated with this SCRAM-SHA-512 SASL Mechanism Handler.

addScramSha512ChangeListener

void addScramSha512ChangeListener(ConfigurationChangeListener<ScramSha512SaslMechanismHandlerCfg> listener)

Register to be notified when this SCRAM-SHA-512 SASL Mechanism Handler is changed.

Parameters:

listener - The SCRAM-SHA-512 SASL Mechanism Handler configuration change listener.

removeScramSha512ChangeListener

void removeScramSha512ChangeListener(ConfigurationChangeListener<ScramSha512SaslMechanismHandlerCfg> listener)

Deregister an existing SCRAM-SHA-512 SASL Mechanism Handler configuration change listener.

Parameters:

listener - The SCRAM-SHA-512 SASL Mechanism Handler configuration change listener.

getIdentityMapper

SortedSet<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 an unmodifiable set containing the values of the "identity-mapper" property.

getIdentityMapperDns

SortedSet<Dn> getIdentityMapperDns()

Gets the "identity-mapper" property as a set of DNs.

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 DN values 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.

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

Specified by:

getJavaClass in interface SaslMechanismHandlerCfg

Returns:

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