Modifier and Type	Class and Description
pack-priv static enum	NTLMScheme.State

Modifier and Type	Field and Description
private String	challenge
private final NTLMEngine	engine
private NTLMScheme.State	state

Access	Constructor and Description
public	NTLMScheme(final NTLMEngine engine)
public	NTLMScheme()

Method Summary

Modifier and Type	Method and Description
public Header	authenticate(final Credentials The set of credentials to be used for athentication credentials, final HttpRequest The request being authenticated request) Implements org.apache.http.auth.AuthScheme.authenticate. Produces an authorization string for the given set of `Credentials`.
public String	getParameter(final String The name of the parameter to be returned name) Implements org.apache.http.auth.AuthScheme.getParameter. Returns authentication parameter with the given name, if available.
public String	getRealm() Implements org.apache.http.auth.AuthScheme.getRealm. Returns authentication realm.
public String	getSchemeName() Implements org.apache.http.auth.AuthScheme.getSchemeName. Returns textual designation of the given authentication scheme.
public boolean	isComplete() Implements org.apache.http.auth.AuthScheme.isComplete. Authentication process may involve a series of challenge-response exchanges.
public boolean	isConnectionBased() Implements org.apache.http.auth.AuthScheme.isConnectionBased. Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis
protected void	parseChallenge(final CharArrayBuffer buffer, final int beginIndex, final int endIndex) Implements abstract org.apache.http.impl.auth.AuthSchemeBase.parseChallenge.

Inherited from org.apache.http.impl.auth.AuthSchemeBase:: authenticate getChallengeState isProxy processChallenge toString

Field Detail

challenge	back to summary
private String challenge

engine	back to summary
private final NTLMEngine engine

state	back to summary
private NTLMScheme.State state

Constructor Detail

NTLMScheme	back to summary
public NTLMScheme(final NTLMEngine engine)

NTLMScheme	back to summary
public NTLMScheme() Since 4.3

Method Detail

authenticate back to summary

authenticate	back to summary
public Header authenticate(final Credentials credentials, final HttpRequest request) throws AuthenticationException Implements org.apache.http.auth.AuthScheme.authenticate. Doc from org.apache.http.auth.AuthScheme.authenticate. Produces an authorization string for the given set of `Credentials`. Parameters credentials:Credentials The set of credentials to be used for athentication request:HttpRequest The request being authenticated Returns:Header the authorization string Annotations @Override Exceptions AuthenticationException: if authorization string cannot be generated due to an authentication failure

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

Implements org.apache.http.auth.AuthScheme.authenticate.

Doc from org.apache.http.auth.AuthScheme.authenticate.

Produces an authorization string for the given set of Credentials.

Parameters

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

Returns:Header

the authorization string

Annotations

@Override

Exceptions

AuthenticationException:: if authorization string cannot be generated due to an authentication failure

getParameter	back to summary
public String getParameter(final String name) Implements org.apache.http.auth.AuthScheme.getParameter. Doc from org.apache.http.auth.AuthScheme.getParameter. Returns authentication parameter with the given name, if available. Parameters name:String The name of the parameter to be returned Returns:String the parameter with the given name Annotations @Override

getParameter

back to summary

public String getParameter(final String name)

Implements org.apache.http.auth.AuthScheme.getParameter.

Doc from org.apache.http.auth.AuthScheme.getParameter.

Returns authentication parameter with the given name, if available.

Parameters

name:String: The name of the parameter to be returned

Returns:String

the parameter with the given name

Annotations

@Override

getRealm back to summary

getRealm	back to summary
public String getRealm() Implements org.apache.http.auth.AuthScheme.getRealm. Doc from org.apache.http.auth.AuthScheme.getRealm. Returns authentication realm. If the concept of an authentication realm is not applicable to the given authentication scheme, returns `null`. Returns:String the authentication realm Annotations @Override

public String getRealm()

Implements org.apache.http.auth.AuthScheme.getRealm.

Doc from org.apache.http.auth.AuthScheme.getRealm.

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

Returns:String

the authentication realm

Annotations

@Override

getSchemeName	back to summary
public String getSchemeName() Implements org.apache.http.auth.AuthScheme.getSchemeName. Doc from org.apache.http.auth.AuthScheme.getSchemeName. Returns textual designation of the given authentication scheme. Returns:String the name of the given authentication scheme Annotations @Override

getSchemeName

back to summary

public String getSchemeName()

Implements org.apache.http.auth.AuthScheme.getSchemeName.

Doc from org.apache.http.auth.AuthScheme.getSchemeName.

Returns textual designation of the given authentication scheme.

Returns:String

the name of the given authentication scheme

Annotations

@Override

isComplete back to summary

isComplete	back to summary
public boolean isComplete() Implements org.apache.http.auth.AuthScheme.isComplete. Doc from org.apache.http.auth.AuthScheme.isComplete. Authentication process may involve a series of challenge-response exchanges. 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:boolean `true` if the authentication process has been completed, `false` otherwise. Annotations @Override

public boolean isComplete()

Implements org.apache.http.auth.AuthScheme.isComplete.

Doc from org.apache.http.auth.AuthScheme.isComplete.

Authentication process may involve a series of challenge-response exchanges. 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:boolean

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

Annotations

@Override

isConnectionBased back to summary

isConnectionBased	back to summary
public boolean isConnectionBased() Implements org.apache.http.auth.AuthScheme.isConnectionBased. Doc from org.apache.http.auth.AuthScheme.isConnectionBased. Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis Returns:boolean `true` if the scheme is connection based, `false` if the scheme is request based. Annotations @Override

public boolean isConnectionBased()

Implements org.apache.http.auth.AuthScheme.isConnectionBased.

Doc from org.apache.http.auth.AuthScheme.isConnectionBased.

Tests if the authentication scheme is provides authorization on a per connection basis instead of usual per request basis

Returns:boolean

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

Annotations

@Override

parseChallenge	back to summary
protected void parseChallenge(final CharArrayBuffer buffer, final int beginIndex, final int endIndex) throws MalformedChallengeException Implements abstract org.apache.http.impl.auth.AuthSchemeBase.parseChallenge. Annotations @Override

parseChallenge

back to summary

protected void parseChallenge(final CharArrayBuffer buffer, final int beginIndex, final int endIndex) throws MalformedChallengeException

Implements abstract org.apache.http.impl.auth.AuthSchemeBase.parseChallenge.

Annotations

@Override

org.apache.http.impl.auth back to summary

pack-priv final Enum NTLMScheme.State

Class Inheritance

extends Enum<NTLMScheme.State>

java.lang.Object
java.lang.Enum
org.apache.http.impl.auth.NTLMScheme.State

Field Summary

Modifier and Type	Field and Description
public static final NTLMScheme.State	CHALLENGE_RECEIVED
public static final NTLMScheme.State	FAILED
public static final NTLMScheme.State	MSG_TYPE1_GENERATED
public static final NTLMScheme.State	MSG_TYPE2_RECEVIED
public static final NTLMScheme.State	MSG_TYPE3_GENERATED
public static final NTLMScheme.State	UNINITIATED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static NTLMScheme.State	valueOf(String name)
public static NTLMScheme.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CHALLENGE_RECEIVED	back to summary
public static final NTLMScheme.State CHALLENGE_RECEIVED

FAILED	back to summary
public static final NTLMScheme.State FAILED

MSG_TYPE1_GENERATED	back to summary
public static final NTLMScheme.State MSG_TYPE1_GENERATED

MSG_TYPE2_RECEVIED	back to summary
public static final NTLMScheme.State MSG_TYPE2_RECEVIED

MSG_TYPE3_GENERATED	back to summary
public static final NTLMScheme.State MSG_TYPE3_GENERATED

UNINITIATED	back to summary
public static final NTLMScheme.State UNINITIATED

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static NTLMScheme.State valueOf(String name)

values	back to summary
public static NTLMScheme.State[] values()

public Class NTLMScheme

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum NTLMScheme.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail