org.apache.felix.webconsole.internal.filter
Class FilteringResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
          extended by org.apache.felix.webconsole.internal.filter.FilteringResponseWrapper
All Implemented Interfaces:
HttpServletResponse, ServletResponse

public class FilteringResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

The FilteringResponseWrapper wraps the response to provide a filtering writer for HTML responses. The filtering writer filters the response such that any string of the form ${some text} is replaced by a translation of the some text according to the ResourceBundle provided in the constructor. If no translation exists in the resource bundle, the text is written unmodifed (except the wrapping ${} characters are removed.


Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletResponse
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_FORBIDDEN, 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_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY
 
Constructor Summary
FilteringResponseWrapper(HttpServletResponse response, ResourceBundle locale, ServletRequest request)
          Creates a wrapper instance using the given resource bundle for translations.
 
Method Summary
 PrintWriter getWriter()
          Returns a PrintWriter for the response.
 
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, 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
getCharacterEncoding, getOutputStream, setContentLength, setContentType
 

Constructor Detail

FilteringResponseWrapper

public FilteringResponseWrapper(HttpServletResponse response,
                                ResourceBundle locale,
                                ServletRequest request)
Creates a wrapper instance using the given resource bundle for translations.

Parameters:
response - the response to wrap
locale - a resource bundle, that will be used for translation of the strings
request - the original request - used to obtain the variable resolver
Method Detail

getWriter

public PrintWriter getWriter()
                      throws IOException
Returns a PrintWriter for the response. If text/html is being generated a filtering writer is returned which translates strings enclosed in ${} according to the resource bundle configured for this response.

Specified by:
getWriter in interface ServletResponse
Overrides:
getWriter in class javax.servlet.ServletResponseWrapper
Returns:
a PrintWriter object that can return character data to the client
Throws:
UnsupportedEncodingException - if the charset specified in setContentType cannot be used
IOException - if an input or output exception occurred
See Also:
ServletResponseWrapper.getWriter()


Copyright © 2011 Apache Software Foundation. All Rights Reserved.