@NotThreadSafe public class AuthState extends Object
| Constructor and Description |
|---|
AuthState() |
| Modifier and Type | Method and Description |
|---|---|
Queue<AuthOption> |
getAuthOptions()
Returns available
AuthOptions. |
AuthScheme |
getAuthScheme()
Returns actual
AuthScheme. |
AuthScope |
getAuthScope()
Deprecated.
(4.2) do not use.
|
Credentials |
getCredentials()
Returns actual
Credentials. |
AuthProtocolState |
getState() |
boolean |
hasAuthOptions()
|
void |
invalidate()
Deprecated.
(4.2) use
reset() |
boolean |
isValid()
Deprecated.
(4.2) do not use
|
void |
reset()
Resets the auth state.
|
void |
setAuthScheme(AuthScheme authScheme)
Deprecated.
(4.2) use
update(AuthScheme, Credentials) |
void |
setAuthScope(AuthScope authScope)
Deprecated.
(4.2) do not use.
|
void |
setCredentials(Credentials credentials)
Deprecated.
(4.2) use
update(AuthScheme, Credentials) |
void |
setState(AuthProtocolState state) |
String |
toString() |
void |
update(AuthScheme authScheme,
Credentials credentials)
Updates the auth state with
AuthScheme and Credentials. |
void |
update(Queue<AuthOption> authOptions)
Updates the auth state with a queue of
AuthOptions. |
public void reset()
public AuthProtocolState getState()
public void setState(AuthProtocolState state)
public AuthScheme getAuthScheme()
AuthScheme. May be null.public Credentials getCredentials()
Credentials. May be null.public void update(AuthScheme authScheme, Credentials credentials)
AuthScheme and Credentials.authScheme - auth scheme. May not be null.credentials - user crednetials. May not be null.public Queue<AuthOption> getAuthOptions()
AuthOptions. May be null.public boolean hasAuthOptions()
public void update(Queue<AuthOption> authOptions)
AuthOptions.authOptions - a queue of auth options. May not be null or empty.@Deprecated public void invalidate()
reset()@Deprecated public boolean isValid()
@Deprecated public void setAuthScheme(AuthScheme authScheme)
update(AuthScheme, Credentials)authentication scheme.authScheme - the authentication scheme@Deprecated public void setCredentials(Credentials credentials)
update(AuthScheme, Credentials)Credentials to be used for authenticationcredentials - User credentials@Deprecated public AuthScope getAuthScope()
AuthScope if availablenull@Deprecated public void setAuthScope(AuthScope authScope)
AuthScope.authScope - Authentication scopeCopyright © 1999–2013 The Apache Software Foundation. All rights reserved.