org.apache.commons.httpclient.auth
Class AuthState

java.lang.Object
  extended byorg.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
Author:
Oleg Kalnichevski

Constructor Summary
AuthState()
          Default constructor.
 
Method Summary
 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 isPreemptive()
          Tests if preemptive authentication is used.
 void setAuthScheme(AuthScheme authScheme)
          Assigns the given authentication scheme.
 void setPreemptive()
          Preemptively assigns Basic authentication scheme.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthState

public AuthState()
Default constructor.

Method Detail

setPreemptive

public void setPreemptive()
Preemptively assigns Basic authentication scheme.


invalidate

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


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


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.