org.hippoecm.hst.core.container
Class AbstractValve

java.lang.Object
  org.hippoecm.hst.core.container.AbstractValve

All Implemented Interfaces:

Valve

Direct Known Subclasses:

ActionValve, AggregationValve, CleanupValve, CmsHostContextValve, CmsSecurityValve, ComponentRenderingValve, ContextResolvingValve, GenericResponseHeadersValve, InitializationValve, JaxrsRestServiceValve, JCRSessionStatefulConcurrencyValve, LocalizationValve, ResourceServingValve, SecurityValve, SiteMenusResolvingValve, SubjectBasedSessionValve

public abstract class AbstractValve
extends Object
implements Valve

AbstractValve

Version:

$Id: AbstractValve.java 28734 2011-06-28 20:55:01Z wko $

Field Summary

protected boolean	alwaysRedirectLocationToAbsoluteUrl
protected HstComponentFactory	componentFactory
protected HstComponentInvoker	componentInvoker
protected HstComponentWindowFactory	componentWindowFactory
protected ContainerConfiguration	containerConfiguration
protected PageErrorHandler	defaultPageErrorHandler
protected HstManager	hstManager
protected HstQueryManagerFactory	hstQueryManagerFactory
protected HstLinkCreator	linkCreator
protected static org.slf4j.Logger	log
protected HstRequestContextComponent	requestContextComponent
protected HstSiteMapMatcher	siteMapMatcher
protected HstSiteMenusManager	siteMenusManager
protected HstURLFactory	urlFactory

Constructor Summary

AbstractValve()

Method Summary

void	destroy() Called by the container to indicate to a valve that the valve is being taken out of service
protected HstComponentWindow	findComponentWindow(HstComponentWindow rootWindow, String windowReferenceNamespace)
protected HstComponentWindow	findErrorCodeSendingWindow(HstComponentWindow[] sortedComponentWindows)
HstComponentFactory	getComponentFactory()
HstComponentInvoker	getComponentInvoker()
HstComponentWindowFactory	getComponentWindowFactory()
ContainerConfiguration	getContainerConfiguration()
PageErrorHandler	getDefaultPageErrorHandler()
HstManager	getHstManager()
HstQueryManagerFactory	getHstQueryManagerFactory()
HstSiteMenusManager	getHstSiteMenusManager()
HstLinkCreator	getLinkCreator()
protected PageErrors	getPageErrors(HstComponentWindow[] sortedComponentWindows, boolean clearExceptions)
HstRequestContextComponent	getRequestContextComponent()
HstSiteMapMatcher	getSiteMapMatcher()
HstURLFactory	getUrlFactory()
protected PageErrorHandler.Status	handleComponentExceptions(PageErrors pageErrors, HstContainerConfig requestContainerConfig, HstComponentWindow window, HstRequest hstRequest, HstResponse hstResponse)
void	initialize() Initialize the valve before using in a pipeline.
abstract void	invoke(ValveContext context) Invoke this valve
boolean	isAlwaysRedirectLocationToAbsoluteUrl()
void	setAlwaysRedirectLocationToAbsoluteUrl(boolean alwaysRedirectLocationToAbsoluteUrl)
void	setComponentFactory(HstComponentFactory componentFactory)
void	setComponentInvoker(HstComponentInvoker componentInvoker)
void	setComponentWindowFactory(HstComponentWindowFactory componentWindowFactory)
void	setContainerConfiguration(ContainerConfiguration containerConfiguration)
void	setDefaultPageErrorHandler(PageErrorHandler defaultPageErrorHandler)
void	setHstManager(HstManager hstManager)
void	setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)
void	setLinkCreator(HstLinkCreator linkCreator)
void	setRequestContextComponent(HstRequestContextComponent requestContextComponent)
void	setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)
void	setSiteMenusManager(HstSiteMenusManager siteMenusManager)
void	setUrlFactory(HstURLFactory urlFactory)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

containerConfiguration

protected ContainerConfiguration containerConfiguration

hstManager

protected HstManager hstManager

siteMapMatcher

protected HstSiteMapMatcher siteMapMatcher

requestContextComponent

protected HstRequestContextComponent requestContextComponent

componentFactory

protected HstComponentFactory componentFactory

componentWindowFactory

protected HstComponentWindowFactory componentWindowFactory

componentInvoker

protected HstComponentInvoker componentInvoker

urlFactory

protected HstURLFactory urlFactory

linkCreator

protected HstLinkCreator linkCreator

siteMenusManager

protected HstSiteMenusManager siteMenusManager

hstQueryManagerFactory

protected HstQueryManagerFactory hstQueryManagerFactory

defaultPageErrorHandler

protected PageErrorHandler defaultPageErrorHandler

alwaysRedirectLocationToAbsoluteUrl

protected boolean alwaysRedirectLocationToAbsoluteUrl

Constructor Detail

AbstractValve

public AbstractValve()

Method Detail

getContainerConfiguration

public ContainerConfiguration getContainerConfiguration()

setContainerConfiguration

public void setContainerConfiguration(ContainerConfiguration containerConfiguration)

getHstManager

public HstManager getHstManager()

setHstManager

public void setHstManager(HstManager hstManager)

getSiteMapMatcher

public HstSiteMapMatcher getSiteMapMatcher()

setSiteMapMatcher

public void setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)

getRequestContextComponent

public HstRequestContextComponent getRequestContextComponent()

setRequestContextComponent

public void setRequestContextComponent(HstRequestContextComponent requestContextComponent)

getComponentFactory

public HstComponentFactory getComponentFactory()

setComponentFactory

public void setComponentFactory(HstComponentFactory componentFactory)

getComponentWindowFactory

public HstComponentWindowFactory getComponentWindowFactory()

setComponentWindowFactory

public void setComponentWindowFactory(HstComponentWindowFactory componentWindowFactory)

getComponentInvoker

public HstComponentInvoker getComponentInvoker()

setComponentInvoker

public void setComponentInvoker(HstComponentInvoker componentInvoker)

getUrlFactory

public HstURLFactory getUrlFactory()

setUrlFactory

public void setUrlFactory(HstURLFactory urlFactory)

getLinkCreator

public HstLinkCreator getLinkCreator()

setLinkCreator

public void setLinkCreator(HstLinkCreator linkCreator)

setSiteMenusManager

public void setSiteMenusManager(HstSiteMenusManager siteMenusManager)

getHstSiteMenusManager

public HstSiteMenusManager getHstSiteMenusManager()

getHstQueryManagerFactory

public HstQueryManagerFactory getHstQueryManagerFactory()

setHstQueryManagerFactory

public void setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)

getDefaultPageErrorHandler

public PageErrorHandler getDefaultPageErrorHandler()

setDefaultPageErrorHandler

public void setDefaultPageErrorHandler(PageErrorHandler defaultPageErrorHandler)

invoke

public abstract void invoke(ValveContext context)
                     throws ContainerException

Description copied from interface: Valve

Invoke this valve

Specified by:

invoke in interface Valve

Throws:

ContainerException

initialize

public void initialize()
                throws ContainerException

Description copied from interface: Valve

Initialize the valve before using in a pipeline.

Specified by:

initialize in interface Valve

Throws:

ContainerException

destroy

public void destroy()

Description copied from interface: Valve

Called by the container to indicate to a valve that the valve is being taken out of service

Specified by:

destroy in interface Valve

isAlwaysRedirectLocationToAbsoluteUrl

public boolean isAlwaysRedirectLocationToAbsoluteUrl()

setAlwaysRedirectLocationToAbsoluteUrl

public void setAlwaysRedirectLocationToAbsoluteUrl(boolean alwaysRedirectLocationToAbsoluteUrl)

findComponentWindow

protected HstComponentWindow findComponentWindow(HstComponentWindow rootWindow,
                                                 String windowReferenceNamespace)

findErrorCodeSendingWindow

protected HstComponentWindow findErrorCodeSendingWindow(HstComponentWindow[] sortedComponentWindows)

getPageErrors

protected PageErrors getPageErrors(HstComponentWindow[] sortedComponentWindows,
                                   boolean clearExceptions)

handleComponentExceptions

protected PageErrorHandler.Status handleComponentExceptions(PageErrors pageErrors,
                                                            HstContainerConfig requestContainerConfig,
                                                            HstComponentWindow window,
                                                            HstRequest hstRequest,
                                                            HstResponse hstResponse)