AuthSchemeBase Class Reference

Abstract authentication scheme class that serves as a basis for all authentication schemes supported by HttpClient. More...

Inheritance diagram for AuthSchemeBase:

Description

This class defines the generic way of parsing an authentication challenge. It does not make any assumptions regarding the format of the challenge nor does it impose any specific way of responding to that challenge.

Author

Oleg Kalnichevski

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
void	processChallenge (final Header header) throws MalformedChallengeException
	Processes the given challenge token. More...
boolean	isProxy ()
	Returns true if authenticating against a proxy, false otherwise. More...
Public Member Functions inherited from AuthScheme
String	getSchemeName ()
	Returns textual designation of the given authentication scheme. More...
String	getParameter (final String name)
	Returns authentication parameter with the given name, if available. More...
String	getRealm ()
	Returns authentication realm. More...
boolean	isConnectionBased ()
	Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis. More...
boolean	isComplete ()
	Authentication process may involve a series of challenge-response exchanges. More...
Header	authenticate (Credentials credentials, HttpRequest request) throws AuthenticationException
	Produces an authorization string for the given set of com.good.gd.apache.http.auth.Credentials. More...

Member Function Documentation

processChallenge()

void processChallenge

(

final Header

header

)

throws MalformedChallengeException

Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain the state information when dealing with sequential challenges

Parameters

header

the challenge header

Exceptions

MalformedChallengeException

is thrown if the authentication challenge is malformed

Implements AuthScheme.

Reimplemented in DigestScheme, and BasicScheme.

isProxy()

boolean isProxy

(

)

Returns

true if authenticating against a proxy, false otherwise