org.codehaus.httpcache4j

Class HTTPRequest

java.lang.Object

org.codehaus.httpcache4j.HTTPRequest

public final class HTTPRequest
extends Object

Represents a HTTP request. You can use this in a couple of ways:
either manipulating the headers directly, or by using the convenience objects. If you manipulate the headers, and use the convenience objects afterwards, the headers produced by the convenience objects takes precedence.

Author:

Erlend Hamnaberg

Constructor Summary

Constructors

Constructor and Description
HTTPRequest(String requestURI)
HTTPRequest(String requestURI, HTTPMethod method)
HTTPRequest(URI requestURI)
HTTPRequest(URI requestURI, HTTPMethod method)
HTTPRequest(URI requestURI, HTTPMethod method, Headers headers, Challenge challenge, Payload payload, org.joda.time.DateTime requestTime)

Method Summary

Methods

Modifier and Type	Method and Description
HTTPRequest	addHeader(Header header)
HTTPRequest	addHeader(String name, String value)
HTTPRequest	addIfMatch(Tag tag)
HTTPRequest	addIfNoneMatch(Tag tag)
HTTPRequest	cacheControl(CacheControl cc)
HTTPRequest	challenge(Challenge challenge)
HTTPRequest	copy()
Headers	getAllHeaders() Returns all headers with the headers from the Conditionals, Payload and Preferences.
CacheControl	getCacheControl()
Challenge	getChallenge()
Headers	getHeaders()
HTTPMethod	getMethod()
URI	getNormalizedURI()
Payload	getPayload()
org.joda.time.DateTime	getRequestTime()
URI	getRequestURI()
boolean	hasPayload()
HTTPRequest	headers(Headers headers)
boolean	isSecure()
HTTPRequest	method(HTTPMethod method)
HTTPRequest	payload(Payload payload)
HTTPRequest	withIfModifiedSince(org.joda.time.DateTime dt)
HTTPRequest	withIfUnModifiedSince(org.joda.time.DateTime dt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPRequest

public HTTPRequest(URI requestURI,
           HTTPMethod method,
           Headers headers,
           Challenge challenge,
           Payload payload,
           org.joda.time.DateTime requestTime)

HTTPRequest

public HTTPRequest(URI requestURI)

HTTPRequest

public HTTPRequest(String requestURI)

HTTPRequest

public HTTPRequest(String requestURI,
           HTTPMethod method)

HTTPRequest

public HTTPRequest(URI requestURI,
           HTTPMethod method)

Method Detail

copy

public HTTPRequest copy()

getRequestURI

public URI getRequestURI()

getNormalizedURI

public URI getNormalizedURI()

getHeaders

public Headers getHeaders()

getAllHeaders

public Headers getAllHeaders()

Returns all headers with the headers from the Conditionals, Payload and Preferences. If you have explicitly set headers on the request that are the same as the Conditionals and Preferences they are overwritten.

Returns:

All the headers

addHeader

public HTTPRequest addHeader(Header header)

addHeader

public HTTPRequest addHeader(String name,
                    String value)

getMethod

public HTTPMethod getMethod()

method

public HTTPRequest method(HTTPMethod method)

getChallenge

public Challenge getChallenge()

challenge

public HTTPRequest challenge(Challenge challenge)

getPayload

public Payload getPayload()

payload

public HTTPRequest payload(Payload payload)

headers

public HTTPRequest headers(Headers headers)

hasPayload

public boolean hasPayload()

getCacheControl

public CacheControl getCacheControl()

cacheControl

public HTTPRequest cacheControl(CacheControl cc)

getRequestTime

public org.joda.time.DateTime getRequestTime()

addIfNoneMatch

public HTTPRequest addIfNoneMatch(Tag tag)

addIfMatch

public HTTPRequest addIfMatch(Tag tag)

withIfUnModifiedSince

public HTTPRequest withIfUnModifiedSince(org.joda.time.DateTime dt)

withIfModifiedSince

public HTTPRequest withIfModifiedSince(org.joda.time.DateTime dt)

isSecure

public boolean isSecure()