org.apache.velocity.tools.view
Class ImportSupport.ImportResponseWrapper

java.lang.Object
  extended by javax.servlet.ServletResponseWrapper
      extended by javax.servlet.http.HttpServletResponseWrapper
          extended by org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
Enclosing class:
ImportSupport

protected static class ImportSupport.ImportResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper

Wraps responses to allow us to retrieve results as Strings.


Field Summary
private  java.io.ByteArrayOutputStream bos
          A buffer, alternatively, to accumulate bytes.
private  boolean isStreamUsed
          'True if getOutputStream() was called; false otherwise.
private  boolean isWriterUsed
          'True' if getWriter() was called; false otherwise.
private  int status
          The HTTP status set by the target.
private  java.io.StringWriter sw
          The Writer we convey.
 
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
ImportSupport.ImportResponseWrapper(javax.servlet.http.HttpServletResponse response)
          Constructs a new ImportResponseWrapper.
 
Method Summary
 javax.servlet.ServletOutputStream getOutputStream()
           
 int getStatus()
           
 java.lang.String getString()
          Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.
 java.io.PrintWriter getWriter()
           
 void setContentType(java.lang.String x)
          Has no effect.
 void setLocale(java.util.Locale x)
          Has no effect.
 void setStatus(int status)
          Sets the status of 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
 
Methods inherited from class javax.servlet.ServletResponseWrapper
flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, 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
 

Field Detail

sw

private java.io.StringWriter sw
The Writer we convey.


bos

private java.io.ByteArrayOutputStream bos
A buffer, alternatively, to accumulate bytes.


isWriterUsed

private boolean isWriterUsed
'True' if getWriter() was called; false otherwise.


isStreamUsed

private boolean isStreamUsed
'True if getOutputStream() was called; false otherwise.


status

private int status
The HTTP status set by the target.

Constructor Detail

ImportSupport.ImportResponseWrapper

public ImportSupport.ImportResponseWrapper(javax.servlet.http.HttpServletResponse response)
Constructs a new ImportResponseWrapper.

Parameters:
response - the response to wrap
Method Detail

getWriter

public java.io.PrintWriter getWriter()
Specified by:
getWriter in interface javax.servlet.ServletResponse
Overrides:
getWriter in class javax.servlet.ServletResponseWrapper
Returns:
a Writer designed to buffer the output.

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
Specified by:
getOutputStream in interface javax.servlet.ServletResponse
Overrides:
getOutputStream in class javax.servlet.ServletResponseWrapper
Returns:
a ServletOutputStream designed to buffer the output.

setContentType

public void setContentType(java.lang.String x)
Has no effect.

Specified by:
setContentType in interface javax.servlet.ServletResponse
Overrides:
setContentType in class javax.servlet.ServletResponseWrapper

setLocale

public void setLocale(java.util.Locale x)
Has no effect.

Specified by:
setLocale in interface javax.servlet.ServletResponse
Overrides:
setLocale in class javax.servlet.ServletResponseWrapper

setStatus

public void setStatus(int status)
Sets the status of the response

Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse
Overrides:
setStatus in class javax.servlet.http.HttpServletResponseWrapper
Parameters:
status - the status code

getStatus

public int getStatus()
Returns:
the status of the response

getString

public java.lang.String getString()
                           throws java.io.UnsupportedEncodingException
Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.

Returns:
the buffered output
Throws:
java.io.UnsupportedEncodingException - if the encoding is not supported


Copyright (c) 2003-2007 Apache Software Foundation