com.ibm.websphere.servlet.response

Class HttpServletResponseProxy

  1. java.lang.Object
  2. extended bycom.ibm.websphere.servlet.response.HttpServletResponseProxy
All implemented interfaces:
javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

Deprecated. since WAS V6.0 Use the HttpServletResponseWrapper class instead. Proxies function invocations to an underlying HttpServletResponse. Subclasses of this class can be created that overload or enhance the functionality of a server-provided HttpServletResponse.

Using the proxied response:

  1. Subclass this class and overload any desired functions.
  2. During the servlet's service method, create an instance of the enhanced response using the original response from the server as the proxied response.
  3. Forward the enhanced response to another servlet for processing instead of the original response that was provided by the server.

Sample subclass (overloads the response's OutputStream)

 
 //The data written to this response will be saved to the specified file.
 public class FileOutputResponse extends HttpServletResponseProxy{
    private HttpServletResponse _response;
    private File _file;
    public FileOutputResponse(File f, HttpServletResponse resp){
      _file = f;
       _response = resp;
    }
    protected HttpServletResponse getProxiedHttpServletResponse(){
       return _response;
    }
    //overload response functionality
    public ServletOutputStream getOutputStream() throws IOException{
       return new ServletOutputStreamAdapter(new FileOutputStream(_file));
    }
    public PrintWriter getWriter() throws IOException{
       return new PrintWriter(getOutputStream());
    }
 }
 

Using the enhanced response subclass transparently in a servlet

 //This servlet will store the response of another servlet to a file.
 public class SaveResponseToFileServlet extends HttpServlet{
    public void service(HttpServletRequest req, HttpServletResponse resp){
       resp = new FileOutputResponse(req, new File("/tmp/response.txt"));

       //store the response of SnoopServlet to the response.txt file.
       getServletContext().getRequestDispatcher("/servlet/SnoopServlet").forward(req, resp);
    }
 }
 
  1. public abstract class HttpServletResponseProxy
  2. extends java.lang.Object
  3. implements javax.servlet.http.HttpServletResponse

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_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

Constructor and Description
HttpServletResponseProxy()
Deprecated.

Method Summary

Modifier and Type Method and Description
  1. void
addCookie(javax.servlet.http.Cookie cookie)
Deprecated.
  1. void
addDateHeader(java.lang.String name,long date)
Deprecated.
  1. void
addHeader(java.lang.String name,java.lang.String value)
Deprecated.
  1. void
addIntHeader(java.lang.String name,int value)
Deprecated.
  1. boolean
containsHeader(java.lang.String name)
Deprecated.
  1. java.lang.String
encodeRedirectUrl(java.lang.String url)
Deprecated.
  1. java.lang.String
encodeRedirectURL(java.lang.String url)
Deprecated.
  1. java.lang.String
encodeUrl(java.lang.String url)
Deprecated.
  1. java.lang.String
encodeURL(java.lang.String url)
Deprecated.
  1. void
flushBuffer()
Deprecated.
  1. int
getBufferSize()
Deprecated.
  1. java.lang.String
getCharacterEncoding()
Deprecated.
  1. java.util.Locale
getLocale()
Deprecated.
  1. javax.servlet.ServletOutputStream
getOutputStream()
Deprecated.
  1. protected abstract
  2. javax.servlet.http.HttpServletResponse
getProxiedHttpServletResponse()
Deprecated. Get the response that this object is supposed to proxy.
  1. javax.servlet.ServletResponse
getResponse()
Deprecated.
  1. java.io.PrintWriter
getWriter()
Deprecated.
  1. boolean
isCommitted()
Deprecated.
  1. void
reset()
Deprecated.
  1. void
resetBuffer()
Deprecated. Clears the content of the underlying buffer in the response without clearing headers or status code.
  1. void
sendError(int sc)
Deprecated.
  1. void
sendError(int sc,java.lang.String msg)
Deprecated.
  1. void
sendRedirect(java.lang.String location)
Deprecated.
  1. void
setBufferSize(int size)
Deprecated.
  1. void
setContentLength(int len)
Deprecated.
  1. void
setContentType(java.lang.String type)
Deprecated.
  1. void
setDateHeader(java.lang.String name,long date)
Deprecated.
  1. void
setHeader(java.lang.String name,java.lang.String value)
Deprecated.
  1. void
setIntHeader(java.lang.String name,int value)
Deprecated.
  1. void
setLocale(java.util.Locale loc)
Deprecated.
  1. void
setStatus(int sc)
Deprecated.
  1. void
setStatus(int sc,java.lang.String sm)
Deprecated.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.servlet.http.HttpServletResponse
getHeader, getHeaderNames, getHeaders, getStatus
Methods inherited from interface javax.servlet.ServletResponse
getContentType, setCharacterEncoding

Constructor Detail

HttpServletResponseProxy

  1. public HttpServletResponseProxy( )
Deprecated.

Method Detail

getProxiedHttpServletResponse

  1. protected abstract javax.servlet.http.HttpServletResponse getProxiedHttpServletResponse( )
Deprecated.
Get the response that this object is supposed to proxy.

addCookie

  1. public void addCookie(javax.servlet.http.Cookie cookie)
Deprecated.
Specified by:
addCookie in interface javax.servlet.http.HttpServletResponse

containsHeader

  1. public boolean containsHeader(java.lang.String name)
Deprecated.
Specified by:
containsHeader in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

  1. public java.lang.String encodeRedirectUrl( java.lang.String url)
Deprecated.
Specified by:
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

encodeURL

  1. public java.lang.String encodeURL( java.lang.String url)
Deprecated.
Specified by:
encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

  1. public java.lang.String encodeRedirectURL( java.lang.String url)
Deprecated.
Specified by:
encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

  1. public java.lang.String encodeUrl( java.lang.String url)
Deprecated.
Specified by:
encodeUrl in interface javax.servlet.http.HttpServletResponse

setDateHeader

  1. public void setDateHeader(java.lang.String name,
  2. long date)
Deprecated.
Specified by:
setDateHeader in interface javax.servlet.http.HttpServletResponse

sendError

  1. public void sendError(int sc)
  2. throws java.io.IOException
Deprecated.
Specified by:
sendError in interface javax.servlet.http.HttpServletResponse
Throws:
java.io.IOException

sendError

  1. public void sendError(int sc,
  2. java.lang.String msg)
  3. throws java.io.IOException
Deprecated.
Specified by:
sendError in interface javax.servlet.http.HttpServletResponse
Throws:
java.io.IOException

sendRedirect

  1. public void sendRedirect(java.lang.String location)
  2. throws java.io.IOException
Deprecated.
Specified by:
sendRedirect in interface javax.servlet.http.HttpServletResponse
Throws:
java.io.IOException

setStatus

  1. public void setStatus(int sc)
Deprecated.
Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

  1. public void setStatus(int sc,
  2. java.lang.String sm)
Deprecated.
Specified by:
setStatus in interface javax.servlet.http.HttpServletResponse

setHeader

  1. public void setHeader(java.lang.String name,
  2. java.lang.String value)
Deprecated.
Specified by:
setHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

  1. public void setIntHeader(java.lang.String name,
  2. int value)
Deprecated.
Specified by:
setIntHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

  1. public void addIntHeader(java.lang.String name,
  2. int value)
Deprecated.
Specified by:
addIntHeader in interface javax.servlet.http.HttpServletResponse

addHeader

  1. public void addHeader(java.lang.String name,
  2. java.lang.String value)
Deprecated.
Specified by:
addHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

  1. public void addDateHeader(java.lang.String name,
  2. long date)
Deprecated.
Specified by:
addDateHeader in interface javax.servlet.http.HttpServletResponse

getCharacterEncoding

  1. public java.lang.String getCharacterEncoding( )
Deprecated.
Specified by:
getCharacterEncoding in interface javax.servlet.ServletResponse

getOutputStream

  1. public javax.servlet.ServletOutputStream getOutputStream( )
  2. throws java.io.IOException
Deprecated.
Specified by:
getOutputStream in interface javax.servlet.ServletResponse
Throws:
java.io.IOException

getWriter

  1. public java.io.PrintWriter getWriter( )
  2. throws java.io.IOException
Deprecated.
Specified by:
getWriter in interface javax.servlet.ServletResponse
Throws:
java.io.IOException

setContentLength

  1. public void setContentLength(int len)
Deprecated.
Specified by:
setContentLength in interface javax.servlet.ServletResponse

setContentType

  1. public void setContentType(java.lang.String type)
Deprecated.
Specified by:
setContentType in interface javax.servlet.ServletResponse

setBufferSize

  1. public void setBufferSize(int size)
Deprecated.
Specified by:
setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

  1. public int getBufferSize()
Deprecated.
Specified by:
getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

  1. public void flushBuffer()
  2. throws java.io.IOException
Deprecated.
Specified by:
flushBuffer in interface javax.servlet.ServletResponse
Throws:
java.io.IOException

isCommitted

  1. public boolean isCommitted()
Deprecated.
Specified by:
isCommitted in interface javax.servlet.ServletResponse

reset

  1. public void reset()
Deprecated.
Specified by:
reset in interface javax.servlet.ServletResponse

setLocale

  1. public void setLocale(java.util.Locale loc)
Deprecated.
Specified by:
setLocale in interface javax.servlet.ServletResponse

getLocale

  1. public java.util.Locale getLocale( )
Deprecated.
Specified by:
getLocale in interface javax.servlet.ServletResponse

resetBuffer

  1. public void resetBuffer()
Deprecated.
Clears the content of the underlying buffer in the response without clearing headers or status code.
Specified by:
resetBuffer in interface javax.servlet.ServletResponse
Throws:
java.lang.IllegalStateException - if the response has already been committed
Since:
2.3

getResponse

  1. public javax.servlet.ServletResponse getResponse( )
Deprecated.