org.apache.commons.httpclient.auth

Class AuthState


public class AuthState
extends Object

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

Author:
Oleg Kalnichevski

Since:
3.0

Constructor Summary

AuthState()
Default constructor.

Method Summary

AuthScheme
getAuthScheme()
Returns the authentication scheme.
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.
String
toString()

Constructor Details

AuthState

public AuthState()
Default constructor.

Method Details

getAuthScheme

public AuthScheme getAuthScheme()
Returns the authentication scheme.

Returns:
authentication scheme


getRealm

public String getRealm()
Returns the authentication realm.

Returns:
the name of the authentication realm


invalidate

public void invalidate()
Invalidates the authentication state by resetting its parameters.


isAuthAttempted

public boolean isAuthAttempted()
Tests whether authenication challenge has been responsed to

Returns:
true if authenication challenge has been responsed to, false otherwise


isAuthRequested

public boolean isAuthRequested()
Tests whether authenication challenge has been received

Returns:
true if authenication challenge has been received, false otherwise


isPreemptive

public boolean isPreemptive()
Tests if preemptive authentication is used.

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


setAuthAttempted

public void setAuthAttempted(boolean challengeResponded)
Sets authentication attempt status

Parameters:
challengeResponded - true if authenication has been attempted, false otherwise


setAuthRequested

public void setAuthRequested(boolean challengeReceived)
Sets authentication request status

Parameters:
challengeReceived - true if authenication has been requested, false otherwise


setAuthScheme

public void setAuthScheme(AuthScheme authScheme)
Assigns the given authentication scheme.

Parameters:
authScheme - the authentication scheme


setPreemptive

public void setPreemptive()
Preemptively assigns Basic authentication scheme.


toString

public String toString()


Copyright (c) 1999-2005 - Apache Software Foundation