Package org.attribyte.api.http

Class StreamedResponse

java.lang.Object

org.attribyte.api.http.Response

org.attribyte.api.http.StreamedResponse

public class StreamedResponse
extends Response

A response that allows the body to be streamed.

Nested Class Summary

Nested classes/interfaces inherited from class org.attribyte.api.http.Response

Response.Code

Field Summary

Fields

Modifier and Type	Field	Description
final com.google.common.io.ByteSource	body	The source for the body.

Fields inherited from class org.attribyte.api.http.Response

attributes, cookies, headers, stats, statusCode

Constructor Summary

Constructors

Constructor	Description
StreamedResponse(int statusCode, Map<?,?> headers, com.google.common.io.ByteSource body, Map<String,Object> attributes, Stats stats, Collection<Cookie> cookies)	Creates a response.

Method Summary

Modifier and Type	Method	Description
com.google.protobuf.ByteString	getBody()	Gets the response body as an immutable ByteString.
com.google.common.io.ByteSource	getBodySource()	Gets a source for the body.

Methods inherited from class org.attribyte.api.http.Response

getAttribute, getAttribute, getCharset, getContentType, getHeaders, getHeaderValue, getHeaderValueList, getHeaderValues, getStats, getStatusCode, getTiming, toString

Methods inherited from class java.lang.Object

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

Field Details

body

public final com.google.common.io.ByteSource body

The source for the body.

Constructor Details

StreamedResponse

public StreamedResponse(int statusCode,
 Map<?,?> headers,
 com.google.common.io.ByteSource body,
 Map<String,Object> attributes,
 Stats stats,
 Collection<Cookie> cookies)

Creates a response.

Parameters:

statusCode - The HTTP response status code.

headers - The response headers.

body - The response body source.

attributes - The attributes.

stats - The stats.

cookies - The cookies.

Method Details

getBody

public com.google.protobuf.ByteString getBody()
                                       throws IOException

Description copied from class: Response

Gets the response body as an immutable ByteString.

Overrides:

getBody in class Response

Returns:

The response body, or null if none.

Throws:

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

getBodySource

public com.google.common.io.ByteSource getBodySource()

Gets a source for the body.

Returns:

The body, or null if none.