Package org.apache.commons.httpclient.auth

Class RFC2617Scheme

  • All Implemented Interfaces:
    AuthScheme
    Direct Known Subclasses:
    BasicScheme, DigestScheme
    @Deprecated
public abstract class RFC2617Scheme
extends java.lang.Object
implements AuthScheme
    Deprecated.
    Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

    Abstract authentication scheme class that lays foundation for all RFC 2617 compliant authetication schemes and provides capabilities common to all authentication schemes defined in RFC 2617.

    • Constructor Detail

      • RFC2617Scheme

        public RFC2617Scheme()
        Deprecated.
        Default constructor for RFC2617 compliant authetication schemes.
        Since:
        3.0

    • Method Detail

      • processChallenge

        public void processChallenge​(java.lang.String challenge)
                      throws MalformedChallengeException
        Deprecated.
        Processes the given challenge token. Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain the state information when dealing with sequential challenges
        Specified by:
        processChallenge in interface AuthScheme
        Parameters:
        challenge - the challenge string
        Throws:
        MalformedChallengeException - is thrown if the authentication challenge is malformed
        Since:
        3.0

      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
        Deprecated.
        Returns authentication parameter with the given name, if available.
        Specified by:
        getParameter in interface AuthScheme
        Parameters:
        name - The name of the parameter to be returned
        Returns:
        the parameter with the given name

      • getRealm

        public java.lang.String getRealm()
        Deprecated.
        Returns authentication realm. The realm may not be null.
        Specified by:
        getRealm in interface AuthScheme
        Returns:
        the authentication realm

      • getID

        public java.lang.String getID()
        Deprecated.
        no longer used
        Returns a String identifying the authentication challenge. This is used, in combination with the host and port to determine if authorization has already been attempted or not. Schemes which require multiple requests to complete the authentication should return a different value for each stage in the request.

        Additionally, the ID should take into account any changes to the authentication challenge and return a different value when appropriate. For example when the realm changes in basic authentication it should be considered a different authentication attempt and a different value should be returned.

        This method simply returns the realm for the challenge.

        Specified by:
        getID in interface AuthScheme
        Returns:
        String a String identifying the authentication challenge. The returned value may be null.