org.hippoecm.hst.core.container

Interface ValveContext

public interface ValveContext

Context information during invoking valves in a pipeline. This holds the necessary objects to serve a request.

Method Summary

Modifier and Type	Method and Description
PageCacheContext	getPageCacheContext() Returns the PageCacheContext for this valve context.
HstContainerConfig	getRequestContainerConfig() Returns the HstComponent container configuration.
HstRequestContext	getRequestContext() Returns the current request context.
HstComponentWindow	getRootComponentRenderingWindow() Returns the root HstComponentWindow instance to *render* the current request.
HstComponentWindow	getRootComponentWindow() Returns the root HstComponentWindow instance that is used to process the current request.
javax.servlet.http.HttpServletRequest	getServletRequest() Returns the current servlet request.
javax.servlet.http.HttpServletResponse	getServletResponse() Returns the current servlet response.
void	invokeNext() Requests invocation of next possible valve.
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse servletResponse) Deprecated. deprecated since 2.26.02. Use HstMutableRequestContext.setServletResponse(javax.servlet.http.HttpServletResponse) instead
void	setRootComponentRenderingWindow(HstComponentWindow rootComponentRenderingWindow) Sets the root HstComponentWindow instance to *render* the current request
void	setRootComponentWindow(HstComponentWindow rootComponentWindow) Sets the root HstComponentWindow instancethat is used to process the current request.

Method Detail

invokeNext

void invokeNext()
         throws ContainerException

Requests invocation of next possible valve.

Throws:

ContainerException

getRequestContainerConfig

HstContainerConfig getRequestContainerConfig()

Returns the HstComponent container configuration.

Returns:

the HstComponent container configuration.

getRequestContext

HstRequestContext getRequestContext()

Returns the current request context.

Returns:

the current request context.

getServletRequest

javax.servlet.http.HttpServletRequest getServletRequest()

Returns the current servlet request.

Returns:

the current servlet request.

getServletResponse

javax.servlet.http.HttpServletResponse getServletResponse()

Returns the current servlet response.

Returns:

the current servlet response.

setHttpServletResponse

@Deprecated
void setHttpServletResponse(javax.servlet.http.HttpServletResponse servletResponse)

Deprecated. deprecated since 2.26.02. Use HstMutableRequestContext.setServletResponse(javax.servlet.http.HttpServletResponse) instead

sets the HttpServletResponse for this ValveContext to servletResponse. This is typically useful when for example you want to wrap the response by some HttpServletResponseWrapper and use this wrapper response for further processing

Parameters:

servletResponse -

setRootComponentWindow

void setRootComponentWindow(HstComponentWindow rootComponentWindow)

Sets the root HstComponentWindow instancethat is used to process the current request.

Parameters:

rootComponentWindow -

getRootComponentWindow

HstComponentWindow getRootComponentWindow()

Returns the root HstComponentWindow instance that is used to process the current request. Note that in case of a action/resource/component-rendering request the root component is in general the targeted (for the action/resource/component-rendering) component

Returns:

the root HstComponentWindow instance that is used to process the current request.

setRootComponentRenderingWindow

void setRootComponentRenderingWindow(HstComponentWindow rootComponentRenderingWindow)

Sets the root HstComponentWindow instance to *render* the current request

Parameters:

rootComponentRenderingWindow -

getRootComponentRenderingWindow

HstComponentWindow getRootComponentRenderingWindow()

Returns the root HstComponentWindow instance to *render* the current request. By default, this returns the same HstComponentWindow as getRootComponentWindow(), unless it is explicitly set to a different HstComponentWindow. For example in case when you want to render only a single (or subtree) HstComponent of an entire HstComponent hierarchy.

The rootComponentRenderingWindow must always be a descendant of or the same as getRootComponentWindow()

getPageCacheContext

PageCacheContext getPageCacheContext()

Returns the PageCacheContext for this valve context. Individual Valves can access this PageCacheContext and append key information to the PageCacheContext.getPageCacheKey() or indicate that the request cannot be cached at all through PageCacheContext.markUncacheable()

Returns:

the PageCacheContext for this valve context and never null