depends.org.apache.http.auth

类 AuthState

java.lang.Object

depends.org.apache.http.auth.AuthState

@NotThreadSafe
public class AuthState
extends java.lang.Object

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

从以下版本开始:

4.0

构造器概要

构造器

构造器和说明
AuthState()

方法概要

方法

限定符和类型	方法和说明
java.util.Queue<AuthOption>	getAuthOptions() Returns available AuthOptions.
AuthScheme	getAuthScheme() Returns actual AuthScheme.
AuthScope	getAuthScope() 已过时。 (4.2) do not use.
Credentials	getCredentials() Returns actual Credentials.
AuthProtocolState	getState()
boolean	hasAuthOptions() Returns true if AuthOptions are available, false otherwise.
void	invalidate() 已过时。 (4.2) use reset()
boolean	isValid() 已过时。 (4.2) do not use
void	reset() Resets the auth state.
void	setAuthScheme(AuthScheme authScheme) 已过时。 (4.2) use update(AuthScheme, Credentials)
void	setAuthScope(AuthScope authScope) 已过时。 (4.2) do not use.
void	setCredentials(Credentials credentials) 已过时。 (4.2) use update(AuthScheme, Credentials)
void	setState(AuthProtocolState state)
java.lang.String	toString()
void	update(AuthScheme authScheme, Credentials credentials) Updates the auth state with AuthScheme and Credentials.
void	update(java.util.Queue<AuthOption> authOptions) Updates the auth state with a queue of AuthOptions.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

AuthState

public AuthState()

方法详细资料

reset

public void reset()

Resets the auth state.

从以下版本开始:

4.2

getState

public AuthProtocolState getState()

从以下版本开始:

4.2

setState

public void setState(AuthProtocolState state)

从以下版本开始:

4.2

getAuthScheme

public AuthScheme getAuthScheme()

Returns actual AuthScheme. May be null.

getCredentials

public Credentials getCredentials()

Returns actual Credentials. May be null.

update

public void update(AuthScheme authScheme,
          Credentials credentials)

Updates the auth state with AuthScheme and Credentials.

参数:

authScheme - auth scheme. May not be null.

credentials - user crednetials. May not be null.

从以下版本开始:

4.2

getAuthOptions

public java.util.Queue<AuthOption> getAuthOptions()

Returns available AuthOptions. May be null.

从以下版本开始:

4.2

hasAuthOptions

public boolean hasAuthOptions()

Returns true if AuthOptions are available, false otherwise.

从以下版本开始:

4.2

update

public void update(java.util.Queue<AuthOption> authOptions)

Updates the auth state with a queue of AuthOptions.

参数:

authOptions - a queue of auth options. May not be null or empty.

从以下版本开始:

4.2

invalidate

@Deprecated
public void invalidate()

已过时。 (4.2) use reset()

Invalidates the authentication state by resetting its parameters.

isValid

@Deprecated
public boolean isValid()

已过时。 (4.2) do not use

setAuthScheme

@Deprecated
public void setAuthScheme(AuthScheme authScheme)

已过时。 (4.2) use update(AuthScheme, Credentials)

Assigns the given authentication scheme.

参数:

authScheme - the authentication scheme

setCredentials

@Deprecated
public void setCredentials(Credentials credentials)

已过时。 (4.2) use update(AuthScheme, Credentials)

Sets user Credentials to be used for authentication

参数:

credentials - User credentials

getAuthScope

@Deprecated
public AuthScope getAuthScope()

已过时。 (4.2) do not use.

Returns actual AuthScope if available

返回:

actual authentication scope if available, null

setAuthScope

@Deprecated
public void setAuthScope(AuthScope authScope)

已过时。 (4.2) do not use.

Sets actual AuthScope.

参数:

authScope - Authentication scope

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object