org.ocpsoft.rewrite.servlet

Class RewriteWrappedResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.ocpsoft.rewrite.servlet.RewriteWrappedResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse

public abstract class RewriteWrappedResponse
extends HttpServletResponseWrapper

A HttpServletResponseWrapper for the Rewrite framework.

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INSTANCE_KEY

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
RewriteWrappedResponse(HttpServletRequest request, HttpServletResponse response) Create a new RewriteWrappedResponse instance.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addContentInterceptor(ResponseContentInterceptor stage) Register a new ResponseContentInterceptor for the current HttpServletResponse.
abstract void	addStreamWrapper(ResponseStreamWrapper wrapper) Register a new ResponseStreamWrapper for the current HttpServletResponse.
abstract void	finishStreamWrappers() Call ResponseStreamWrapper#finish() any registered instances of ResponseStreamWrapper.
abstract void	flushBufferedContent() Flush any content that may be buffered in registered ResponseContentInterceptor instances.
static RewriteWrappedResponse	getCurrentInstance(ServletRequest request) Get the current RewriteWrappedResponse isntance for the current ServletRequest
HttpServletRequest	getRequest() Get the HttpServletRequest to which this RewriteWrappedResponse is associated.
abstract boolean	isResponseContentIntercepted() Return true if any ResponseContentInterceptor instances have been registered on the current HttpServletResponse.
abstract boolean	isResponseStreamWrapped() Return true if any ResponseStreamWrapper instances have been registered on the current HttpServletResponse.
protected void	setCurrentInstance(RewriteWrappedResponse instance) Set the current RewriteWrappedResponse instance.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Field Detail

INSTANCE_KEY

protected static final String INSTANCE_KEY

Constructor Detail

RewriteWrappedResponse

public RewriteWrappedResponse(HttpServletRequest request,
                      HttpServletResponse response)

Create a new RewriteWrappedResponse instance.

Method Detail

getCurrentInstance

public static RewriteWrappedResponse getCurrentInstance(ServletRequest request)

Get the current RewriteWrappedResponse isntance for the current ServletRequest

setCurrentInstance

protected void setCurrentInstance(RewriteWrappedResponse instance)

Set the current RewriteWrappedResponse instance.

getRequest

public HttpServletRequest getRequest()

Get the HttpServletRequest to which this RewriteWrappedResponse is associated.

isResponseContentIntercepted

public abstract boolean isResponseContentIntercepted()

Return true if any ResponseContentInterceptor instances have been registered on the current HttpServletResponse.

isResponseStreamWrapped

public abstract boolean isResponseStreamWrapped()

Return true if any ResponseStreamWrapper instances have been registered on the current HttpServletResponse.

addContentInterceptor

public abstract void addContentInterceptor(ResponseContentInterceptor stage)

Register a new ResponseContentInterceptor for the current HttpServletResponse. This method must be called before the HttpServletRequest has been passed to the underlying application..

addStreamWrapper

public abstract void addStreamWrapper(ResponseStreamWrapper wrapper)

Register a new ResponseStreamWrapper for the current HttpServletResponse. This method must be called before the HttpServletRequest has been passed to the underlying application..

flushBufferedContent

public abstract void flushBufferedContent()

Flush any content that may be buffered in registered ResponseContentInterceptor instances. This operation has no effect if no ResponseContentInterceptor instances are registered.

finishStreamWrappers

public abstract void finishStreamWrappers()

Call ResponseStreamWrapper#finish() any registered instances of ResponseStreamWrapper. This operation has no effect if no instances are registered.