Class AuthState
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.AuthState
This class provides detailed information about the state of the
authentication process.
- Since:
- 3.0
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns theauthentication scheme
.getRealm()
Returns the authentication realm.void
Invalidates the authentication state by resetting its parameters.boolean
Tests whether authenication challenge has been responsed toboolean
Tests whether authenication challenge has been receivedboolean
Tests if preemptive authentication is used.void
setAuthAttempted
(boolean challengeResponded) Sets authentication attempt statusvoid
setAuthRequested
(boolean challengeReceived) Sets authentication request statusvoid
setAuthScheme
(AuthScheme authScheme) Assigns the givenauthentication scheme
.void
Preemptively assigns Basic authentication scheme.toString()
-
Field Details
-
PREEMPTIVE_AUTH_SCHEME
- See Also:
-
-
Constructor Details
-
AuthState
public AuthState()Default constructor.
-
-
Method Details
-
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
Assigns the givenauthentication scheme
.- Parameters:
authScheme
- theauthentication scheme
-
getAuthScheme
Returns theauthentication scheme
.- Returns:
authentication scheme
-
getRealm
Returns the authentication realm.- Returns:
- the name of the authentication realm
-
toString
-