org.ocpsoft.rewrite.servlet.config

Class Response

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.ocpsoft.rewrite.servlet.config.HttpOperation

org.ocpsoft.rewrite.servlet.config.Response

All Implemented Interfaces:

Operation, OperationBuilder

public abstract class Response
extends HttpOperation

Responsible for manipulating properties such as headers, cookies, ResponseContentInterceptor and ResponseStreamWrapper instances to the curent HttpServletResponse

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
Response()

Method Summary

Methods

Modifier and Type	Method and Description
static Response	addCookie(Cookie cookie) Create an Operation that adds a Cookie to the HttpServletResponse
static Response	addDateHeader(String name, long value) Create an Operation that adds a date header to the HttpServletResponse
static Response	addHeader(String name, String value) Create an Operation that adds a header to the HttpServletResponse
static Response	addIntHeader(String name, int value) Create an Operation that adds an int header to the HttpServletResponse
static Response	setCode(int code) Create an Operation that sets the HttpServletResponse.setStatus(int) code of the current HttpServletResponse.
static Response	withOutputInterceptedBy(ResponseContentInterceptor... buffers) Create an Operation that adds the given ResponseContentInterceptor instances to the current ServletResponse.
static Response	withOutputStreamWrappedBy(ResponseStreamWrapper... wrappers) Create an Operation that adds the given ResponseStreamWrapper instances to the current ServletResponse.
static Response	write(byte... bytes) Create an Operation that writes the given bytes to the current HttpServletResponse upon execution.
static Response	write(InputStream stream) Create an Operation that writes the contents of the given InputStream current HttpServletResponse upon execution.
static Response	write(Object value) Create an Operation that writes the String value of the given Object to the current HttpServletResponse upon execution.

Methods inherited from class org.ocpsoft.rewrite.servlet.config.HttpOperation

perform, performHttp

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response()

Method Detail

withOutputInterceptedBy

public static Response withOutputInterceptedBy(ResponseContentInterceptor... buffers)
                                        throws IllegalStateException

Create an Operation that adds the given ResponseContentInterceptor instances to the current ServletResponse. This will activate response buffering on the current ServletRequest - meaning that generated output will not be sent to the client until the entire request has completed and all registered ResponseContentInterceptor instances have been executed on the outbound response content.

WARNING: This will cause the ENTIRE response to be buffered in memory, which may cause performance issues on larger responses. Make sure you you really need to buffer the entire response! Favor using a ResponseStreamWrapper if desired behavior may be performed as a stream operation; this will result in far less memory overhead.

Throws:

IllegalStateException - When output has already been written to the client.

withOutputStreamWrappedBy

public static Response withOutputStreamWrappedBy(ResponseStreamWrapper... wrappers)
                                          throws IllegalStateException

Create an Operation that adds the given ResponseStreamWrapper instances to the current ServletResponse. This will activate response stream wrapping on the current ServletRequest - meaning response content will be piped through all registered ResponseStreamWrapper instances as it is written to the client ServletOutputStream.

Throws:

IllegalStateException - When output has already been written to the client.

addHeader

public static Response addHeader(String name,
                 String value)

Create an Operation that adds a header to the HttpServletResponse

addDateHeader

public static Response addDateHeader(String name,
                     long value)

Create an Operation that adds a date header to the HttpServletResponse

addIntHeader

public static Response addIntHeader(String name,
                    int value)

Create an Operation that adds an int header to the HttpServletResponse

addCookie

public static Response addCookie(Cookie cookie)

Create an Operation that adds a Cookie to the HttpServletResponse

setCode

public static Response setCode(int code)

Create an Operation that sets the HttpServletResponse.setStatus(int) code of the current HttpServletResponse.

write

public static Response write(byte... bytes)

Create an Operation that writes the given bytes to the current HttpServletResponse upon execution.

write

public static Response write(Object value)

Create an Operation that writes the String value of the given Object to the current HttpServletResponse upon execution. The value to be written is obtained using Object.toString().

write

public static Response write(InputStream stream)

Create an Operation that writes the contents of the given InputStream current HttpServletResponse upon execution.