Package org.apache.commons.httpclient.auth

Class AuthState

java.lang.Object

org.apache.commons.httpclient.auth.AuthState

public class AuthState
extends java.lang.Object

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

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PREEMPTIVE_AUTH_SCHEME

Constructor Summary

Constructors

Constructor	Description
AuthState()	Default constructor.

Method Summary

Modifier and Type	Method	Description
AuthScheme	getAuthScheme()	Returns the authentication scheme.
java.lang.String	getRealm()	Returns the authentication realm.
void	invalidate()	Invalidates the authentication state by resetting its parameters.
boolean	isAuthAttempted()	Tests whether authenication challenge has been responsed to
boolean	isAuthRequested()	Tests whether authenication challenge has been received
boolean	isPreemptive()	Tests if preemptive authentication is used.
void	setAuthAttempted(boolean challengeResponded)	Sets authentication attempt status
void	setAuthRequested(boolean challengeReceived)	Sets authentication request status
void	setAuthScheme(AuthScheme authScheme)	Assigns the given authentication scheme.
void	setPreemptive()	Preemptively assigns Basic authentication scheme.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PREEMPTIVE_AUTH_SCHEME

public static final java.lang.String PREEMPTIVE_AUTH_SCHEME

See Also:

Constant Field Values

Constructor Detail

AuthState

public AuthState()

Default constructor.

Method Detail

invalidate

public void invalidate()

Invalidates the authentication state by resetting its parameters.

isAuthRequested

public boolean isAuthRequested()

Tests whether authenication challenge has been received

Returns:

true if authenication challenge has been received, false otherwise

setAuthRequested

public void setAuthRequested(boolean challengeReceived)

Sets authentication request status

Parameters:

challengeReceived - true if authenication has been requested, false otherwise

isAuthAttempted

public boolean isAuthAttempted()

Tests whether authenication challenge has been responsed to

Returns:

true if authenication challenge has been responsed to, false otherwise

setAuthAttempted

public void setAuthAttempted(boolean challengeResponded)

Sets authentication attempt status

Parameters:

challengeResponded - true if authenication has been attempted, false otherwise

setPreemptive

public void setPreemptive()

Preemptively assigns Basic authentication scheme.

isPreemptive

public boolean isPreemptive()

Tests if preemptive authentication is used.

Returns:

true if using the default Basic authentication scheme, false otherwise.

setAuthScheme

public void setAuthScheme(AuthScheme authScheme)

Assigns the given authentication scheme.

Parameters:

authScheme - the authentication scheme

getAuthScheme

public AuthScheme getAuthScheme()

Returns the authentication scheme.

Returns:

authentication scheme

getRealm

public java.lang.String getRealm()

Returns the authentication realm.

Returns:

the name of the authentication realm

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object