atg.servlet
Class RestHttpServletResponseWrapper

java.lang.Object
  atg.servlet.DynamoHttpServletResponse
      atg.servlet.RestHttpServletResponseWrapper

All Implemented Interfaces:

atg.servlet.AddHeaderHttpServletResponse, atg.servlet.CharacterEncodable, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class RestHttpServletResponseWrapper
extends atg.servlet.DynamoHttpServletResponse

This class wraps the dynamo response and is used when handling rest requests for form submits.

Author:

mannyp

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	IGNORE_REDIRECT redirects to this location will be ignored, no warning displayed

Fields inherited from class atg.servlet.DynamoHttpServletResponse

REQUEST_ID

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

RestHttpServletResponseWrapper(atg.servlet.DynamoHttpServletResponse pResponse)
Constructor

Method Summary

void	addCookie(javax.servlet.http.Cookie pCookie)
void	addCookieToBuffer(javax.servlet.http.Cookie pCookie)
void	addDateHeader(java.lang.String pName, long pValue)
void	addHeader(java.lang.String pName, java.lang.String pValue)
void	addIntHeader(java.lang.String pName, int pValue)
boolean	containsHeader(java.lang.String pName)
java.lang.String	encodeRedirectUrl(java.lang.String pUrl) Deprecated.
java.lang.String	encodeRedirectURL(java.lang.String pUrl)
java.lang.String	encodeUrl(java.lang.String pUrl) Deprecated.
java.lang.String	encodeURL(java.lang.String pUrl)
boolean	equals(java.lang.Object pObj)
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
boolean	getContentTypeSet()
boolean	getDoExitTracking()
java.util.Dictionary	getHeaders()
java.util.Enumeration	getHeaders(java.lang.String pHeaderName)
java.util.Locale	getLocale()
atg.servlet.LocaleToCharsetMapper	getLocaleToCharsetMapper()
atg.servlet.DynamoHttpServletResponse	getOriginalResponse()
javax.servlet.ServletOutputStream	getOutputStream()
javax.servlet.http.HttpServletResponse	getResponse()
int	getStatus()
javax.servlet.ServletResponseWrapper	getWrapper()
java.io.PrintWriter	getWriter()
int	hashCode()
boolean	isCommitted()
boolean	isResponseComplete()
boolean	isWriterUsed()
void	reset()
void	resetBuffer()
void	sendError(int pCode)
void	sendError(int pCode, java.lang.String pMessage)
void	sendLocalRedirect(java.lang.String pLocation, atg.servlet.DynamoHttpServletRequest pRequest) Intercepts the sendLocalRedirect call and throws a RestRuntimeException.
void	sendRedirect(java.lang.String pLocation) Intercepts the sendRedirect call and throws a RestRuntimeException.
void	setBufferSize(int pBufferSize)
void	setCharacterEncoding(java.lang.String pCharset)
void	setContentLength(int pLength)
void	setContentType(java.lang.String pContentType)
void	setContentTypeSet(boolean pContentTypeSet)
void	setDateHeader(java.lang.String pName, long pValue)
void	setDoExitTracking(boolean pDoExitTracking)
void	setHeader(java.lang.String pName, java.lang.String pValue)
void	setIntHeader(java.lang.String pName, int pValue)
void	setLocale(java.util.Locale pLocale)
void	setLocaleToCharsetMapper(atg.servlet.LocaleToCharsetMapper pMapper)
void	setOriginalResponse(atg.servlet.DynamoHttpServletResponse pOriginalResponse)
void	setOutputStream(javax.servlet.ServletOutputStream pOutputStream)
void	setRequest(atg.servlet.DynamoHttpServletRequest pRequest)
void	setResponse(javax.servlet.http.HttpServletResponse pResponse)
void	setStatus(int pCode)
void	setStatus(int pCode, java.lang.String pMessage) Deprecated.
boolean	setStrictOutputAccess(boolean pStrict)
void	setWrapper(javax.servlet.ServletResponseWrapper pWrapper)
void	setWriter(java.io.PrintWriter pWriter)
java.lang.String	toString()

Methods inherited from class atg.servlet.DynamoHttpServletResponse

isOutputStreamRetrieved, isOutputStreamUsed, setAllowChangeHeadersDuringInclude

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

IGNORE_REDIRECT

public static final java.lang.String IGNORE_REDIRECT

redirects to this location will be ignored, no warning displayed

See Also:

Constant Field Values

Constructor Detail

RestHttpServletResponseWrapper

public RestHttpServletResponseWrapper(atg.servlet.DynamoHttpServletResponse pResponse)

Constructor

Method Detail

getOriginalResponse

public atg.servlet.DynamoHttpServletResponse getOriginalResponse()

Returns:

the value of originalResponse

setOriginalResponse

public void setOriginalResponse(atg.servlet.DynamoHttpServletResponse pOriginalResponse)

Parameters:

pOriginalResponse - the originalResponse to set

addCookie

public void addCookie(javax.servlet.http.Cookie pCookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCookie -

See Also:

DynamoHttpServletResponse.addCookie(javax.servlet.http.Cookie)

addCookieToBuffer

public void addCookieToBuffer(javax.servlet.http.Cookie pCookie)

Overrides:

addCookieToBuffer in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCookie -

See Also:

DynamoHttpServletResponse.addCookieToBuffer(javax.servlet.http.Cookie)

addDateHeader

public void addDateHeader(java.lang.String pName,
                          long pValue)

Specified by:

addDateHeader in interface atg.servlet.AddHeaderHttpServletResponse

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.addDateHeader(java.lang.String, long)

addHeader

public void addHeader(java.lang.String pName,
                      java.lang.String pValue)

Specified by:

addHeader in interface atg.servlet.AddHeaderHttpServletResponse

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.addHeader(java.lang.String, java.lang.String)

addIntHeader

public void addIntHeader(java.lang.String pName,
                         int pValue)

Specified by:

addIntHeader in interface atg.servlet.AddHeaderHttpServletResponse

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.addIntHeader(java.lang.String, int)

containsHeader

public boolean containsHeader(java.lang.String pName)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

Returns:

See Also:

DynamoHttpServletResponse.containsHeader(java.lang.String)

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String pUrl)

Deprecated.

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectUrl in class atg.servlet.DynamoHttpServletResponse

Parameters:

pUrl -

Returns:

See Also:

DynamoHttpServletResponse.encodeRedirectUrl(java.lang.String)

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String pUrl)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectURL in class atg.servlet.DynamoHttpServletResponse

Parameters:

pUrl -

Returns:

See Also:

DynamoHttpServletResponse.encodeRedirectURL(java.lang.String)

encodeUrl

public java.lang.String encodeUrl(java.lang.String pUrl)

Deprecated.

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeUrl in class atg.servlet.DynamoHttpServletResponse

Parameters:

pUrl -

Returns:

See Also:

DynamoHttpServletResponse.encodeUrl(java.lang.String)

encodeURL

public java.lang.String encodeURL(java.lang.String pUrl)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeURL in class atg.servlet.DynamoHttpServletResponse

Parameters:

pUrl -

Returns:

See Also:

DynamoHttpServletResponse.encodeURL(java.lang.String)

equals

public boolean equals(java.lang.Object pObj)

Overrides:

equals in class java.lang.Object

Parameters:

pObj -

Returns:

See Also:

Object.equals(java.lang.Object)

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class atg.servlet.DynamoHttpServletResponse

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.flushBuffer()

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

Overrides:

getBufferSize in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getBufferSize()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface atg.servlet.CharacterEncodable

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

getCharacterEncoding in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getCharacterEncoding()

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getContentType()

getContentTypeSet

public boolean getContentTypeSet()

Overrides:

getContentTypeSet in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getContentTypeSet()

getDoExitTracking

public boolean getDoExitTracking()

Overrides:

getDoExitTracking in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getDoExitTracking()

getHeaders

public java.util.Dictionary getHeaders()

Overrides:

getHeaders in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getHeaders()

getHeaders

public java.util.Enumeration getHeaders(java.lang.String pHeaderName)

Overrides:

getHeaders in class atg.servlet.DynamoHttpServletResponse

Parameters:

pHeaderName -

Returns:

See Also:

DynamoHttpServletResponse.getHeaders(java.lang.String)

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

Overrides:

getLocale in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getLocale()

getLocaleToCharsetMapper

public atg.servlet.LocaleToCharsetMapper getLocaleToCharsetMapper()

Overrides:

getLocaleToCharsetMapper in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getLocaleToCharsetMapper()

getOutputStream

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

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class atg.servlet.DynamoHttpServletResponse

Returns:

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.getOutputStream()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Overrides:

getResponse in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getResponse()

getStatus

public int getStatus()

Overrides:

getStatus in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getStatus()

getWrapper

public javax.servlet.ServletResponseWrapper getWrapper()

Overrides:

getWrapper in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.getWrapper()

getWriter

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

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class atg.servlet.DynamoHttpServletResponse

Returns:

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.getWriter()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

See Also:

Object.hashCode()

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Overrides:

isCommitted in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.isCommitted()

isResponseComplete

public boolean isResponseComplete()

Overrides:

isResponseComplete in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.isResponseComplete()

isWriterUsed

public boolean isWriterUsed()

Overrides:

isWriterUsed in class atg.servlet.DynamoHttpServletResponse

Returns:

See Also:

DynamoHttpServletResponse.isWriterUsed()

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class atg.servlet.DynamoHttpServletResponse

See Also:

DynamoHttpServletResponse.reset()

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

Overrides:

resetBuffer in class atg.servlet.DynamoHttpServletResponse

See Also:

DynamoHttpServletResponse.resetBuffer()

sendError

public void sendError(int pCode,
                      java.lang.String pMessage)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCode -

pMessage -

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.sendError(int, java.lang.String)

sendError

public void sendError(int pCode)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCode -

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.sendError(int)

sendLocalRedirect

public void sendLocalRedirect(java.lang.String pLocation,
                              atg.servlet.DynamoHttpServletRequest pRequest)
                       throws java.io.IOException

Intercepts the sendLocalRedirect call and throws a RestRuntimeException.

Overrides:

sendLocalRedirect in class atg.servlet.DynamoHttpServletResponse

Parameters:

pLocation -

pRequest -

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.sendLocalRedirect(java.lang.String, atg.servlet.DynamoHttpServletRequest)

sendRedirect

public void sendRedirect(java.lang.String pLocation)
                  throws java.io.IOException

Intercepts the sendRedirect call and throws a RestRuntimeException.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class atg.servlet.DynamoHttpServletResponse

Parameters:

pLocation -

Throws:

java.io.IOException

See Also:

DynamoHttpServletResponse.sendRedirect(java.lang.String)

setBufferSize

public void setBufferSize(int pBufferSize)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

Overrides:

setBufferSize in class atg.servlet.DynamoHttpServletResponse

Parameters:

pBufferSize -

See Also:

DynamoHttpServletResponse.setBufferSize(int)

setCharacterEncoding

public void setCharacterEncoding(java.lang.String pCharset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

setCharacterEncoding in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCharset -

See Also:

DynamoHttpServletResponse.setCharacterEncoding(java.lang.String)

setContentLength

public void setContentLength(int pLength)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class atg.servlet.DynamoHttpServletResponse

Parameters:

pLength -

See Also:

DynamoHttpServletResponse.setContentLength(int)

setContentType

public void setContentType(java.lang.String pContentType)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class atg.servlet.DynamoHttpServletResponse

Parameters:

pContentType -

See Also:

DynamoHttpServletResponse.setContentType(java.lang.String)

setContentTypeSet

public void setContentTypeSet(boolean pContentTypeSet)

Overrides:

setContentTypeSet in class atg.servlet.DynamoHttpServletResponse

Parameters:

pContentTypeSet -

See Also:

DynamoHttpServletResponse.setContentTypeSet(boolean)

setDateHeader

public void setDateHeader(java.lang.String pName,
                          long pValue)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.setDateHeader(java.lang.String, long)

setDoExitTracking

public void setDoExitTracking(boolean pDoExitTracking)

Overrides:

setDoExitTracking in class atg.servlet.DynamoHttpServletResponse

Parameters:

pDoExitTracking -

See Also:

DynamoHttpServletResponse.setDoExitTracking(boolean)

setHeader

public void setHeader(java.lang.String pName,
                      java.lang.String pValue)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.setHeader(java.lang.String, java.lang.String)

setIntHeader

public void setIntHeader(java.lang.String pName,
                         int pValue)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class atg.servlet.DynamoHttpServletResponse

Parameters:

pName -

pValue -

See Also:

DynamoHttpServletResponse.setIntHeader(java.lang.String, int)

setLocale

public void setLocale(java.util.Locale pLocale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class atg.servlet.DynamoHttpServletResponse

Parameters:

pLocale -

See Also:

DynamoHttpServletResponse.setLocale(java.util.Locale)

setLocaleToCharsetMapper

public void setLocaleToCharsetMapper(atg.servlet.LocaleToCharsetMapper pMapper)

Overrides:

setLocaleToCharsetMapper in class atg.servlet.DynamoHttpServletResponse

Parameters:

pMapper -

See Also:

DynamoHttpServletResponse.setLocaleToCharsetMapper(atg.servlet.LocaleToCharsetMapper)

setOutputStream

public void setOutputStream(javax.servlet.ServletOutputStream pOutputStream)

Overrides:

setOutputStream in class atg.servlet.DynamoHttpServletResponse

Parameters:

pOutputStream -

See Also:

DynamoHttpServletResponse.setOutputStream(javax.servlet.ServletOutputStream)

setRequest

public void setRequest(atg.servlet.DynamoHttpServletRequest pRequest)

Overrides:

setRequest in class atg.servlet.DynamoHttpServletResponse

Parameters:

pRequest -

See Also:

DynamoHttpServletResponse.setRequest(atg.servlet.DynamoHttpServletRequest)

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse pResponse)

Overrides:

setResponse in class atg.servlet.DynamoHttpServletResponse

Parameters:

pResponse -

See Also:

DynamoHttpServletResponse.setResponse(javax.servlet.http.HttpServletResponse)

setStatus

public void setStatus(int pCode,
                      java.lang.String pMessage)

Deprecated.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCode -

pMessage -

See Also:

DynamoHttpServletResponse.setStatus(int, java.lang.String)

setStatus

public void setStatus(int pCode)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class atg.servlet.DynamoHttpServletResponse

Parameters:

pCode -

See Also:

DynamoHttpServletResponse.setStatus(int)

setStrictOutputAccess

public boolean setStrictOutputAccess(boolean pStrict)

Overrides:

setStrictOutputAccess in class atg.servlet.DynamoHttpServletResponse

Parameters:

pStrict -

Returns:

See Also:

DynamoHttpServletResponse.setStrictOutputAccess(boolean)

setWrapper

public void setWrapper(javax.servlet.ServletResponseWrapper pWrapper)

Overrides:

setWrapper in class atg.servlet.DynamoHttpServletResponse

Parameters:

pWrapper -

See Also:

DynamoHttpServletResponse.setWrapper(javax.servlet.ServletResponseWrapper)

setWriter

public void setWriter(java.io.PrintWriter pWriter)

Overrides:

setWriter in class atg.servlet.DynamoHttpServletResponse

Parameters:

pWriter -

See Also:

DynamoHttpServletResponse.setWriter(java.io.PrintWriter)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

See Also:

Object.toString()