org.attribyte.api.http

Class Response

java.lang.Object

org.attribyte.api.http.Response

Direct Known Subclasses:

BodyResponse, StreamedResponse

public class Response
extends java.lang.Object

An immutable HTTP response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Response.Code Common HTTP response codes.

Field Summary

Fields

Modifier and Type	Field and Description
<any>	attributes An immutable map of attributes.
<any>	headers An immutable map of headers.
int	statusCode The status code.

Constructor Summary

Constructors

Constructor and Description
Response(int statusCode, java.util.Map<?,?> headers) Creates a response.
Response(int statusCode, java.util.Map<?,?> headers, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a response with attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name) Gets an attribute.
ByteString	getBody() Gets the response body as an immutable ByteString.
java.lang.String	getCharset(java.lang.String defaultCharset) Gets the charset specified for this response or the default charset if none specified.
java.lang.String	getContentType() Gets the value of the Content-Type header.
java.util.Collection<Header>	getHeaders() Gets all headers.
java.lang.String	getHeaderValue(java.lang.String name) Gets the first header value.
<any>	getHeaderValueList(java.lang.String name) Gets an immutable list of values for a header.
java.lang.String[]	getHeaderValues(java.lang.String name) Gets all values for a header.
int	getStatusCode() Gets the HTTP response code.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

statusCode

public final int statusCode

The status code.

headers

public final <any> headers

An immutable map of headers.

The keys in this map are lower-case.

attributes

public final <any> attributes

An immutable map of attributes.

Beware: The values may not be immutable.

Constructor Detail

Response

public Response(int statusCode,
                java.util.Map<?,?> headers)

Creates a response.

Parameters:

statusCode - The HTTP response status code.

headers - The response headers.

Response

public Response(int statusCode,
                java.util.Map<?,?> headers,
                java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a response with attributes.

Parameters:

statusCode - The HTTP response status code.

headers - The response headers.

attributes - The attributes.

Method Detail

getStatusCode

public int getStatusCode()

Gets the HTTP response code.

Returns:

The response code.

getBody

public ByteString getBody()
                   throws java.io.IOException

Gets the response body as an immutable ByteString.

Returns:

The response body, or null if none.

Throws:

java.io.IOException - if the body is streamed and an input error occurs.

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String name)

Gets the first header value.

Parameters:

name - The header name.

Returns:

The value or null if none.

getHeaderValues

public java.lang.String[] getHeaderValues(java.lang.String name)

Gets all values for a header.

Parameters:

name - The header name.

Returns:

The values or null if none.

getHeaderValueList

public <any> getHeaderValueList(java.lang.String name)

Gets an immutable list of values for a header.

Parameters:

name - The header name.

Returns:

The values or null if none.

getContentType

public java.lang.String getContentType()

Gets the value of the Content-Type header.

Returns:

The content type, or null if none.

getCharset

public java.lang.String getCharset(java.lang.String defaultCharset)

Gets the charset specified for this response or the default charset if none specified.

Parameters:

defaultCharset - The default charset.

Returns:

The charset.

getHeaders

public java.util.Collection<Header> getHeaders()

Gets all headers.

Returns:

An immutable collection of headers.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Gets an attribute.

Parameters:

name - The attribute name.

Returns:

The attribute or null if none set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object