Package org.apache.qpid.jms.sasl

Class GssapiMechanism

java.lang.Object
org.apache.qpid.jms.sasl.AbstractMechanism
org.apache.qpid.jms.sasl.GssapiMechanism
All Implemented Interfaces:
Comparable<Mechanism>, Mechanism
public class GssapiMechanism extends AbstractMechanism
Implements the GSSAPI sasl authentication Mechanism.

  • Field Details

  • Constructor Details

    • GssapiMechanism

      public GssapiMechanism()

  • Method Details

    • getPriority

      public int getPriority()
      Returns:
      return the relative priority of this SASL mechanism.

    • getName

      public String getName()
      Returns:
      the well known name of this SASL mechanism.

    • isEnabledByDefault

      public boolean isEnabledByDefault()
      Description copied from interface: Mechanism
      Allows the mechanism to indicate if it is enabled by default, or only when explicitly enabled through configuring the permitted sasl mechanisms.
      Specified by:
      isEnabledByDefault in interface Mechanism
      Overrides:
      isEnabledByDefault in class AbstractMechanism
      Returns:
      true if this Mechanism is enabled by default.

    • init

      public void init(Map<String,String> saslOptions)
      Description copied from interface: Mechanism
      Perform any configuration initiation required by the mechanism.
      Specified by:
      init in interface Mechanism
      Overrides:
      init in class AbstractMechanism
      Parameters:
      saslOptions - An immutable map of sasl options. Will always be non-null.

    • getInitialResponse

      public byte[] getInitialResponse() throws SaslException
      Description copied from interface: Mechanism
      Create an initial response based on selected mechanism. May be null if there is no initial response.
      Returns:
      the initial response, or null if there isn't one.
      Throws:
      SaslException - if an error occurs computing the response.

    • getChallengeResponse

      public byte[] getChallengeResponse(byte[] challenge) throws SaslException
      Description copied from interface: Mechanism
      Create a response based on a given challenge from the remote peer.
      Parameters:
      challenge - the challenge that this Mechanism should response to.
      Returns:
      the response that answers the given challenge.
      Throws:
      SaslException - if an error occurs computing the response.

    • verifyCompletion

      public void verifyCompletion() throws SaslException
      Description copied from interface: Mechanism
      Verifies that the SASL exchange has completed successfully. This is an opportunity for the mechanism to ensure that all mandatory steps have been completed successfully and to cleanup and resources that are held by this Mechanism.
      Specified by:
      verifyCompletion in interface Mechanism
      Overrides:
      verifyCompletion in class AbstractMechanism
      Throws:
      SaslException - if the outcome of the SASL exchange is not valid for this Mechanism

    • isApplicable

      public boolean isApplicable(String username, String password, Principal localPrincipal)
      Description copied from interface: Mechanism
      Allows the mechanism to determine if it can be used given the authentication provided.
      Parameters:
      username - The user name given to the client for authentication.
      password - The password given to the client for authentication.
      localPrincipal - The local Principal configured for the client for authentication.
      Returns:
      if this Mechanism is able to validate using the given credentials.

    • getProtocol

      public String getProtocol()

    • setProtocol

      public void setProtocol(String protocol)

    • getServerName

      public String getServerName()

    • setServerName

      public void setServerName(String serverName)

    • getConfigScope

      public String getConfigScope()

    • setConfigScope

      public void setConfigScope(String configScope)