NTLMScheme Class Reference

Inheritance diagram for NTLMScheme:

Description

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
String	getSchemeName ()
	Returns textual designation of the given authentication scheme. More...
String	getParameter (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...
Header	authenticate (final Credentials credentials, final HttpRequest request) throws AuthenticationException
	Produces an authorization string for the given set of com.good.gd.apache.http.auth.Credentials. More...
boolean	isComplete ()
	Authentication process may involve a series of challenge-response exchanges. More...
Public Member Functions inherited from AuthSchemeBase
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...

Member Function Documentation

getSchemeName()

String getSchemeName

(

)

Returns

the name of the given authentication scheme

Implements AuthScheme.

getParameter()

String getParameter

(

String

name

)

Parameters

name	The name of the parameter to be returned

Returns

the parameter with the given name

Implements AuthScheme.

getRealm()

String getRealm

(

)

If the concept of an authentication realm is not applicable to the given authentication scheme, returns null.

Returns

the authentication realm

Implements AuthScheme.

isConnectionBased()

boolean isConnectionBased

(

)

Returns

true if the scheme is connection based, false if the scheme is request based.

Implements AuthScheme.

authenticate()

Header authenticate	(	final Credentials	credentials,
		final HttpRequest	request
	)		throws AuthenticationException

Parameters

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

Exceptions

AuthenticationException

if authorization string cannot be generated due to an authentication failure

Returns

the authorization string

Implements AuthScheme.

isComplete()

boolean isComplete

(

)

This method tests if the authorization process has been completed, either successfully or unsuccessfully, that is, all the required authorization challenges have been processed in their entirety.

Returns

true if the authentication process has been completed, false otherwise.

Implements AuthScheme.