Milyn-Smooks Version 0.4

org.milyn.delivery.response
Class HtmlServletResponseWrapper

java.lang.Object
  extended byjavax.servlet.ServletResponseWrapper
      extended byjavax.servlet.http.HttpServletResponseWrapper
          extended byorg.milyn.delivery.response.ServletResponseWrapper
              extended byorg.milyn.delivery.response.HtmlServletResponseWrapper
All Implemented Interfaces:
ContentDeliveryUnit, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class HtmlServletResponseWrapper
extends ServletResponseWrapper

HTML Response Wrapper.

Servlet response wrapper for the SmooksHtml class for HTML manipulation/transformation. This is the default response wrapper.

Author:
tfennelly

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_EXPECTATION_FAILED, 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_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
HtmlServletResponseWrapper(ContainerRequest containerRequest, javax.servlet.http.HttpServletResponse originalResponse)
          Constructor.
 
Method Summary
 void addHeader(java.lang.String name, java.lang.String value)
           
 void close()
          Ensure all resources etc are closed
 void deliverResponse()
          Transform and serialise the supplied content to the target OutputStream.
 java.lang.String getDetailDescription()
          ContentDeliveryUnit detail description.
 javax.servlet.ServletOutputStream getOutputStream()
           
 java.lang.String getShortDescription()
          ContentDeliveryUnit short description.
 java.io.PrintWriter getWriter()
           
 void setDateHeader(java.lang.String name, long value)
           
 void setHeader(java.lang.String name, java.lang.String value)
           
 void setIntHeader(java.lang.String name, int value)
           
 
Methods inherited from class org.milyn.delivery.response.ServletResponseWrapper
getContainerRequest
 
Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setStatus, setStatus
 
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, 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, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale
 

Constructor Detail

HtmlServletResponseWrapper

public HtmlServletResponseWrapper(ContainerRequest containerRequest,
                                  javax.servlet.http.HttpServletResponse originalResponse)
Constructor.

Parameters:
containerRequest - Container Request.
originalResponse - Original servlet response.
Method Detail

getOutputStream

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

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException
Throws:
java.io.IOException

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

setDateHeader

public void setDateHeader(java.lang.String name,
                          long value)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

deliverResponse

public void deliverResponse()
                     throws java.io.IOException
Description copied from class: ServletResponseWrapper
Transform and serialise the supplied content to the target OutputStream.

Specified by:
deliverResponse in class ServletResponseWrapper
Throws:
java.io.IOException - Probable cause: Unable to get target ServletOutputStream.

close

public void close()
Ensure all resources etc are closed

Specified by:
close in class ServletResponseWrapper

getShortDescription

public java.lang.String getShortDescription()
ContentDeliveryUnit short description.

Returns:
Short description String.
See Also:
ContentDeliveryUnit.getDetailDescription()

getDetailDescription

public java.lang.String getDetailDescription()
ContentDeliveryUnit detail description.

Returns:
Detail description String.
See Also:
ContentDeliveryUnit.getShortDescription()

Milyn-Smooks Version 0.4