com.ibm.websphere.servlet.filter
Class ChainedResponse

java.lang.Object
  |
  +--javax.servlet.ServletResponseWrapper
        |
        +--javax.servlet.http.HttpServletResponseWrapper
              |
              +--com.ibm.websphere.servlet.response.StoredResponse
                    |
                    +--com.ibm.websphere.servlet.filter.ChainedResponse
All Implemented Interfaces:
javax.servlet.http.HttpServletResponse, com.ibm.ws.webcontainer.srt.IExtendedResponse, com.ibm.ws.webcontainer.srt.IResponseOutput, java.io.Serializable, javax.servlet.ServletResponse
public class ChainedResponse
extends StoredResponse

ChainedResponse is a response object that can be instantiated by any servlet and used/passed as a standard HttpResponse. The data that is written to this response can then be retrieved as a request to pass into another servlet in a chain. The ChainedRequest must be instantiated with the original request and response objects so that attributes and sessions associated with the chain can be propagated correctly.

See Also:
Serialized Form

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
ChainedResponse(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
          Create a chained response.
 
Method Summary
 java.lang.String encodeRedirectUrl(java.lang.String url)
           
 java.lang.String encodeRedirectURL(java.lang.String url)
           
 java.lang.String encodeUrl(java.lang.String url)
           
 java.lang.String encodeURL(java.lang.String url)
           
 javax.servlet.http.HttpServletRequest getChainedRequest()
          Returns a chained request that contains the data that was written to this response.
 javax.servlet.http.HttpServletResponse getProxiedHttpServletResponse()
           
 void setAutoTransferringHeader(java.lang.String name, java.lang.String value)
          Set a header that should be automatically transferred to all requests in a chain.
 
Methods inherited from class com.ibm.websphere.servlet.response.StoredResponse
addCookie, addDateHeader, addHeader, addIntHeader, addSessionCookie, close, containsError, containsHeader, flushBuffer, flushBuffer, getBufferSize, getCharacterEncoding, getCookies, getDateHeader, getError, getErrorMessage, getErrorStatusCode, getHeader, getHeaderNames, getHeaderTable, getIntHeader, getLastModified, getLocale, getOutputBuffer, getOutputBufferAsString, getOutputStream, getRedirectURI, getStatusCode, getStatusMessage, getWriter, isCommitted, isExpired, isRedirected, outputStreamObtained, reset, resetBuffer, sendError, sendError, sendRedirect, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setDateHeader, setHeader, setIntHeader, setLocale, setStatus, setStatus, transferResponse, writerObtained
 
Methods inherited from class javax.servlet.ServletResponseWrapper
getResponse, setResponse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChainedResponse

public ChainedResponse(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse resp)
Create a chained response.

Parameters:
req - the original request.
Method Detail

getChainedRequest

public javax.servlet.http.HttpServletRequest getChainedRequest()
                                                        throws java.io.IOException,
                                                               javax.servlet.ServletException
Returns a chained request that contains the data that was written to this response.

java.io.IOException
javax.servlet.ServletException

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)
Specified by:
encodeRedirectURL in interface javax.servlet.http.HttpServletResponse
Overrides:
encodeRedirectURL in class StoredResponse

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)
Specified by:
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse
Overrides:
encodeRedirectUrl in class StoredResponse

encodeURL

public java.lang.String encodeURL(java.lang.String url)
Specified by:
encodeURL in interface javax.servlet.http.HttpServletResponse
Overrides:
encodeURL in class StoredResponse

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)
Specified by:
encodeUrl in interface javax.servlet.http.HttpServletResponse
Overrides:
encodeUrl in class StoredResponse

setAutoTransferringHeader

public void setAutoTransferringHeader(java.lang.String name,
                                      java.lang.String value)
Set a header that should be automatically transferred to all requests in a chain. These headers will be backed up in a request attribute that will automatically read and transferred by all ChainedResponses. This method is useful for transparently transferring the original headers sent by the client without forcing servlets to be specially written to transfer these headers.

getProxiedHttpServletResponse

public javax.servlet.http.HttpServletResponse getProxiedHttpServletResponse()

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.