|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.httpclient.HttpState
A container for HTTP attributes that may persist from request
to request, such as cookies
and authentication
credentials
.
Preemptive authentication can be turned on by using the property value of #PREEMPTIVE_PROPERTY. If left unspecified, it has the default value of #PREEMPTIVE_DEFAULT. This configurable behaviour conforms to rcf2617:
Constructor Summary | |
HttpState()
Default constructor. |
Method Summary | |
void |
addCookie(Cookie cookie)
Adds an HTTP cookie , replacing any existing equivalent cookies. |
void |
addCookies(Cookie[] cookies)
Adds an array of HTTP cookies . |
int |
getCookiePolicy()
Deprecated. Use HttpMethodParams.getCookiePolicy() ,
HttpMethod.getParams() . |
Cookie[] |
getCookies()
Returns an array of cookies that this HTTP
state currently contains. |
Cookie[] |
getCookies(java.lang.String domain,
int port,
java.lang.String path,
boolean secure)
Deprecated. use CookieSpec#match(String, int, String, boolean, Cookie) |
Credentials |
getCredentials(HttpAuthRealm realm)
Get the credentials for the given authentication realm. |
Credentials |
getCredentials(java.lang.String realm,
java.lang.String host)
Get the credentials for the given authentication realm on the
given host. |
Credentials |
getProxyCredentials(HttpAuthRealm realm)
Get the credentials for the given proxy authentication realm. |
Credentials |
getProxyCredentials(java.lang.String realm,
java.lang.String proxyHost)
Get the credentials for the proxy host with the given
authentication realm. |
boolean |
isAuthenticationPreemptive()
Deprecated. Use HttpClientParams.isAuthenticationPreemptive() ,
HttpClient.getParams() . |
boolean |
purgeExpiredCookies()
Removes all of cookies in this HTTP state
that have expired according to the current system time. |
boolean |
purgeExpiredCookies(java.util.Date date)
Removes all of cookies in this HTTP state
that have expired by the specified date . |
void |
setAuthenticationPreemptive(boolean value)
Deprecated. Use HttpClientParams.setAuthenticationPreemptive(boolean) ,
HttpClient.getParams() . |
void |
setCookiePolicy(int policy)
Deprecated. Use HttpMethodParams.setCookiePolicy(String) ,
HttpMethod.getParams() . |
void |
setCredentials(HttpAuthRealm realm,
Credentials credentials)
Sets the credentials for the given authentication
realm. |
void |
setCredentials(java.lang.String realm,
java.lang.String host,
Credentials credentials)
Sets the credentials for the given authentication
realm on the given host. |
void |
setProxyCredentials(HttpAuthRealm realm,
Credentials credentials)
Sets the credentials for the given proxy authentication
realm. |
void |
setProxyCredentials(java.lang.String realm,
java.lang.String proxyHost,
Credentials credentials)
Sets the credentials for the given proxy authentication
realm on the given proxy host. |
java.lang.String |
toString()
Returns a string representation of this HTTP state. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public HttpState()
Method Detail |
public void addCookie(Cookie cookie)
HTTP cookie
, replacing any existing equivalent cookies.
If the given cookie has already expired it will not be added, but existing
values will still be removed.
cookie
- the cookie
to be addedaddCookies(Cookie[])
public void addCookies(Cookie[] cookies)
HTTP cookies
. Cookies are added individually and
in the given array order. If any of the given cookies has already expired it will
not be added, but existing values will still be removed.
cookies
- the cookies
to be addedaddCookie(Cookie)
public Cookie[] getCookies()
cookies
that this HTTP
state currently contains.
cookies
.getCookies(String, int, String, boolean)
public Cookie[] getCookies(java.lang.String domain, int port, java.lang.String path, boolean secure)
cookies
in this HTTP
state that match the given request parameters.
domain
- the request domainport
- the request portpath
- the request pathsecure
- true
when using HTTPS
cookies
.getCookies()
public boolean purgeExpiredCookies()
cookies
in this HTTP state
that have expired according to the current system time.
purgeExpiredCookies(java.util.Date)
public boolean purgeExpiredCookies(java.util.Date date)
cookies
in this HTTP state
that have expired by the specified date
.
date
- The date
to compare against.
Cookie.isExpired(java.util.Date)
,
purgeExpiredCookies()
public int getCookiePolicy()
HttpMethodParams.getCookiePolicy()
,
HttpMethod.getParams()
.
cookie policy
for this
HTTP state.
cookie policy
.public void setAuthenticationPreemptive(boolean value)
HttpClientParams.setAuthenticationPreemptive(boolean)
,
HttpClient.getParams()
.
value
- true if preemptive authentication should be
attempted, false otherwise.public boolean isAuthenticationPreemptive()
HttpClientParams.isAuthenticationPreemptive()
,
HttpClient.getParams()
.
public void setCookiePolicy(int policy)
HttpMethodParams.setCookiePolicy(String)
,
HttpMethod.getParams()
.
cookie policy
for this HTTP
state to one of the following supported policies:
CookiePolicy.COMPATIBILITY
,
CookiePolicy.NETSCAPE_DRAFT
or
CookiePolicy.RFC2109
.
policy
- new cookie policy
public void setCredentials(java.lang.String realm, java.lang.String host, Credentials credentials)
credentials
for the given authentication
realm on the given host. The null
realm signifies default
credentials for the given host, which should be used when no
credentials
have been explictly supplied for the
challenging realm. The null
host signifies default
credentials, which should be used when no credentials
have been explictly supplied for the challenging host. Any previous
credentials for the given realm on the given host will be overwritten.
realm
- the authentication realmhost
- the host the realm belongs tocredentials
- the authentication credentials
for the given realm.getCredentials(String, String)
,
setProxyCredentials(String, String, Credentials)
public void setCredentials(HttpAuthRealm realm, Credentials credentials)
credentials
for the given authentication
realm. Any previous credentials for the given realm will be overwritten.
realm
- the authentication realm
credentials
- the authentication credentials
for the given realm.getCredentials(HttpAuthRealm)
,
setProxyCredentials(HttpAuthRealm, Credentials)
public Credentials getCredentials(java.lang.String realm, java.lang.String host)
credentials
for the given authentication realm on the
given host.
If the realm exists on host, return the coresponding credentials.
If the host exists with a null realm, return the corresponding
credentials.
If the realm exists with a null host, return the
corresponding credentials. If the realm does not exist, return
the default Credentials. If there are no default credentials, return
null
.
realm
- the authentication realmhost
- the host the realm is on
setCredentials(String, String, Credentials)
public Credentials getCredentials(HttpAuthRealm realm)
credentials
for the given authentication realm.
realm
- the authentication realm
setCredentials(HttpAuthRealm, Credentials)
public void setProxyCredentials(java.lang.String realm, java.lang.String proxyHost, Credentials credentials)
credentials
for the given proxy authentication
realm on the given proxy host. The null
proxy realm signifies
default credentials for the given proxy host, which should be used when no
credentials
have been explictly supplied for the
challenging proxy realm. The null
proxy host signifies default
credentials, which should be used when no credentials
have been explictly supplied for the challenging proxy host. Any previous
credentials for the given proxy realm on the given proxy host will be
overwritten.
realm
- the authentication realmproxyHost
- the proxy hostcredentials
- the authentication credentials for the given realmgetProxyCredentials(String,String)
,
setCredentials(String, String, Credentials)
public void setProxyCredentials(HttpAuthRealm realm, Credentials credentials)
credentials
for the given proxy authentication
realm. Any previous credentials for the given realm will be overwritten.
realm
- the authentication realm
credentials
- the authentication credentials
for the given realm.getProxyCredentials(HttpAuthRealm)
,
setCredentials(HttpAuthRealm, Credentials)
public Credentials getProxyCredentials(java.lang.String realm, java.lang.String proxyHost)
credentials
for the proxy host with the given
authentication realm.
If the realm exists on host, return the coresponding credentials.
If the host exists with a null realm, return the corresponding
credentials.
If the realm exists with a null host, return the
corresponding credentials. If the realm does not exist, return
the default Credentials. If there are no default credentials, return
null
.
realm
- the authentication realmproxyHost
- the proxy host the realm is on
setProxyCredentials(String, String, Credentials)
public Credentials getProxyCredentials(HttpAuthRealm realm)
credentials
for the given proxy authentication realm.
realm
- the authentication realm
setProxyCredentials(HttpAuthRealm, Credentials)
public java.lang.String toString()
Object.toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |