ResponseFilter

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> enhydra >> servlet >> [ filter overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.enhydra.servlet.filter.ResponseFilter

SOURCE |

Download org.enhydra.servlet.filter.ResponseFilter

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.enhydra.servlet.filter
Class ResponseFilter

java.lang.Object
  org.enhydra.servlet.filter.ResponseFilter

All Implemented Interfaces:: javax.servlet.http.HttpServletResponse, org.apache.tomcat.core.ResponseAdapter, javax.servlet.ServletResponse

Direct Known Subclasses:: PrintTransactionResponse, StandardLoggingResponse

public abstract class ResponseFilter
extends java.lang.Object
implements javax.servlet.http.HttpServletResponse, org.apache.tomcat.core.ResponseAdapter

Base class that is the base class for a filter, allowing it to be accessed as a ResponseAdapter.

Field Summary

protected javax.servlet.http.HttpServletResponse myResponse
          The real HttpServletResponse that all calls will be passed on to.

(package private) javax.servlet.ServletOutputStream outputStream
          Output stream, saved on first access.

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

ResponseFilter(javax.servlet.http.HttpServletResponse originalResponse)
          Constructor.

Method Summary

void addCookie(javax.servlet.http.Cookie cookie)
          This call is passed on to the original HttpServletResponse object.

void addDateHeader(java.lang.String name, long value)
          Adds a response header with the given name and date-value.

void addHeader(java.lang.String name, java.lang.String value)
          Adds a response header with the given name and value.

void addIntHeader(java.lang.String name, int value)
          Adds a response header with the given name and integer value.

void addMimeHeaders(org.apache.tomcat.util.MimeHeaders headers)


boolean containsHeader(java.lang.String name)
          This call is passed on to the original HttpServletResponse object.

void doWrite(byte[] buffer, int pos, int count)
          Write a chunk of bytes.

java.lang.String encodeRedirectUrl(java.lang.String url)
          This call is passed on to the original HttpServletResponse object.

java.lang.String encodeRedirectURL(java.lang.String url)
          Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.

java.lang.String encodeUrl(java.lang.String url)
          This call is passed on to the original HttpServletResponse object.

java.lang.String encodeURL(java.lang.String url)
          Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.

void endHeaders()
          Signal that we're done with the headers, and body will follow.

void endResponse()
          Signal that we're done with a particular request, the server can go on and read more requests or close the socket

void flushBuffer()
          Forces any content in the buffer to be written to the client.

int getBufferSize()
          Returns the actual buffer size used for the response.

java.lang.String getCharacterEncoding()
          This call is passed on to the original HttpServletResponse object.

java.util.Locale getLocale()
          Returns the locale specified for this response using the setLocale(java.util.Locale) 55 method.

javax.servlet.ServletOutputStream getOutputStream()
          This call is passed on to the original HttpServletResponse object.

javax.servlet.ServletOutputStream getServletOutputStream()
          Either implement ServletOutputStream or return BufferedServletOutputStream(this) and implement doWrite();

java.io.PrintWriter getWriter()
          This call is passed on to the original HttpServletResponse object.

boolean isCommitted()
          Returns a boolean indicating if the response has been committed.

void recycle()


void reset()
          Clears any data that exists in the buffer as well as the status code and headers.

void sendError(int sc)
          This call is passed on to the original HttpServletResponse object.

void sendError(int sc, java.lang.String msg)
          This call is passed on to the original HttpServletResponse object.

void sendRedirect(java.lang.String location)
          This call is passed on to the original HttpServletResponse object.

void setBufferSize(int size)
          Sets the preferred buffer size for the body of the response.

void setContentLength(int len)
          This call is passed on to the original HttpServletResponse object.

void setContentType(java.lang.String type)
          This call is passed on to the original HttpServletResponse object.

void setDateHeader(java.lang.String name, long date)
          This call is passed on to the original HttpServletResponse object.

void setHeader(java.lang.String name, java.lang.String value)
          This call is passed on to the original HttpServletResponse object.

void setIntHeader(java.lang.String name, int value)
          This call is passed on to the original HttpServletResponse object.

void setLocale(java.util.Locale locale)
          Sets the locale of the response, if the response has not been committed yet.

void setStatus(int sc)
          This call is passed on to the original HttpServletResponse object.

void setStatus(int sc, java.lang.String sm)
          This call is passed on to the original HttpServletResponse object.

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

getContentType, resetBuffer, setCharacterEncoding

Field Detail

outputStream

javax.servlet.ServletOutputStream outputStream

Output stream, saved on first access.

myResponse

protected javax.servlet.http.HttpServletResponse myResponse

The real HttpServletResponse that all calls will be passed on to.

Constructor Detail

ResponseFilter

public ResponseFilter(javax.servlet.http.HttpServletResponse originalResponse)

Constructor. You must pass in a HttpServletResponse object. This is the object that the calls will be passed on to.

Method Detail

setContentLength

public void setContentLength(int len)

This call is passed on to the original HttpServletResponse object. For a description of what this call does, see the ServletResponse documentation.

Specified by:: setContentLength in interface javax.servlet.ServletResponse

setContentType

public void setContentType(java.lang.String type)

This call is passed on to the original HttpServletResponse object. For a description of what this call does, see the ServletResponse documentation.

Specified by:: setContentType in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

This call is passed on to the original HttpServletResponse object. For a description of what this call does, see the ServletResponse documentation.

Specified by:: getOutputStream in interface javax.servlet.ServletResponse