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: 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, Optional<Challenge> challenge, Optional<Payload> payload)

Method Summary

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) Deprecated.
HTTPRequest	challenge(Challenge challenge) Deprecated. Use withChallenge(Challenge) instead
HTTPRequest	copy()
boolean	equals(Object o)
Headers	getAllHeaders() Returns all headers with the headers from the Payload
Optional<CacheControl>	getCacheControl()
Optional<Challenge>	getChallenge()
Headers	getHeaders()
HTTPMethod	getMethod()
URI	getNormalizedURI()
Optional<Payload>	getPayload()
URI	getRequestURI()
int	hashCode()
boolean	hasPayload()
HTTPRequest	headers(Headers headers)
boolean	isSecure()
HTTPRequest	method(HTTPMethod method) Deprecated. Use withMethod(HTTPMethod) instead
HTTPRequest	payload(Payload payload) Deprecated. Use withPayload(Payload) instead
HTTPRequest	setHeader(String name, String value)
HTTPRequest	withCacheControl(CacheControl cc)
HTTPRequest	withChallenge(Challenge challenge)
HTTPRequest	withIfModifiedSince(LocalDateTime dt)
HTTPRequest	withIfUnModifiedSince(LocalDateTime dt)
HTTPRequest	withMethod(HTTPMethod method)
HTTPRequest	withPayload(Payload payload)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRequest

public HTTPRequest(URI requestURI,
                   HTTPMethod method,
                   Headers headers,
                   Optional<Challenge> challenge,
                   Optional<Payload> payload)

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 Payload

Returns:

All the headers

addHeader

public HTTPRequest addHeader(Header header)

addHeader

public HTTPRequest addHeader(String name,
                             String value)

setHeader

public HTTPRequest setHeader(String name,
                             String value)

getMethod

public HTTPMethod getMethod()

method

@Deprecated
public HTTPRequest method(HTTPMethod method)

Deprecated. Use withMethod(HTTPMethod) instead

withMethod

public HTTPRequest withMethod(HTTPMethod method)

getChallenge

public Optional<Challenge> getChallenge()

challenge

@Deprecated
public HTTPRequest challenge(Challenge challenge)

Deprecated. Use withChallenge(Challenge) instead

withChallenge

public HTTPRequest withChallenge(Challenge challenge)

getPayload

public Optional<Payload> getPayload()

payload

@Deprecated
public HTTPRequest payload(Payload payload)

Deprecated. Use withPayload(Payload) instead

withPayload

public HTTPRequest withPayload(Payload payload)

headers

public HTTPRequest headers(Headers headers)

hasPayload

public boolean hasPayload()

getCacheControl

public Optional<CacheControl> getCacheControl()

cacheControl

@Deprecated
public HTTPRequest cacheControl(CacheControl cc)

Deprecated.

withCacheControl

public HTTPRequest withCacheControl(CacheControl cc)

addIfNoneMatch

public HTTPRequest addIfNoneMatch(Tag tag)

addIfMatch

public HTTPRequest addIfMatch(Tag tag)

withIfUnModifiedSince

public HTTPRequest withIfUnModifiedSince(LocalDateTime dt)

withIfModifiedSince

public HTTPRequest withIfModifiedSince(LocalDateTime dt)

isSecure

public boolean isSecure()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object