org.dmfs.httpclientinterfaces

Interface HttpResponse

public interface HttpResponse

An interface of an HTTP response object.

Author:

Marten Gajda

Method Summary

Modifier and Type	Method and Description
<T> Header<T>	firstHeader(HeaderType<T> headerType) Returns the first Header of the given HeaderType.
<T> boolean	hasHeader(HeaderType<T> headerType) Checks whether the response contains at least one header of the given HeaderType.
<T> java.util.Iterator<Header<T>>	headers(HeaderType<T> headerType) Returns an Iterator that iterates all Headers of the given HeaderType.
java.net.URI	requestUri() Returns the URI the request was originally sent to.
HttpResponseEntity	responseEntity() Returns an HttpResponseEntity representing the data in the response.
java.net.URI	responseUri() Returns the URI of the server that handled the instance.
HttpStatus	status() Returns the status of the response.

Method Detail

status

HttpStatus status()

Returns the status of the response.

Returns:

The status.

See Also:

HttpStatus

hasHeader

<T> boolean hasHeader(HeaderType<T> headerType)

Checks whether the response contains at least one header of the given HeaderType.

Parameters:

headerType - The HeaderType of the header to check.

Returns:

true if there is at least one such header, false otherwise.

firstHeader

<T> Header<T> firstHeader(HeaderType<T> headerType)
                   throws java.util.NoSuchElementException

Returns the first Header of the given HeaderType. Use hasHeader(HeaderType) before you call this to make sure such a Header actually exists.

Parameters:

headerType - The HeaderType of the Header to return.

Returns:

The first Header of the given type.

Throws:

java.util.NoSuchElementException - if no such Header exists.

headers

<T> java.util.Iterator<Header<T>> headers(HeaderType<T> headerType)

Returns an Iterator that iterates all Headers of the given HeaderType.

Parameters:

headerType - The HeaderType of the Headers to return.

Returns:

An Iterator of Headers, may be empty (not null).

responseEntity

HttpResponseEntity responseEntity()

Returns an HttpResponseEntity representing the data in the response.

Returns:

An HttpResponseEntity.

requestUri

java.net.URI requestUri()

Returns the URI the request was originally sent to.

Returns:

The URI of the request.

See Also:

responseUri()

responseUri

java.net.URI responseUri()

Returns the URI of the server that handled the instance. If no redirects have been followed this equals the URI passed to the execute methods of HttpRequestExecutor otherwise it's the URI of the last location that didn't return a redirect.

Returns:

The URI of the responding instance.

See Also:

requestUri()