public class PlainSASLMechanismHandler extends SASLMechanismHandler<PlainSaslMechanismHandlerCfg> implements ConfigurationChangeListener<PlainSaslMechanismHandlerCfg>
[authzid] UTF8NULL authcid UTF8NULL passwd
Constructor and Description |
---|
PlainSASLMechanismHandler() |
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(PlainSaslMechanismHandlerCfg configuration)
Applies the configuration changes to this change listener.
|
void |
finalizeSASLMechanismHandler()
Performs any finalization that may be necessary for this SASL mechanism handler.
|
void |
initializeSASLMechanismHandler(PlainSaslMechanismHandlerCfg configuration)
Initializes this SASL mechanism handler based on the information in the provided configuration entry.
|
boolean |
isConfigurationAcceptable(PlainSaslMechanismHandlerCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this SASL mechanism handler.
|
boolean |
isConfigurationChangeAcceptable(PlainSaslMechanismHandlerCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
boolean |
isPasswordBased(String mechanism)
Indicates whether the specified SASL mechanism is password-based or uses some other form of credentials (e.g., an
SSL client certificate or Kerberos ticket).
|
boolean |
isSecure(String mechanism)
Indicates whether the specified SASL mechanism should be considered secure (i.e., it does not expose the
authentication credentials in a manner that is useful to a third-party observer, and other aspects of the
authentication are generally secure).
|
void |
processSASLBind(BindOperation bindOperation)
Processes the SASL bind operation.
|
public void initializeSASLMechanismHandler(PlainSaslMechanismHandlerCfg configuration)
SASLMechanismHandler
initializeSASLMechanismHandler
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
configuration
- The configuration to use to initialize this SASL mechanism handler.public void finalizeSASLMechanismHandler()
SASLMechanismHandler
finalizeSASLMechanismHandler
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
public void processSASLBind(BindOperation bindOperation)
SASLMechanismHandler
BindOperation.setResultCode
method must be used to set the appropriate result code.BindOperation.setSASLAuthUserEntry
method to provide it with the entry for the user that attempted to
authenticate.BindOperation.setAuthenticationInfo
method must be
used to set the authentication info for the bind operation.BindOperation.setAuthFailureReason
method should
be used to provide a message explaining why the authentication failed.processSASLBind
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
bindOperation
- The SASL bind operation to be processed.public boolean isPasswordBased(String mechanism)
SASLMechanismHandler
isPasswordBased
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
mechanism
- The name of the mechanism for which to make the determination. This will only be invoked with names of
mechanisms for which this handler has previously registered.true
if this SASL mechanism is password-based, or false
if it uses some other form of
credentials.public boolean isSecure(String mechanism)
SASLMechanismHandler
isSecure
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
mechanism
- The name of the mechanism for which to make the determination. This will only be invoked with names of
mechanisms for which this handler has previously registered.true
if this SASL mechanism should be considered secure, or false
if not.public boolean isConfigurationAcceptable(PlainSaslMechanismHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
SASLMechanismHandler
isConfigurationAcceptable
in class SASLMechanismHandler<PlainSaslMechanismHandlerCfg>
configuration
- The SASL mechanism handler configuration for which to make the determination.unacceptableReasons
- A list that may be used to hold the reasons that the provided configuration is not acceptable.true
if the provided configuration is acceptable for this SASL mechanism handler, or
false
if not.public boolean isConfigurationChangeAcceptable(PlainSaslMechanismHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<PlainSaslMechanismHandlerCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(PlainSaslMechanismHandlerCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<PlainSaslMechanismHandlerCfg>
configuration
- The new configuration containing the changes.Copyright 2010-2022 ForgeRock AS.