org.apache.commons.httpclient
public class HttpState extends Object
A container for HTTP attributes that may persist from request to request, such as {@link Cookie cookies} and authentication {@link Credentials credentials}.
Version: $Revision: 377704 $ $Date: 2006-02-14 06:48:29 -0500 (Tue, 14 Feb 2006) $
Field Summary | |
---|---|
static String | PREEMPTIVE_DEFAULT
The default value for {@link #PREEMPTIVE_PROPERTY}. |
static String | PREEMPTIVE_PROPERTY
The boolean system property name to turn on preemptive authentication. |
Constructor Summary | |
---|---|
HttpState()
Default constructor. |
Method Summary | |
---|---|
void | addCookie(Cookie cookie)
Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies.
|
void | addCookies(Cookie[] cookies)
Adds an array of {@link Cookie HTTP cookies}. |
void | clear()
Clears the state information (all cookies, credentials and proxy credentials). |
void | clearCookies()
Clears all cookies. |
void | clearCredentials()
Clears all credentials. |
void | clearProxyCredentials()
Clears all proxy credentials. |
int | getCookiePolicy()
Returns the current {@link CookiePolicy cookie policy} for this
HTTP state.
|
Cookie[] | getCookies()
Returns an array of {@link Cookie cookies} that this HTTP
state currently contains.
|
Cookie[] | getCookies(String domain, int port, String path, boolean secure)
Returns an array of {@link Cookie cookies} in this HTTP
state that match the given request parameters.
|
Credentials | getCredentials(String realm, String host)
Get the {@link Credentials credentials} for the given authentication scope on the
given host.
|
Credentials | getCredentials(AuthScope authscope)
Get the {@link Credentials credentials} for the given authentication scope.
|
Credentials | getProxyCredentials(String realm, String proxyHost)
Get the {@link Credentials credentials} for the proxy host with the given
authentication scope.
|
Credentials | getProxyCredentials(AuthScope authscope)
Get the {@link Credentials proxy credentials} for the given authentication scope.
|
boolean | isAuthenticationPreemptive()
Returns true if preemptive authentication should be
attempted, false otherwise.
|
boolean | purgeExpiredCookies()
Removes all of {@link Cookie cookies} in this HTTP state
that have expired according to the current system time.
|
boolean | purgeExpiredCookies(Date date)
Removes all of {@link Cookie cookies} in this HTTP state
that have expired by the specified {@link java.util.Date date}.
|
void | setAuthenticationPreemptive(boolean value)
Defines whether preemptive authentication should be
attempted.
|
void | setCookiePolicy(int policy)
Sets the current {@link CookiePolicy cookie policy} for this HTTP
state to one of the following supported policies:
{@link CookiePolicy#COMPATIBILITY},
{@link CookiePolicy#NETSCAPE_DRAFT} or
{@link CookiePolicy#RFC2109}.
|
void | setCredentials(String realm, String host, Credentials credentials)
Sets the {@link Credentials credentials} for the given authentication
realm on the given host. |
void | setCredentials(AuthScope authscope, Credentials credentials)
Sets the {@link Credentials credentials} for the given authentication
scope. |
void | setProxyCredentials(String realm, String proxyHost, Credentials credentials)
Sets the {@link Credentials credentials} for the given proxy authentication
realm on the given proxy host. |
void | setProxyCredentials(AuthScope authscope, Credentials credentials)
Sets the {@link Credentials proxy credentials} for the given authentication
realm. |
String | toString()
Returns a string representation of this HTTP state.
|
Deprecated: This field and feature will be removed following HttpClient 3.0.
The default value for {@link #PREEMPTIVE_PROPERTY}.Deprecated: This field and feature will be removed following HttpClient 3.0.
The boolean system property name to turn on preemptive authentication.Parameters: cookie the {@link Cookie cookie} to be added
See Also: (Cookie[])
Parameters: cookies the {@link Cookie cookies} to be added
Deprecated: Use {@link org.apache.commons.httpclient.params.HttpMethodParams#getCookiePolicy()}, {@link HttpMethod#getParams()}.
Returns the current {@link CookiePolicy cookie policy} for this HTTP state.Returns: The {@link CookiePolicy cookie policy}.
Returns: an array of {@link Cookie cookies}.
Deprecated: use CookieSpec#match(String, int, String, boolean, Cookie)
Returns an array of {@link Cookie cookies} in this HTTP state that match the given request parameters.Parameters: domain the request domain port the request port path the request path secure true
when using HTTPS
Returns: an array of {@link Cookie cookies}.
Deprecated: use #getCredentials(AuthScope)
Get the {@link Credentials credentials} for the given authentication scope 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, returnnull
.
Parameters: realm the authentication realm host the host the realm is on
Returns: the credentials
Parameters: authscope the {@link AuthScope authentication scope}
Returns: the credentials
Since: 3.0
Deprecated: use #getProxyCredentials(AuthScope)
Get the {@link Credentials credentials} for the proxy host with the given authentication scope. 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, returnnull
.
Parameters: realm the authentication realm proxyHost the proxy host the realm is on
Returns: the credentials
Parameters: authscope the {@link AuthScope authentication scope}
Returns: the credentials
Since: 3.0
Deprecated: Use {@link org.apache.commons.httpclient.params.HttpClientParams#isAuthenticationPreemptive()}, {@link HttpClient#getParams()}.
Returns true if preemptive authentication should be attempted, false otherwise.Returns: boolean flag.
Parameters: date The {@link java.util.Date date} to compare against.
Returns: true if any cookies were purged.
See Also:
purgeExpiredCookies
Deprecated: Use {@link org.apache.commons.httpclient.params.HttpClientParams#setAuthenticationPreemptive(boolean)}, {@link HttpClient#getParams()}.
Defines whether preemptive authentication should be attempted.Parameters: value true if preemptive authentication should be attempted, false otherwise.
Deprecated: Use {@link org.apache.commons.httpclient.params.HttpMethodParams#setCookiePolicy(String)}, {@link HttpMethod#getParams()}.
Sets the current {@link CookiePolicy cookie policy} for this HTTP state to one of the following supported policies: {@link CookiePolicy#COMPATIBILITY}, {@link CookiePolicy#NETSCAPE_DRAFT} or {@link CookiePolicy#RFC2109}.Parameters: policy new {@link CookiePolicy cookie policy}
Deprecated: use #setCredentials(AuthScope, Credentials)
Sets the {@link Credentials credentials} for the given authentication realm on the given host. Thenull
realm signifies default
credentials for the given host, which should be used when no
{@link Credentials credentials} have been explictly supplied for the
challenging realm. The null
host signifies default
credentials, which should be used when no {@link Credentials credentials}
have been explictly supplied for the challenging host. Any previous
credentials for the given realm on the given host will be overwritten.
Parameters: realm the authentication realm host the host the realm belongs to credentials the authentication {@link Credentials credentials} for the given realm.
See Also: HttpState
Parameters: authscope the {@link AuthScope authentication scope} credentials the authentication {@link Credentials credentials} for the given scope.
Since: 3.0
See Also: getCredentials
Deprecated: use #setProxyCredentials(AuthScope, Credentials)
Sets the {@link Credentials credentials} for the given proxy authentication realm on the given proxy host. Thenull
proxy realm signifies
default credentials for the given proxy host, which should be used when no
{@link Credentials credentials} have been explictly supplied for the
challenging proxy realm. The null
proxy host signifies default
credentials, which should be used when no {@link Credentials 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.
Parameters: realm the authentication realm proxyHost the proxy host credentials the authentication credentials for the given realm
See Also: getProxyCredentials
Parameters: authscope the {@link AuthScope authentication scope} credentials the authentication {@link Credentials credentials} for the given realm.
Since: 3.0
See Also: getProxyCredentials
Returns: The string representation of the HTTP state.
See Also: java.lang.Object#toString()