|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
org.opends.server.extensions.GSSAPISASLMechanismHandler
public class GSSAPISASLMechanismHandler
This class provides an implementation of a SASL mechanism that authenticates clients through Kerberos over GSSAPI.
Constructor Summary | |
---|---|
GSSAPISASLMechanismHandler()
Creates a new instance of this SASL mechanism handler. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(GSSAPISASLMechanismHandlerCfg configuration)
Applies the configuration changes to this change listener. |
void |
finalizeSASLMechanismHandler()
Performs any finalization that may be necessary for this SASL mechanism handler. |
Entry |
getUserForAuthzID(BindOperation bindOperation,
java.lang.String authzID)
Retrieves the user account for the user associated with the provided authorization ID. |
void |
initializeSASLMechanismHandler(GSSAPISASLMechanismHandlerCfg configuration)
Initializes this SASL mechanism handler based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(SASLMechanismHandlerCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this SASL mechanism handler. |
boolean |
isConfigurationChangeAcceptable(GSSAPISASLMechanismHandlerCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
boolean |
isPasswordBased(java.lang.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(java.lang.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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GSSAPISASLMechanismHandler()
initializeSASLMechanismHandler
method.
Method Detail |
---|
public void initializeSASLMechanismHandler(GSSAPISASLMechanismHandlerCfg configuration) throws ConfigException, InitializationException
initializeSASLMechanismHandler
in class SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
configuration
- The configuration to use to initialize
this SASL mechanism handler.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public void finalizeSASLMechanismHandler()
finalizeSASLMechanismHandler
in class SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
public void processSASLBind(BindOperation bindOperation)
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<GSSAPISASLMechanismHandlerCfg>
bindOperation
- The SASL bind operation to be processed.public Entry getUserForAuthzID(BindOperation bindOperation, java.lang.String authzID) throws DirectoryException
bindOperation
- The bind operation from which the provided
authorization ID was derived.authzID
- The authorization ID for which to retrieve the
associated user.
null
if none is identified.
DirectoryException
- If a problem occurs while searching the
directory for the associated user, or if
multiple matching entries are found.public boolean isPasswordBased(java.lang.String mechanism)
isPasswordBased
in class SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
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(java.lang.String mechanism)
isSecure
in class SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
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(SASLMechanismHandlerCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class SASLMechanismHandler<GSSAPISASLMechanismHandlerCfg>
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(GSSAPISASLMechanismHandlerCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<GSSAPISASLMechanismHandlerCfg>
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(GSSAPISASLMechanismHandlerCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<GSSAPISASLMechanismHandlerCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |