groovyx.net.http

Interface FromServer

All Known Implementing Classes:

JavaHttpBuilder.Action.JavaFromServer

public interface FromServer

Adapter interface used to provide a bridge for response data between the HttpBuilder API and the underlying client implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FromServer.Header<T> Defines the interface to the HTTP headers contained in the response.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	finish() Performs any client-specific response finishing operations.
default java.nio.charset.Charset	getCharset() Retrieves the value of the charset from the "Content-Type" response header.
default java.lang.String	getContentType() Retrieves the value of the "Content-Type" header from the response.
default java.util.List<java.net.HttpCookie>	getCookies()
boolean	getHasBody() Determines whether or not there is body content in the response.
java.util.List<FromServer.Header<?>>	getHeaders() Retrieves a List of the response headers as (FromServer.Header objects).
java.io.InputStream	getInputStream() Retrieves the InputStream containing the response content (may have already been processed).
java.lang.String	getMessage() Retrieves the response status message.
default java.io.Reader	getReader() Retrieves a Reader for the response body content (if there is any).
int	getStatusCode() Retrieves the response status code (List of HTTP status code).
java.net.URI	getUri() Retrieves the URI of the original request.

Field Detail

DEFAULT_CONTENT_TYPE

static final java.lang.String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

getContentType

default java.lang.String getContentType()

Retrieves the value of the "Content-Type" header from the response.

Returns:

the value of the "Content-Type" response header

getCharset

default java.nio.charset.Charset getCharset()

Retrieves the value of the charset from the "Content-Type" response header.

Returns:

the value of the charset from the "Content-Type" response header

getCookies

default java.util.List<java.net.HttpCookie> getCookies()

getInputStream

java.io.InputStream getInputStream()

Retrieves the InputStream containing the response content (may have already been processed).

Returns:

the response content

getStatusCode

int getStatusCode()

Retrieves the response status code (List of HTTP status code).

Returns:

the response status code

getMessage

java.lang.String getMessage()

Retrieves the response status message.

Returns:

the response status message (or null)

getHeaders

java.util.List<FromServer.Header<?>> getHeaders()

Retrieves a List of the response headers as (FromServer.Header objects).

Returns:

a List of response headers

getHasBody

boolean getHasBody()

Determines whether or not there is body content in the response.

Returns:

true if there is body content in the response

getUri

java.net.URI getUri()

Retrieves the URI of the original request.

Returns:

the URI of the original request

finish

void finish()

Performs any client-specific response finishing operations.

getReader

default java.io.Reader getReader()

Retrieves a Reader for the response body content (if there is any). The content may have already been processed.

Returns:

a Reader for the response body content (may be empty)