to top
Android APIs
public class

AuthState

extends Object
java.lang.Object
   ↳ org.apache.http.auth.AuthState

Class Overview

This class provides detailed information about the state of the authentication process.

Summary

Public Constructors
AuthState()
Default constructor.
Public Methods
AuthScheme getAuthScheme()
Returns the authentication scheme.
AuthScope getAuthScope()
Returns actual AuthScope if available
Credentials getCredentials()
Returns user Credentials selected for authentication if available
void invalidate()
Invalidates the authentication state by resetting its parameters.
boolean isValid()
void setAuthScheme( AuthScheme authScheme)
Assigns the given authentication scheme.
void setAuthScope( AuthScope authScope)
Sets actual AuthScope.
void setCredentials( Credentials credentials)
Sets user Credentials to be used for authentication
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AuthState ()

Added in API level 1

Default constructor.

Public Methods

public AuthScheme getAuthScheme ()

Added in API level 1

Returns the authentication scheme.

Returns

public AuthScope getAuthScope ()

Added in API level 1

Returns actual AuthScope if available

Returns
  • actual authentication scope if available, null

public Credentials getCredentials ()

Added in API level 1

Returns user Credentials selected for authentication if available

Returns
  • user credentials if available, null

public void invalidate ()

Added in API level 1

Invalidates the authentication state by resetting its parameters.

public boolean isValid ()

Added in API level 1

public void setAuthScheme (AuthScheme authScheme)

Added in API level 1

Assigns the given authentication scheme.

Parameters
authScheme the authentication scheme

public void setAuthScope (AuthScope authScope)

Added in API level 1

Sets actual AuthScope.

Parameters
authScope Authentication scope

public void setCredentials (Credentials credentials)

Added in API level 1

Sets user Credentials to be used for authentication

Parameters
credentials User credentials

public String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.