org.apache.hc.client5.http.auth

Class 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.

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthExchange.State

Constructor Summary

Constructors

Constructor and Description
AuthExchange()

Method Summary

Modifier and Type	Method and Description
Queue<AuthScheme>	getAuthOptions() Returns available auth options.
AuthScheme	getAuthScheme() Returns actual AuthScheme.
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	setState(AuthExchange.State state)
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthExchange

public AuthExchange()

Method Detail

getAuthOptions

public Queue<AuthScheme> getAuthOptions()

Returns available auth options. May be null.

getAuthScheme

public AuthScheme getAuthScheme()

Returns actual AuthScheme. May be null.

getState

public AuthExchange.State getState()

isConnectionBased

public boolean isConnectionBased()

Returns true if the actual authentication scheme is connection based.

reset

public void reset()

select

public void select(AuthScheme authScheme)

Resets the auth state with AuthScheme and clears auth options.

Parameters:

authScheme - auth scheme. May not be null.

setOptions

public void setOptions(Queue<AuthScheme> authOptions)

Updates the auth state with a queue of auth options.

Parameters:

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

setState

public void setState(AuthExchange.State state)

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.