|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.auth.AuthState
@NotThreadSafe public class AuthState
This class provides detailed information about the state of the authentication process.
| Constructor Summary | |
|---|---|
AuthState()
|
|
| Method Summary | |
|---|---|
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()
Returns true if AuthOptions are available, false
otherwise. |
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public AuthState()
| Method Detail |
|---|
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()
true if AuthOptions are available, false
otherwise.
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 authentication
credentials - User credentials@Deprecated public AuthScope getAuthScope()
AuthScope if available
null
@Deprecated public void setAuthScope(AuthScope authScope)
AuthScope.
authScope - Authentication scopepublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||