org.hippoecm.hst.core.component

Class HstServletResponseState

java.lang.Object

org.hippoecm.hst.core.component.HstServletResponseState

All Implemented Interfaces:

HstResponseState

public class HstServletResponseState
extends Object
implements HstResponseState

Temporarily holds the current state of a HST response

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<String>>	addedHeaders
protected ByteArrayOutputStream	byteOutputBuffer
protected String	characterEncoding
protected org.hippoecm.hst.core.component.HstServletResponseState.CharArrayWriterBuffer	charOutputBuffer
protected boolean	closed
protected boolean	committed
protected int	contentLength
protected String	contentType
protected List<javax.servlet.http.Cookie>	cookies
protected Locale	defaultLocale
protected List<Comment>	epilogueComments
protected int	errorCode
protected String	errorMessage
protected boolean	flushed
protected boolean	hasError
protected boolean	hasStatus
protected List<KeyValue<String,Element>>	headElements
protected boolean	isActionResponse
protected boolean	isMimeResponse
protected boolean	isRenderResponse
protected boolean	isResourceResponse
protected boolean	isStateAwareResponse
protected Locale	locale
protected javax.servlet.ServletOutputStream	outputStream
protected javax.servlet.http.HttpServletResponse	parentResponse
protected List<Comment>	preambleComments
protected List<Element>	preambleElements
protected PrintWriter	printWriter
protected List<Element>	processedElements
protected javax.servlet.http.HttpServletRequest	request
protected boolean	setContentTypeAfterEncoding
protected Map<String,List<String>>	setHeaders
protected int	statusCode
protected HstComponentWindow	window
protected Element	wrapperElement

Constructor Summary

Constructors

Constructor and Description
HstServletResponseState(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse parentResponse, HstComponentWindow window)

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(String name, long date)
void	addEpilogueNode(Comment comment)
void	addHeadElement(Element element, String keyHint)
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
void	addPreambleNode(Comment comment)
void	addPreambleNode(Element element) Preamble Nodes are written before the rest of the content of this HstResponseState.
void	addProcessedHeadElement(Element headElement)
protected void	addResponseCookie(javax.servlet.http.Cookie cookie)
protected void	addResponseHeader(String name, String value)
void	clear()
boolean	containsHeadElement(String keyHint)
boolean	containsHeader(String name)
Comment	createComment(String comment)
Element	createElement(String tagName)
protected void	failIfCommitted()
void	flush()
void	flush(Writer writer)
void	flushBuffer()
void	forward(String pathInfo)
protected List<String>	getAddedHeaderList(String name, boolean create)
int	getBufferSize()
String	getCharacterEncoding()
String	getContentType()
int	getErrorCode()
String	getErrorMessage()
String	getForwardPathInfo()
List<Element>	getHeadElements()
Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
protected Writer	getParentWriter() After invoking this method, the backing http servlet response becomes committed.
String	getRedirectLocation()
protected OutputStream	getResponseOutputStream()
protected PrintWriter	getResponseWriter()
protected List<String>	getSetHeaderList(String name, boolean create)
int	getStatus()
Element	getWrapperElement()
PrintWriter	getWriter()
boolean	isActionResponse()
boolean	isCommitted()
boolean	isFlushed()
boolean	isMimeResponse()
boolean	isRenderResponse()
boolean	isResourceResponse()
boolean	isStateAwareResponse()
void	reset()
void	resetBuffer()
void	sendError(int errorCode)
void	sendError(int errorCode, String errorMessage)
void	sendRedirect(String redirectLocation)
void	setBufferSize(int size)
void	setCharacterEncoding(String charset)
void	setContentLength(int len)
void	setContentType(String type)
void	setDateHeader(String name, long date)
void	setHeader(String name, String value)
void	setIntHeader(String name, int value)
void	setLocale(Locale locale)
protected void	setResponseCharacterEncoding(String characterEncoding)
protected void	setResponseContentLength(int len)
protected void	setResponseContentType(String contentType)
protected void	setResponseHeader(String name, String value)
protected void	setResponseLocale(Locale locale)
protected void	setResponseStatus(int status)
void	setStatus(int statusCode)
void	setStatus(int statusCode, String message)
void	setWrapperElement(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

isActionResponse

protected boolean isActionResponse

isRenderResponse

protected boolean isRenderResponse

isResourceResponse

protected boolean isResourceResponse

isMimeResponse

protected boolean isMimeResponse

isStateAwareResponse

protected boolean isStateAwareResponse

defaultLocale

protected Locale defaultLocale

flushed

protected boolean flushed

byteOutputBuffer

protected ByteArrayOutputStream byteOutputBuffer

charOutputBuffer

protected org.hippoecm.hst.core.component.HstServletResponseState.CharArrayWriterBuffer charOutputBuffer

outputStream

protected javax.servlet.ServletOutputStream outputStream

printWriter

protected PrintWriter printWriter

addedHeaders

protected Map<String,List<String>> addedHeaders

setHeaders

protected Map<String,List<String>> setHeaders

cookies

protected List<javax.servlet.http.Cookie> cookies

headElements

protected List<KeyValue<String,Element>> headElements

processedElements

protected List<Element> processedElements

preambleComments

protected List<Comment> preambleComments

preambleElements

protected List<Element> preambleElements

epilogueComments

protected List<Comment> epilogueComments

wrapperElement

protected Element wrapperElement

committed

protected boolean committed

hasStatus

protected boolean hasStatus

hasError

protected boolean hasError

locale

protected Locale locale

setContentTypeAfterEncoding

protected boolean setContentTypeAfterEncoding

closed

protected boolean closed

characterEncoding

protected String characterEncoding

contentLength

protected int contentLength

contentType

protected String contentType

errorCode

protected int errorCode

errorMessage

protected String errorMessage

statusCode

protected int statusCode

request

protected final javax.servlet.http.HttpServletRequest request

parentResponse

protected final javax.servlet.http.HttpServletResponse parentResponse

window

protected final HstComponentWindow window

Constructor Detail

HstServletResponseState

public HstServletResponseState(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse parentResponse,
                               HstComponentWindow window)

Method Detail

createElement

public Element createElement(String tagName)

Specified by:

createElement in interface HstResponseState

getAddedHeaderList

protected List<String> getAddedHeaderList(String name,
                                          boolean create)

getSetHeaderList

protected List<String> getSetHeaderList(String name,
                                        boolean create)

failIfCommitted

protected void failIfCommitted()

isActionResponse

public boolean isActionResponse()

Specified by:

isActionResponse in interface HstResponseState

isRenderResponse

public boolean isRenderResponse()

Specified by:

isRenderResponse in interface HstResponseState

isResourceResponse

public boolean isResourceResponse()

Specified by:

isResourceResponse in interface HstResponseState

isMimeResponse

public boolean isMimeResponse()

Specified by:

isMimeResponse in interface HstResponseState

isStateAwareResponse

public boolean isStateAwareResponse()

Specified by:

isStateAwareResponse in interface HstResponseState

addCookie

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

Specified by:

addCookie in interface HstResponseState

addDateHeader

public void addDateHeader(String name,
                          long date)

Specified by:

addDateHeader in interface HstResponseState

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface HstResponseState

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface HstResponseState

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface HstResponseState

sendError

public void sendError(int errorCode,
                      String errorMessage)
               throws IOException

Specified by:

sendError in interface HstResponseState

Throws:

IOException

sendError

public void sendError(int errorCode)
               throws IOException

Specified by:

sendError in interface HstResponseState

Throws:

IOException

getErrorCode

public int getErrorCode()

Specified by:

getErrorCode in interface HstResponseState

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface HstResponseState

sendRedirect

public void sendRedirect(String redirectLocation)
                  throws IOException

Specified by:

sendRedirect in interface HstResponseState

Throws:

IOException

getRedirectLocation

public String getRedirectLocation()

Specified by:

getRedirectLocation in interface HstResponseState

forward

public void forward(String pathInfo)
             throws IOException

Specified by:

forward in interface HstResponseState

Throws:

IOException

getForwardPathInfo

public String getForwardPathInfo()

Specified by:

getForwardPathInfo in interface HstResponseState

setDateHeader

public void setDateHeader(String name,
                          long date)

Specified by:

setDateHeader in interface HstResponseState

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface HstResponseState

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface HstResponseState

setStatus

public void setStatus(int statusCode,
                      String message)

Specified by:

setStatus in interface HstResponseState

setStatus

public void setStatus(int statusCode)

Specified by:

setStatus in interface HstResponseState

getStatus

public int getStatus()

Specified by:

getStatus in interface HstResponseState

Returns:

the status when set through HstResponseState.setStatus(int) and 0 if not set

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface HstResponseState

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface HstResponseState

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface HstResponseState

getContentType

public String getContentType()

Specified by:

getContentType in interface HstResponseState

getLocale

public Locale getLocale()

Specified by:

getLocale in interface HstResponseState

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface HstResponseState

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface HstResponseState

Throws:

IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface HstResponseState

reset

public void reset()

Specified by:

reset in interface HstResponseState

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface HstResponseState

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface HstResponseState

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface HstResponseState

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface HstResponseState

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface HstResponseState

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface HstResponseState

addHeadElement

public void addHeadElement(Element element,
                           String keyHint)

Specified by:

addHeadElement in interface HstResponseState

containsHeadElement

public boolean containsHeadElement(String keyHint)

Specified by:

containsHeadElement in interface HstResponseState

addProcessedHeadElement

public void addProcessedHeadElement(Element headElement)

Specified by:

addProcessedHeadElement in interface HstResponseState

getHeadElements

public List<Element> getHeadElements()

Specified by:

getHeadElements in interface HstResponseState

addPreambleNode

public void addPreambleNode(Comment comment)

Specified by:

addPreambleNode in interface HstResponseState

addPreambleNode

public void addPreambleNode(Element element)

Description copied from interface: HstResponseState

Preamble Nodes are written before the rest of the content of this HstResponseState. Note that from this element only the attributes and text of the element are printed, and *not* any descendant @link org.w3c.dom.Node}s of element

Specified by:

addPreambleNode in interface HstResponseState

Parameters:

element - the element that is a preamble

addEpilogueNode

public void addEpilogueNode(Comment comment)

Specified by:

addEpilogueNode in interface HstResponseState

setWrapperElement

public void setWrapperElement(Element element)

Specified by:

setWrapperElement in interface HstResponseState

getWrapperElement

public Element getWrapperElement()

Specified by:

getWrapperElement in interface HstResponseState

clear

public void clear()

Specified by:

clear in interface HstResponseState

flush

public void flush()
           throws IOException

Specified by:

flush in interface HstResponseState

Throws:

IOException

flush

public void flush(Writer writer)
           throws IOException

Specified by:

flush in interface HstResponseState

Throws:

IOException

isFlushed

public boolean isFlushed()

Specified by:

isFlushed in interface HstResponseState

createComment

public Comment createComment(String comment)

Specified by:

createComment in interface HstResponseState

setResponseLocale

protected void setResponseLocale(Locale locale)

getParentWriter

protected Writer getParentWriter()
                          throws IOException

After invoking this method, the backing http servlet response becomes committed. After this method gets invoked, not more response headers can be set and no redirect can be done any more

Throws:

IOException

addResponseCookie

protected void addResponseCookie(javax.servlet.http.Cookie cookie)

setResponseCharacterEncoding

protected void setResponseCharacterEncoding(String characterEncoding)

setResponseContentType

protected void setResponseContentType(String contentType)

addResponseHeader

protected void addResponseHeader(String name,
                                 String value)

setResponseHeader

protected void setResponseHeader(String name,
                                 String value)

setResponseStatus

protected void setResponseStatus(int status)

setResponseContentLength

protected void setResponseContentLength(int len)

getResponseOutputStream

protected OutputStream getResponseOutputStream()
                                        throws IOException

Throws:

IOException

getResponseWriter

protected PrintWriter getResponseWriter()
                                 throws IOException

Throws:

IOException