org.hippoecm.hst.mock.core.component

Class MockValveContext

java.lang.Object

org.hippoecm.hst.mock.core.component.MockValveContext

All Implemented Interfaces:

ValveContext

public class MockValveContext
extends Object
implements ValveContext

Constructor Summary

Constructors

Constructor and Description
MockValveContext(HstRequest request, HstResponse response)

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.
boolean	isNextValveInvoked()
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse servletResponse) sets the HttpServletResponse for this ValveContext to servletResponse.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockValveContext

public MockValveContext(HstRequest request,
                        HstResponse response)

Method Detail

invokeNext

public void invokeNext()
                throws ContainerException

Description copied from interface: ValveContext

Requests invocation of next possible valve.

Specified by:

invokeNext in interface ValveContext

Throws:

ContainerException

isNextValveInvoked

public boolean isNextValveInvoked()

getRequestContainerConfig

public HstContainerConfig getRequestContainerConfig()

Description copied from interface: ValveContext

Returns the HstComponent container configuration.

Specified by:

getRequestContainerConfig in interface ValveContext

Returns:

the HstComponent container configuration.

getRequestContext

public HstRequestContext getRequestContext()

Description copied from interface: ValveContext

Returns the current request context.

Specified by:

getRequestContext in interface ValveContext

Returns:

the current request context.

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

Description copied from interface: ValveContext

Returns the current servlet request.

Specified by:

getServletRequest in interface ValveContext

Returns:

the current servlet request.

getServletResponse

public javax.servlet.http.HttpServletResponse getServletResponse()

Description copied from interface: ValveContext

Returns the current servlet response.

Specified by:

getServletResponse in interface ValveContext

Returns:

the current servlet response.

setHttpServletResponse

public void setHttpServletResponse(javax.servlet.http.HttpServletResponse servletResponse)

Description copied from interface: ValveContext

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

Specified by:

setHttpServletResponse in interface ValveContext

setRootComponentWindow

public void setRootComponentWindow(HstComponentWindow rootComponentWindow)

Description copied from interface: ValveContext

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

Specified by:

setRootComponentWindow in interface ValveContext

getRootComponentWindow

public HstComponentWindow getRootComponentWindow()

Description copied from interface: ValveContext

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

Specified by:

getRootComponentWindow in interface ValveContext

Returns:

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

setRootComponentRenderingWindow

public void setRootComponentRenderingWindow(HstComponentWindow rootComponentRenderingWindow)

Description copied from interface: ValveContext

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

Specified by:

setRootComponentRenderingWindow in interface ValveContext

getRootComponentRenderingWindow

public HstComponentWindow getRootComponentRenderingWindow()

Description copied from interface: ValveContext

Returns the root HstComponentWindow instance to *render* the current request. By default, this returns the same HstComponentWindow as ValveContext.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 ValveContext.getRootComponentWindow()

Specified by:

getRootComponentRenderingWindow in interface ValveContext

getPageCacheContext

public PageCacheContext getPageCacheContext()

Description copied from interface: ValveContext

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()

Specified by:

getPageCacheContext in interface ValveContext

Returns:

the PageCacheContext for this valve context and never null