Interface ScramSha256SaslMechanismHandlerCfg
-
- All Superinterfaces:
Configuration
,SaslMechanismHandlerCfg
public interface ScramSha256SaslMechanismHandlerCfg extends SaslMechanismHandlerCfg
A server-side interface for querying 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addScramSha256ChangeListener(ConfigurationChangeListener<ScramSha256SaslMechanismHandlerCfg> listener)
Register to be notified when this SCRAM-SHA-256 SASL Mechanism Handler is changed.Class<? extends ScramSha256SaslMechanismHandlerCfg>
configurationClass()
Gets the configuration class associated with this SCRAM-SHA-256 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
removeScramSha256ChangeListener(ConfigurationChangeListener<ScramSha256SaslMechanismHandlerCfg> listener)
Deregister an existing SCRAM-SHA-256 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 Detail
-
configurationClass
Class<? extends ScramSha256SaslMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this SCRAM-SHA-256 SASL Mechanism Handler.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceSaslMechanismHandlerCfg
- Returns:
- Returns the configuration class associated with this SCRAM-SHA-256 SASL Mechanism Handler.
-
addScramSha256ChangeListener
void addScramSha256ChangeListener(ConfigurationChangeListener<ScramSha256SaslMechanismHandlerCfg> listener)
Register to be notified when this SCRAM-SHA-256 SASL Mechanism Handler is changed.- Parameters:
listener
- The SCRAM-SHA-256 SASL Mechanism Handler configuration change listener.
-
removeScramSha256ChangeListener
void removeScramSha256ChangeListener(ConfigurationChangeListener<ScramSha256SaslMechanismHandlerCfg> listener)
Deregister an existing SCRAM-SHA-256 SASL Mechanism Handler configuration change listener.- Parameters:
listener
- The SCRAM-SHA-256 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.ScramSha256SASLMechanismHandler
- Specified by:
getJavaClass
in interfaceSaslMechanismHandlerCfg
- Returns:
- Returns the value of the "java-class" property.
-
-