org.apache.hc.client5.http.auth

类 AuthExchange

java.lang.Object

org.apache.hc.client5.http.auth.AuthExchange

public class AuthExchange
extends Object

This class represents the actual state of authentication handshake including the current AuthScheme used for request authorization as well as a collection of backup authentication options if available.

从以下版本开始:

4.5

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AuthExchange.State

构造器概要

构造器

构造器和说明
AuthExchange()

方法概要

限定符和类型	方法和说明
Queue<AuthScheme>	getAuthOptions() Returns available auth options.
AuthScheme	getAuthScheme() Returns actual AuthScheme.
String	getPathPrefix()
AuthExchange.State	getState()
boolean	isConnectionBased() Returns true if the actual authentication scheme is connection based.
void	reset()
void	select(AuthScheme authScheme) Resets the auth state with AuthScheme and clears auth options.
void	setOptions(Queue<AuthScheme> authOptions) Updates the auth state with a queue of auth options.
void	setPathPrefix(String pathPrefix)
void	setState(AuthExchange.State state)
String	toString()

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

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

构造器详细资料

AuthExchange

public AuthExchange()

方法详细资料

reset

public void reset()

getState

public AuthExchange.State getState()

setState

public void setState(AuthExchange.State state)

getAuthScheme

public AuthScheme getAuthScheme()

Returns actual AuthScheme. May be null.

isConnectionBased

public boolean isConnectionBased()

Returns true if the actual authentication scheme is connection based.

getPathPrefix

public String getPathPrefix()

从以下版本开始:

5.2

setPathPrefix

public void setPathPrefix(String pathPrefix)

从以下版本开始:

5.2

select

public void select(AuthScheme authScheme)

Resets the auth state with AuthScheme and clears auth options.

参数:

authScheme - auth scheme. May not be null.

getAuthOptions

public Queue<AuthScheme> getAuthOptions()

Returns available auth options. May be null.

setOptions

public void setOptions(Queue<AuthScheme> authOptions)

Updates the auth state with a queue of auth options.

参数:

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

toString

public String toString()

覆盖:

toString 在类中 Object