org.hippoecm.hst.core.component
Class HstResponseImpl

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.hippoecm.hst.core.component.HstResponseImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, HstResponse

public class HstResponseImpl
extends javax.servlet.http.HttpServletResponseWrapper
implements HstResponse

Factory implementation for creating HTTP Response Wrappers

Version:

$Id: HstResponseImpl.java 32953 2012-02-14 21:44:26Z wko $

Field Summary

protected HstComponentWindow	componentWindow
protected String	redirectLocation
protected Map<String,String[]>	renderParameters
protected String	renderPath
protected javax.servlet.http.HttpServletRequest	request
protected HstRequestContext	requestContext
protected javax.servlet.http.HttpServletResponse	response
protected HstResponseState	responseState
protected HstResponse	topParentHstResponse

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

HstResponseImpl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, HstRequestContext requestContext, HstComponentWindow componentWindow, HstResponseState responseState, HstResponse topParentHstResponse)

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie) Adds the specified cookie to the response.
void	addDateHeader(String name, long date)
void	addHeadElement(Element element, String keyHint) Adds an header element property to the response.
void	addHeader(String name, String value)
void	addIntHeader(String name, int value)
void	addPreamble(Comment comment) Add a preamble comment node, which gets rendered at the beginning of the render window.
boolean	containsHeadElement(String keyHint) Asks if a property exists already or not.
boolean	containsHeader(String name)
HstURL	createActionURL() Creates a HST Action URL targeting the HstComponent.
Comment	createComment(String comment) Creates a comment element
HstURL	createComponentRenderingURL() Creates a HST component rendering URL targeting a specific HstComponent
Element	createElement(String tagName) Creates an element of the type specified to be used in the #addProperty(String, Element) method.
HstURL	createNavigationalURL(String pathInfo) Creates a HST Navigational Render URL
HstURL	createRenderURL() Creates a HST Render URL targeting the HstComponent.
HstURL	createResourceURL() Creates a HST Resource URL targeting the current HstComponent.
HstURL	createResourceURL(String referenceNamespace) Creates a HST Resource URL targeting the HstComponent indicated by referenceNamespace.
String	encodeRedirectUrl(String url)
String	encodeRedirectURL(String url)
String	encodeUrl(String url)
String	encodeURL(String url)
void	flushBuffer()
void	flushChildContent(String name) Flushes the buffer of child window.
void	forward(String pathInfo) Forwards the page request to pathInfo.
int	getBufferSize()
String	getCharacterEncoding()
List<String>	getChildContentNames() Returns the flushable child content window names.
String	getContentType()
List<Element>	getHeadElements() Retrieves header element list.
Locale	getLocale()
String	getNamespace() The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the HST-managed page.
javax.servlet.ServletOutputStream	getOutputStream()
String	getRedirectLocation()
Map<String,String[]>	getRenderParameters()
String	getRenderPath()
Element	getWrapperElement() Returns the wrapper element for the rendered content
PrintWriter	getWriter()
boolean	isCommitted()
boolean	isRendererSkipped() A normal HstResponseImpl never gets its renderer skipped
void	reset()
void	resetBuffer()
void	sendError(int errorCode) Sends an error response to the client using the specified status.
void	sendError(int errorCode, String errorMessage) Sends an error response to the client using the specified status.
void	sendRedirect(String redirectLocation) Sends a temporary redirect response to the client using the specified redirect location URL.
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)
void	setRenderParameter(String key, String value) Sets a String parameter for the rendering phase.
void	setRenderParameter(String key, String[] values) Sets a String parameter for the rendering phase.
void	setRenderParameters(Map<String,String[]> parameters) Sets a parameter map for the render request.
void	setRenderPath(String renderPath) Sets the renderPath dynamically.
void	setResponse(javax.servlet.http.HttpServletResponse response)
void	setServeResourcePath(String serveResourcePath) Sets the serveResourcePath dynamically.
void	setStatus(int statusCode) Sets the status code for this response.
void	setStatus(int statusCode, String message)
void	setWrapperElement(Element element) Sets wrapper element for the rendered content

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

Field Detail

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

requestContext

protected HstRequestContext requestContext

componentWindow

protected HstComponentWindow componentWindow

responseState

protected HstResponseState responseState

redirectLocation

protected String redirectLocation

renderParameters

protected Map<String,String[]> renderParameters

topParentHstResponse

protected HstResponse topParentHstResponse

renderPath

protected String renderPath

Constructor Detail

HstResponseImpl

public HstResponseImpl(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       HstRequestContext requestContext,
                       HstComponentWindow componentWindow,
                       HstResponseState responseState,
                       HstResponse topParentHstResponse)

Method Detail

createRenderURL

public HstURL createRenderURL()

Description copied from interface: HstResponse

Creates a HST Render URL targeting the HstComponent.

Specified by:

createRenderURL in interface HstResponse

Returns:

createNavigationalURL

public HstURL createNavigationalURL(String pathInfo)

Description copied from interface: HstResponse

Creates a HST Navigational Render URL

Specified by:

createNavigationalURL in interface HstResponse

Parameters:

pathInfo - the path to be navigated

Returns:

createComponentRenderingURL

public HstURL createComponentRenderingURL()

Description copied from interface: HstResponse

Creates a HST component rendering URL targeting a specific HstComponent

Specified by:

createComponentRenderingURL in interface HstResponse

Returns:

a component rendering ULR

createActionURL

public HstURL createActionURL()

Description copied from interface: HstResponse

Creates a HST Action URL targeting the HstComponent.

Specified by:

createActionURL in interface HstResponse

Returns:

createResourceURL

public HstURL createResourceURL()

Description copied from interface: HstResponse

Creates a HST Resource URL targeting the current HstComponent.

Specified by:

createResourceURL in interface HstResponse

Returns:

createResourceURL

public HstURL createResourceURL(String referenceNamespace)

Description copied from interface: HstResponse

Creates a HST Resource URL targeting the HstComponent indicated by referenceNamespace.

Specified by:

createResourceURL in interface HstResponse

Returns:

getNamespace

public String getNamespace()

Description copied from interface: HstResponse

The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the HST-managed page. The namespace value must be constant for the lifetime of the HstComponentWindow.

Specified by:

getNamespace in interface HstResponse

Returns:

setResponse

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

getRedirectLocation

public String getRedirectLocation()

addCookie

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

Description copied from interface: HstResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Note: Please be sure to set cookie path before adding cookie for safety like the following example:

Cookie cookie = new Cookie("testcookie", "testvalue");
 cookie.setPath("/");
 response.addCookie(cookie);
 

Sometimes, a user agent could not accept cookies when the response triggers page redirection with Set-Cookie header. It's possibly because it regards the state as an unverifiable transaction for some reason. By setting path, the cookie can be specified more as a subset of the current domain, and this makes sure that the cookie accepted safely by the user agent.

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Specified by:

addCookie in interface HstResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

cookie - the Cookie to return to the client

addDateHeader

public void addDateHeader(String name,
                          long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

addHeader

public void addHeader(String name,
                      String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

addIntHeader

public void addIntHeader(String name,
                         int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

containsHeader

public boolean containsHeader(String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class javax.servlet.http.HttpServletResponseWrapper

flushBuffer

public void flushBuffer()
                 throws IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Overrides:

flushBuffer in class javax.servlet.ServletResponseWrapper

Throws:

IOException

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

Overrides:

getBufferSize in class javax.servlet.ServletResponseWrapper

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

getCharacterEncoding in class javax.servlet.ServletResponseWrapper

getContentType

public String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

getLocale

public Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

Overrides:

getLocale in class javax.servlet.ServletResponseWrapper

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

IOException

getWriter

public PrintWriter getWriter()
                      throws IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

IOException

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

Overrides:

isCommitted in class javax.servlet.ServletResponseWrapper

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

Overrides:

reset in class javax.servlet.ServletResponseWrapper

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

Overrides:

resetBuffer in class javax.servlet.ServletResponseWrapper

sendError

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

Description copied from interface: HstResponse

Sends an error response to the client using the specified status.

Only in HstComponent.doAction(HstRequest, HstResponse), HstComponent.doBeforeRender(HstRequest, HstResponse) or HstComponent.doBeforeServeResource(HstRequest, HstResponse), the invocation on this method will be effective. If the invocation on this method is done in a view page during render phase, the invocation will be just ignored with no operation.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Specified by:

sendError in interface HstResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

errorCode - the error status code

errorMessage - the descriptive message

Throws:

IOException - If the response was committed

sendError

public void sendError(int errorCode)
               throws IOException

Description copied from interface: HstResponse

Sends an error response to the client using the specified status.

Only in HstComponent.doAction(HstRequest, HstResponse), HstComponent.doBeforeRender(HstRequest, HstResponse) or HstComponent.doBeforeServeResource(HstRequest, HstResponse), the invocation on this method will be effective. If the invocation on this method is done in a view page during render phase, the invocation will be just ignored with no operation.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Specified by:

sendError in interface HstResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

errorCode - the error status code

Throws:

IOException - If the response was committed

sendRedirect

public void sendRedirect(String redirectLocation)
                  throws IOException

Description copied from interface: HstResponse

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

When a component runs on a normal servlet environment, in either HstComponent.doAction(HstRequest, HstResponse) or HstComponent.doBeforeRender(HstRequest, HstResponse), the invocation on this method could be effective. If the invocation on this method is done in other methods, the invocation will be just ignored with no operation.

Meanwhile, when a component runs on a portal/portlet environment, in HstComponent.doAction(HstRequest, HstResponse), the invocation on this method is effective. However, in other methods including HstComponent.doBeforeRender(HstRequest, HstResponse), the invocation on this method will be just ignored. If the invocation on this method is done in other methods, the invocation will be just ignored with no operation.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Specified by:

sendRedirect in interface HstResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Parameters:

redirectLocation - the redirect location URL

Throws:

IOException

See Also:

javax.servlet.http,HttpServletResponse#sendRedirect(String)}

setBufferSize

public void setBufferSize(int size)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

Overrides:

setBufferSize in class javax.servlet.ServletResponseWrapper

setCharacterEncoding

public void setCharacterEncoding(String charset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

Overrides:

setCharacterEncoding in class javax.servlet.ServletResponseWrapper

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

setContentType

public void setContentType(String type)

Specified by:

setContentType in interface javax.servlet.ServletResponse

Overrides:

setContentType in class javax.servlet.ServletResponseWrapper

setDateHeader

public void setDateHeader(String name,
                          long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

setHeader

public void setHeader(String name,
                      String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

setIntHeader

public void setIntHeader(String name,
                         int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

setLocale

public void setLocale(Locale locale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

setStatus

public void setStatus(int statusCode,
                      String message)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int statusCode)

Description copied from interface: HstResponse

Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

If there are multiple HST components to invoke this method, then the last invocation will be applied.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Specified by:

setStatus in interface HstResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectUrl

public String encodeRedirectUrl(String url)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectUrl in class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectURL

public String encodeRedirectURL(String url)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectURL in class javax.servlet.http.HttpServletResponseWrapper

encodeUrl

public String encodeUrl(String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeUrl in class javax.servlet.http.HttpServletResponseWrapper

encodeURL

public String encodeURL(String url)

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeURL in class javax.servlet.http.HttpServletResponseWrapper

createElement

public Element createElement(String tagName)

Description copied from interface: HstResponse

Creates an element of the type specified to be used in the #addProperty(String, Element) method.

Specified by:

createElement in interface HstResponse

Parameters:

tagName - the tag name of the element

Returns:

DOM element with the tagName

createComment

public Comment createComment(String comment)

Description copied from interface: HstResponse

Creates a comment element

Specified by:

createComment in interface HstResponse

Parameters:

comment - the comment text

Returns:

Comment DOM element with the text as content

addHeadElement

public void addHeadElement(Element element,
                           String keyHint)

Description copied from interface: HstResponse

Adds an header element property to the response. If keyHint argument is provided and if a header element with the provided key hint already exists, then the element will be ignored. If the element is null the key is removed from the response. If these header values are intended to be transmitted to the client they should be set before the response is committed.

Specified by:

addHeadElement in interface HstResponse

getHeadElements

public List<Element> getHeadElements()

Description copied from interface: HstResponse

Retrieves header element list. This method is supposed to be invoked by the parent HstComponent to render some header tag elements in a non-portal environment. Under portal environment, this method is not supposed to be invoked because the header tag elements should be written by the portal. Under portal environment, the HstComponents can write some body tag fragments only. If a HstComponent contributes some header tag elements by invoking HstResponse.addHeadElement(Element, String), then the portal will write all the merged head tag elements finally.

Specified by:

getHeadElements in interface HstResponse

Returns:

List with head element items

containsHeadElement

public boolean containsHeadElement(String keyHint)

Description copied from interface: HstResponse

Asks if a property exists already or not. This method checks all the parent component reponses have the property.

Specified by:

containsHeadElement in interface HstResponse

Returns:

addPreamble

public void addPreamble(Comment comment)

Description copied from interface: HstResponse

Add a preamble comment node, which gets rendered at the beginning of the render window.

Specified by:

addPreamble in interface HstResponse

Parameters:

comment - the comment node

setWrapperElement

public void setWrapperElement(Element element)

Description copied from interface: HstResponse

Sets wrapper element for the rendered content

Specified by:

setWrapperElement in interface HstResponse

getWrapperElement

public Element getWrapperElement()

Description copied from interface: HstResponse

Returns the wrapper element for the rendered content

Specified by:

getWrapperElement in interface HstResponse

Returns:

setRenderParameter

public void setRenderParameter(String key,
                               String value)

Description copied from interface: HstResponse

Sets a String parameter for the rendering phase. These parameters will be accessible in all sub-sequent render calls via the HstRequest.getParameter call until a request is targeted to the Hst component. This method replaces all parameters with the given key. The given parameter do not need to be encoded prior to calling this method.

Specified by:

setRenderParameter in interface HstResponse

Parameters:

key - key of the render parameter

value - value of the render parameter

setRenderParameter

public void setRenderParameter(String key,
                               String[] values)

Description copied from interface: HstResponse

Sets a String parameter for the rendering phase. These parameters will be accessible in all sub-sequent render calls via the HstRequest.getParameter call until a request is targeted to the Hst component. This method replaces all parameters with the given key. The given parameter do not need to be encoded prior to calling this method.

Specified by:

setRenderParameter in interface HstResponse

Parameters:

key - key of the render parameter

values - values of the render parameters

setRenderParameters

public void setRenderParameters(Map<String,String[]> parameters)

Description copied from interface: HstResponse

Sets a parameter map for the render request. All previously set render parameters are cleared. These parameters will be accessible in all sub-sequent renderinrg phase via the HstRequest.getParameter call until a new request is targeted to the Hst component. The given parameters do not need to be encoded prior to calling this method. The Hst component should not modify the map any further after calling this method.

Specified by:

setRenderParameters in interface HstResponse

getRenderParameters

public Map<String,String[]> getRenderParameters()

setRenderPath

public void setRenderPath(String renderPath)

Description copied from interface: HstResponse

Sets the renderPath dynamically. Normally, the renderPath is set in the configuration, but it can be set dynamically in the HstComponent.doBeforeRender(HstRequest, HstResponse) method.

Specified by:

setRenderPath in interface HstResponse

getRenderPath

public String getRenderPath()

setServeResourcePath

public void setServeResourcePath(String serveResourcePath)

Description copied from interface: HstResponse

Sets the serveResourcePath dynamically. Normally, the serveResourcePath is set in the configuration, but it can be set dynamically in the HstComponent.doBeforeServeResource(HstRequest, HstResponse) method.

Specified by:

setServeResourcePath in interface HstResponse

flushChildContent

public void flushChildContent(String name)
                       throws IOException

Description copied from interface: HstResponse

Flushes the buffer of child window.

Note: the child content can be flushed only once. If it is already flushed, then the next invocations will not make any effect.

Specified by:

flushChildContent in interface HstResponse

Parameters:

name - the name of the child window

Throws:

IOException

getChildContentNames

public List<String> getChildContentNames()

Description copied from interface: HstResponse

Returns the flushable child content window names.

Specified by:

getChildContentNames in interface HstResponse

Returns:

forward

public void forward(String pathInfo)
             throws IOException

Description copied from interface: HstResponse

Forwards the page request to pathInfo.

Only in HstComponent.doBeforeRender(HstRequest, HstResponse), the invocation on this method will be effective. If the invocation on this method is done in a view page during render phase, the invocation will be just ignored with no operation.

Specified by:

forward in interface HstResponse

Parameters:

pathInfo - the path info to forward. It should start with a "/" and is relative to the root of your hst sitemap

Throws:

IOException - If the response was committed

isRendererSkipped

public boolean isRendererSkipped()

A normal HstResponseImpl never gets its renderer skipped

Specified by:

isRendererSkipped in interface HstResponse

Returns:

true when for this HstResponse the renderer won't be invoked