org.hippoecm.hst.core.container
Interface HstComponentInvoker

All Known Implementing Classes:
HstComponentInvokerImpl

public interface HstComponentInvoker

HstComponent invoker component. The HstComponent container invokes HstComponents via this invoker.

Version:
$Id: HstComponentInvoker.java 17024 2009-03-19 11:10:51Z wko $

Method Summary
 void invokeAction(HstContainerConfig requestContainerConfig, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
          Invokes the HstComponent.doAction(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.
 void invokeBeforeRender(HstContainerConfig requestContainerConfig, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
          Invokes the HstComponent.doBeforeRender(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.
 void invokeBeforeServeResource(HstContainerConfig requestContainerConfig, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
          Invokes the HstComponent.doBeforeServeResource(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.
 void invokeRender(HstContainerConfig requestContainerConfig, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
          Dispatches to the renderpath of the HstComponent.
 void invokeServeResource(HstContainerConfig requestContainerConfig, javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
          Dispatches to the serveresourcepath of the HstComponent.
 

Method Detail

invokeAction

void invokeAction(HstContainerConfig requestContainerConfig,
                  javax.servlet.ServletRequest servletRequest,
                  javax.servlet.ServletResponse servletResponse)
                  throws ContainerException
Invokes the HstComponent.doAction(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.

Parameters:
requestContainerConfig - the HstComponent container configuration
servletRequest - the request
servletResponse - the response
Throws:
ContainerException

invokeBeforeRender

void invokeBeforeRender(HstContainerConfig requestContainerConfig,
                        javax.servlet.ServletRequest servletRequest,
                        javax.servlet.ServletResponse servletResponse)
                        throws ContainerException
Invokes the HstComponent.doBeforeRender(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.

Parameters:
requestContainerConfig - the HstComponent container configuration
servletRequest - the request
servletResponse - the response
Throws:
ContainerException

invokeRender

void invokeRender(HstContainerConfig requestContainerConfig,
                  javax.servlet.ServletRequest servletRequest,
                  javax.servlet.ServletResponse servletResponse)
                  throws ContainerException
Dispatches to the renderpath of the HstComponent. If the component sets renderpath dynamically in its HstComponent.doBeforeRender(org.hippoecm.hst.core.component.HstRequest, HstResponse) method by invoking HstResponse.setRenderPath(String), then the HstComponentInvoker will dispatch to the renderpath which is set by the method. Otherwise, it retrieves the renderpath from the component configuration to try dispatching.

Parameters:
requestContainerConfig - the HstComponent container configuration
servletRequest - the request
servletResponse - the response
Throws:
ContainerException

invokeBeforeServeResource

void invokeBeforeServeResource(HstContainerConfig requestContainerConfig,
                               javax.servlet.ServletRequest servletRequest,
                               javax.servlet.ServletResponse servletResponse)
                               throws ContainerException
Invokes the HstComponent.doBeforeServeResource(org.hippoecm.hst.core.component.HstRequest, HstResponse) method.

Parameters:
requestContainerConfig - the HstComponent container configuration
servletRequest - the request
servletResponse - the response
Throws:
ContainerException

invokeServeResource

void invokeServeResource(HstContainerConfig requestContainerConfig,
                         javax.servlet.ServletRequest servletRequest,
                         javax.servlet.ServletResponse servletResponse)
                         throws ContainerException
Dispatches to the serveresourcepath of the HstComponent. If the component sets serveresourcepath dynamically in its HstComponent.doBeforeServeResource(org.hippoecm.hst.core.component.HstRequest, HstResponse) method by invoking HstResponse.setServeResourcePath(String), then the HstComponentInvoker will dispatch to the serveresourcepath which is set by the method. Otherwise, it retrieves the serveresourcepath from the component configuration to try dispatching. If it cannot find the configuration in the component configuration, then it will try dispatching to the renderpath instead.

Parameters:
requestContainerConfig - the HstComponent container configuration
servletRequest - the request
servletResponse - the response
Throws:
ContainerException


Copyright © 2008-2012 Hippo. All Rights Reserved.