atg.droplet

Class FormHandlerExecutor.DefaultDynamoHttpServletResponse

java.lang.Object

atg.servlet.DynamoHttpServletResponse

atg.droplet.FormHandlerExecutor.DefaultDynamoHttpServletResponse

All Implemented Interfaces:

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

Enclosing class:

FormHandlerExecutor

public class FormHandlerExecutor.DefaultDynamoHttpServletResponse
extends DynamoHttpServletResponse

Class for a default response to handle calls to the form handler. This implementation prevents the request from being redirected, capturing the URL instead. It will also capture any attempt to set the response status code and writes to the output stream.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletOutputStream	mOut
protected FormHandlerExecutor.FormHandlerInvocationResult	mResult

Fields inherited from class atg.servlet.DynamoHttpServletResponse

CLASS_VERSION, 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

Constructors

Constructor and Description
DefaultDynamoHttpServletResponse(javax.servlet.http.HttpServletResponse pHttpResponse) Constructor

Method Summary

Modifier and Type	Method and Description
FormHandlerExecutor.FormHandlerInvocationResult	getFormHandlerInvocationResult()
javax.servlet.ServletOutputStream	getOutputStream() Returns an output stream for writing response data.
int	getStatus() Returns the status code sent through this response object.
java.io.PrintWriter	getWriter() Returns the print writer for writing text response data
protected void	sendRedirect(java.lang.String pLocation, boolean pAllowAllURLs, int pCode) Sends a redirect response to the client using the specified redirect location URL.
void	setFormHandlerInvocationResult(FormHandlerExecutor.FormHandlerInvocationResult pResult)
void	setStatus(int pCode) Sets the status code and a default message for this response.

Methods inherited from class atg.servlet.DynamoHttpServletResponse

addCookie, addCookieAsHeader, addCookieToBuffer, addDateHeader, addHeader, addIntHeader, containsHeader, encodeLocalRedirectURL, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getContentTypeSet, getCookieString, getDoExitTracking, getHeaders, getHeaders, getLocale, getLocaleToCharsetMapper, getResponse, getWrapper, isCommitted, isOutputStreamRetrieved, isOutputStreamUsed, isResponseComplete, isWriterUsed, reset, resetBuffer, sendError, sendError, sendLocalPermanentRedirect, sendLocalRedirect, sendPermanentRedirect, sendRedirect, sendRedirect, setAllowChangeHeadersDuringInclude, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setContentTypeSet, setDateHeader, setDoExitTracking, setHeader, setIntHeader, setLocale, setLocaleToCharsetMapper, setOutputStream, setRequest, setResponse, setStatus, setStrictOutputAccess, setWrapper, setWriter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mResult

protected FormHandlerExecutor.FormHandlerInvocationResult mResult

mOut

protected javax.servlet.ServletOutputStream mOut

Constructor Detail

DefaultDynamoHttpServletResponse

public DefaultDynamoHttpServletResponse(javax.servlet.http.HttpServletResponse pHttpResponse)
                                 throws java.io.IOException

Constructor

Throws:

java.io.IOException

Method Detail

setFormHandlerInvocationResult

public void setFormHandlerInvocationResult(FormHandlerExecutor.FormHandlerInvocationResult pResult)

getFormHandlerInvocationResult

public FormHandlerExecutor.FormHandlerInvocationResult getFormHandlerInvocationResult()

getStatus

public int getStatus()

Description copied from class: DynamoHttpServletResponse

Returns the status code sent through this response object. If no status code has been set explicitly, SC_STATUS_OK is sent.

Overrides:

getStatus in class DynamoHttpServletResponse

setStatus

public void setStatus(int pCode)

Description copied from class: DynamoHttpServletResponse

Sets the status code and a default message for this response.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class DynamoHttpServletResponse

Parameters:

pCode - the status code

getWriter

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

Description copied from class: DynamoHttpServletResponse

Returns the print writer for writing text response data

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class DynamoHttpServletResponse

Throws:

java.io.IOException

getOutputStream

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

Description copied from class: DynamoHttpServletResponse

Returns an output stream for writing response data.

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class DynamoHttpServletResponse

Throws:

java.io.IOException - if an I/O exception has occurred

sendRedirect

protected void sendRedirect(java.lang.String pLocation,
                            boolean pAllowAllURLs,
                            int pCode)
                     throws java.io.IOException

Description copied from class: DynamoHttpServletResponse

Sends a redirect response to the client using the specified redirect location URL.

Servlet 2.3 requires that this method handle relative URLs so that's what we do when running in the DAS J2EE container. Here's how it says we're supposed to handle things:

• If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.
• If a partial URL is given and, for whatever reason, cannot be converted into a valid URL, then this method must throw an IllegalArgumentException.
• If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

If we're not in DAS-J2EE then the URL must be absolute (e.g., https://hostname/path/file.html). Relative URLs are not permitted here.

Overrides:

sendRedirect in class DynamoHttpServletResponse

Parameters:

pLocation - the redirect location URL

pAllowAllURLs - whether to allow all URLs, even non-local ones. By default, non-local URLs are validated by the redirectURLValidator.

pCode - (typically 301 or 302) The status code to use for the redirect.

Throws:

java.io.IOException - If an I/O error has occurred.