Summary: Ctors | Methods | Inherited Methods | [Expand All]

public class

BasicScheme

java.lang.Object
↳	org.apache.http.impl.auth.AuthSchemeBase
	↳	org.apache.http.impl.auth.RFC2617Scheme
		↳	org.apache.http.impl.auth.BasicScheme

Class Overview

Basic authentication scheme as defined in RFC 2617.

Summary

Public Constructors
	BasicScheme () Default constructor for the basic authetication scheme.

Public Methods
Header	authenticate ( Credentials credentials, HttpRequest request) Produces basic authorization header for the given set of `Credentials` .
static Header	authenticate ( Credentials credentials, String charset, boolean proxy) Returns a basic `Authorization` header value for the given `Credentials` and charset.
String	getSchemeName () Returns textual designation of the basic authentication scheme.
boolean	isComplete () Tests if the Basic authentication process has been completed.
boolean	isConnectionBased () Returns `false` .
void	processChallenge ( Header header) Processes the Basic challenge.

[Expand]

Inherited Methods

From class org.apache.http.impl.auth.RFC2617Scheme

From class org.apache.http.impl.auth.AuthSchemeBase

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface org.apache.http.auth.AuthScheme

abstract Header	authenticate ( Credentials credentials, HttpRequest request) Produces an authorization string for the given set of `Credentials` .
abstract String	getParameter ( String name) Returns authentication parameter with the given name, if available.
abstract String	getRealm () Returns authentication realm.
abstract String	getSchemeName () Returns textual designation of the given authentication scheme.
abstract boolean	isComplete () Authentication process may involve a series of challenge-response exchanges.
abstract boolean	isConnectionBased () Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis
abstract void	processChallenge ( Header header) Processes the given challenge token.

Public Constructors

public BasicScheme ()

Added in API level 1

Default constructor for the basic authetication scheme.

Public Methods

public Header authenticate ( Credentials credentials, HttpRequest request)

Added in API level 1

Produces basic authorization header for the given set of Credentials .

Parameters

credentials	The set of credentials to be used for athentication
request	The request being authenticated

Returns

a basic authorization string

Throws

InvalidCredentialsException	if authentication credentials are not valid or not applicable for this authentication scheme
AuthenticationException	if authorization string cannot be generated due to an authentication failure

public static Header authenticate ( Credentials credentials, String charset, boolean proxy)

Added in API level 1

Returns a basic Authorization header value for the given Credentials and charset.

Parameters

credentials	The credentials to encode.
charset	The charset to use for encoding the credentials

Returns

a basic authorization header

public String getSchemeName ()

Added in API level 1

Returns textual designation of the basic authentication scheme.

Returns

basic

public boolean isComplete ()

Added in API level 1

Tests if the Basic authentication process has been completed.

Returns

true if Basic authorization has been processed, false otherwise.

public boolean isConnectionBased ()

Added in API level 1

Returns false . Basic authentication scheme is request based.

Returns

false .

public void processChallenge ( Header header)

Added in API level 1

Processes the Basic challenge.

Parameters

header	the challenge header

Throws

MalformedChallengeException	is thrown if the authentication challenge is malformed

Results

Interfaces

Classes

Exceptions

BasicScheme

Class Overview

Summary

Public Constructors

public BasicScheme ()

Public Methods

public Header authenticate ( Credentials credentials, HttpRequest request)

Parameters

Returns

Throws

public static Header authenticate ( Credentials credentials, String charset, boolean proxy)

Parameters

Returns

public String getSchemeName ()

Returns

public boolean isComplete ()

Returns

public boolean isConnectionBased ()

Returns

public void processChallenge ( Header header)

Parameters

Throws