org.takes

Interface Response

All Known Implementing Classes:

RsBuffered, RsEmpty, RsFailure, RsFlash, RsFluent, RsFork, RsForward, RsGzip, RsHtml, RsJson, RsLogout, RsPrettyJson, RsPrettyXml, RsPrint, RsRedirect, RsReturn, RsSimple, RsText, RsVelocity, RsWithBody, RsWithCookie, RsWithHeader, RsWithHeaders, RsWithoutHeader, RsWithStatus, RsWithType, RsWithType.Html, RsWithType.Json, RsWithType.Text, RsWithType.Xml, RsWrap, RsXembly, RsXslt

public interface Response

HTTP response.

Response interface is an abstraction of a HTTP response, that consists of a few headers and a body. To construct a response, use one of the composable decorators from org.takes.rs package. For example, this code will create a response with HTML inside:

 final Response response = new RsWithHeader(
   new RsWithBody(
     new RsWithStatus(200),
     "hello, world!"
   ),
   "Content-Type", "text/html"
 );

The implementations of this interface may require that head() method has to be invoked before reading from the InputStream obtained from the body() method, but they must NOT require that the InputStream has to be read from before the head() method invocation.

All implementations of this interface must be immutable and thread-safe.

Since:

0.1

Version:

$Id: 384457637e4c4d82d96151d11923570c3d034477 $

Author:

Yegor Bugayenko ([email protected])

See Also:

Take, RsWithBody, RsWithHeader, Composable Decorators vs. Imperative Utility Methods

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	body() HTTP response body.
Iterable<String>	head() HTTP response head.

Method Detail

head

Iterable<String> head()
                      throws IOException

HTTP response head.

Returns:

Lines in HTTP response head

Throws:

IOException - If something goes wrong

body

InputStream body()
                 throws IOException

HTTP response body.

Returns:

Stream with body

Throws:

IOException - If something goes wrong