public class AuthExchange extends Object
AuthScheme
used for request authorization as well as a collection of backup authentication options if available.| Modifier and Type | Class and Description |
|---|---|
static class |
AuthExchange.State |
| Constructor and Description |
|---|
AuthExchange() |
| 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() |
public void reset()
public AuthExchange.State getState()
public void setState(AuthExchange.State state)
public AuthScheme getAuthScheme()
AuthScheme. May be null.public boolean isConnectionBased()
true if the actual authentication scheme is connection based.public void select(AuthScheme authScheme)
AuthScheme and clears auth options.authScheme - auth scheme. May not be null.public Queue<AuthScheme> getAuthOptions()
public void setOptions(Queue<AuthScheme> authOptions)
authOptions - a queue of auth options. May not be null or empty.Copyright © 1999–2022 The Apache Software Foundation. All rights reserved.