Package org.apache.commons.httpclient.auth

Class AuthState

java.lang.Object
org.apache.commons.httpclient.auth.AuthState
@Deprecated public class AuthState extends Object
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.
This class provides detailed information about the state of the authentication process.
Since:
3.0

  • Field Details

  • Constructor Details

    • AuthState

      public AuthState()
      Deprecated.
      Default constructor.

  • Method Details

    • invalidate

      public void invalidate()
      Deprecated.
      Invalidates the authentication state by resetting its parameters.

    • isAuthRequested

      public boolean isAuthRequested()
      Deprecated.
      Tests whether authenication challenge has been received
      Returns:
      true if authenication challenge has been received, false otherwise

    • setAuthRequested

      public void setAuthRequested(boolean challengeReceived)
      Deprecated.
      Sets authentication request status
      Parameters:
      challengeReceived - true if authenication has been requested, false otherwise

    • isAuthAttempted

      public boolean isAuthAttempted()
      Deprecated.
      Tests whether authenication challenge has been responsed to
      Returns:
      true if authenication challenge has been responsed to, false otherwise

    • setAuthAttempted

      public void setAuthAttempted(boolean challengeResponded)
      Deprecated.
      Sets authentication attempt status
      Parameters:
      challengeResponded - true if authenication has been attempted, false otherwise

    • setPreemptive

      public void setPreemptive()
      Deprecated.
      Preemptively assigns Basic authentication scheme.

    • isPreemptive

      public boolean isPreemptive()
      Deprecated.
      Tests if preemptive authentication is used.
      Returns:
      true if using the default Basic authentication scheme, false otherwise.

    • setAuthScheme

      public void setAuthScheme(AuthScheme authScheme)
      Deprecated.
      Assigns the given authentication scheme.
      Parameters:
      authScheme - the authentication scheme

    • getAuthScheme

      public AuthScheme getAuthScheme()
      Deprecated.
      Returns the authentication scheme.
      Returns:
      authentication scheme

    • getRealm

      public String getRealm()
      Deprecated.
      Returns the authentication realm.
      Returns:
      the name of the authentication realm

    • toString

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