Package org.apache.hc.client5.http.impl.auth

Class GGSSchemeBase

java.lang.Object
org.apache.hc.client5.http.impl.auth.GGSSchemeBase
All Implemented Interfaces:
AuthScheme
Direct Known Subclasses:
KerberosScheme, SPNegoScheme
@Deprecated public abstract class GGSSchemeBase extends Object implements AuthScheme
Deprecated.
Do not use. The GGS based experimental authentication schemes are no longer supported. Consider using Basic or Bearer authentication with TLS instead.
Common behavior for GSS based authentication schemes.
Since:
4.2

  • Field Details

    • LOG

      private static final org.slf4j.Logger LOG
      Deprecated.

    • NO_TOKEN

      private static final String NO_TOKEN
      Deprecated.
      See Also:

    • KERBEROS_SCHEME

      private static final String KERBEROS_SCHEME
      Deprecated.
      See Also:

    • config

      private final KerberosConfig config
      Deprecated.

    • dnsResolver

      private final DnsResolver dnsResolver
      Deprecated.

    • state

      private GGSSchemeBase.State state
      Deprecated.
      Authentication process state

    • gssCredential

      private GSSCredential gssCredential
      Deprecated.

    • challenge

      private String challenge
      Deprecated.

    • token

      private byte[] token
      Deprecated.

  • Constructor Details

    • GGSSchemeBase

      GGSSchemeBase(KerberosConfig config, DnsResolver dnsResolver)
      Deprecated.

    • GGSSchemeBase

      GGSSchemeBase(KerberosConfig config)
      Deprecated.

    • GGSSchemeBase

      GGSSchemeBase()
      Deprecated.

  • Method Details

    • getRealm

      public String getRealm()
      Deprecated.
      Description copied from interface: AuthScheme
      Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns null.
      Specified by:
      getRealm in interface AuthScheme
      Returns:
      the authentication realm

    • processChallenge

      public void processChallenge(AuthChallenge authChallenge, org.apache.hc.core5.http.protocol.HttpContext context) throws MalformedChallengeException
      Deprecated.
      Description copied from interface: AuthScheme
      Processes the given auth challenge. Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain internal state when dealing with sequential challenges
      Specified by:
      processChallenge in interface AuthScheme
      Parameters:
      authChallenge - the auth challenge
      context - HTTP context
      Throws:
      MalformedChallengeException - in case the auth challenge is incomplete, malformed or otherwise invalid.

    • getManager

      protected GSSManager getManager()
      Deprecated.

    • generateGSSToken

      protected byte[] generateGSSToken(byte[] input, Oid oid, String serviceName, String authServer) throws GSSException
      Deprecated.
      Throws:
      GSSException
      Since:
      4.4

    • createGSSContext

      protected GSSContext createGSSContext(GSSManager manager, Oid oid, GSSName serverName, GSSCredential gssCredential) throws GSSException
      Deprecated.
      Throws:
      GSSException
      Since:
      5.0

    • generateToken

      protected abstract byte[] generateToken(byte[] input, String serviceName, String authServer) throws GSSException
      Deprecated.
      Throws:
      GSSException
      Since:
      4.4

    • isChallengeComplete

      public boolean isChallengeComplete()
      Deprecated.
      Description copied from interface: AuthScheme
      Authentication process may involve a series of challenge-response exchanges. This method tests if the authorization process has been fully completed (either successfully or unsuccessfully), that is, all the required authorization challenges have been processed in their entirety.
      Specified by:
      isChallengeComplete in interface AuthScheme
      Returns:
      true if the authentication process has been completed, false otherwise.

    • isResponseReady

      public boolean isResponseReady(org.apache.hc.core5.http.HttpHost host, CredentialsProvider credentialsProvider, org.apache.hc.core5.http.protocol.HttpContext context) throws AuthenticationException
      Deprecated.
      Description copied from interface: AuthScheme
      Determines whether or not an authorization response can be generated based on the actual authentication state. Generally the outcome of this method will depend upon availability of user credentials necessary to produce an authorization response.
      Specified by:
      isResponseReady in interface AuthScheme
      Parameters:
      credentialsProvider - The credentials to be used for authentication
      context - HTTP context
      Returns:
      true if an authorization response can be generated and the authentication handshake can proceed, false otherwise.
      Throws:
      AuthenticationException - if authorization string cannot be generated due to an authentication failure

    • getPrincipal

      public Principal getPrincipal()
      Deprecated.
      Description copied from interface: AuthScheme
      Returns Principal whose credentials are used to generate an authentication response. Connection based schemes are required to return a user Principal if authorization applies to for the entire life span of connection.
      Specified by:
      getPrincipal in interface AuthScheme
      Returns:
      user principal
      See Also:

    • generateAuthResponse

      public String generateAuthResponse(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.protocol.HttpContext context) throws AuthenticationException
      Deprecated.
      Description copied from interface: AuthScheme
      Generates an authorization response based on the current state. Some authentication schemes may need to load user credentials required to generate an authorization response from a CredentialsProvider prior to this method call.
      Specified by:
      generateAuthResponse in interface AuthScheme
      Parameters:
      request - The request being authenticated
      context - HTTP context
      Returns:
      authorization header
      Throws:
      AuthenticationException - if authorization string cannot be generated due to an authentication failure
      See Also:

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object