org.hippoecm.hst.core.internal

Interface HstMutableRequestContext

All Superinterfaces:

HstRequestContext

All Known Implementing Classes:

GenericRequestContextWrapper, MockHstRequestContext

public interface HstMutableRequestContext
extends HstRequestContext

This is an INTERNAL USAGE ONLY API. Clients should not cast to these interfaces as they should never be used from client code

Method Summary

Modifier and Type	Method and Description
void	addComponentWindowFilter(HstComponentWindowFilter filter) Deprecated. since 2.30.02 (CMS 10.0.2). Instead, use spring bean 'org.hippoecm.hst.core.container.HstComponentWindowFilter.list' to add HstComponentWindowFilter items
void	clearObjectAndQueryManagers()
void	dispose() Dispose all the internal objects maintained for the current request processing state.
void	matchingFinished() Marks the HstRequestContext that its matching phase has been finished
void	setBaseURL(HstContainerURL baseURL)
void	setCachingObjectConverter(boolean enabled)
void	setCmsRequest(boolean cmsRequest)
void	setComponentFilterTags(Set<String> conditions) set the conditions that will trigger a component to be added to the component window hierarchy.
void	setComponentWindowFilters(List<HstComponentWindowFilter> filters) Sets the HstComponentWindowFilters on the HstRequestContext
void	setContainerConfiguration(ContainerConfiguration containerConfiguration)
void	setContentBeansTool(ContentBeansTool contentBeansTool) Sets ContentBeansTool instance for this request context
void	setFullyQualifiedURLs(boolean fullyQualifiedURLs)
void	setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)
void	setHstSiteMenus(HstSiteMenus siteMenus)
void	setHstSiteMenusManager(HstSiteMenusManager siteMenusManager)
void	setLinkCreator(HstLinkCreator linkCreator)
void	setLocales(List<Locale> locales) Sets the locales assocaited with this request.
void	setParameterInfoProxyFactory(HstParameterInfoProxyFactory parameterInfoProxyFactory)
void	setPathSuffix(String pathSuffix) Sets the path suffix
void	setPreferredLocale(Locale locale) Sets the preferred locale associated with this request.
void	setRenderHost(String renderHost) Sets a specific render host.
void	setResolvedMount(ResolvedMount resolvedMount)
void	setResolvedSiteMapItem(ResolvedSiteMapItem resolvedSiteMapItem)
void	setServletContext(javax.servlet.ServletContext servletContext)
void	setServletRequest(javax.servlet.http.HttpServletRequest servletRequest)
void	setServletResponse(javax.servlet.http.HttpServletResponse servletResponse)
void	setSession(javax.jcr.Session session)
void	setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)
void	setSubject(Subject subject)
void	setURLFactory(HstURLFactory urlFactory)

Methods inherited from interface org.hippoecm.hst.core.request.HstRequestContext

getAttribute, getAttributeNames, getAttributes, getBaseURL, getComponentFilterTags, getComponentWindowFilters, getContainerConfiguration, getContainerURLProvider, getContentBean, getContentBean, getContentBeansTool, getContextCredentialsProvider, getHstLinkCreator, getHstQueryManagerFactory, getHstSiteMenus, getLocales, getMount, getMount, getObjectBeanManager, getObjectBeanManager, getObjectConverter, getParameterInfoProxyFactory, getPathSuffix, getPreferredLocale, getQueryManager, getQueryManager, getRenderHost, getResolvedMount, getResolvedSiteMapItem, getServletContext, getServletRequest, getServletResponse, getSession, getSession, getSiteContentBaseBean, getSiteContentBasePath, getSiteMapMatcher, getSubject, getURLFactory, getVirtualHost, isCmsRequest, isFullyQualifiedURLs, isPreview, removeAttribute, setAttribute

Method Detail

setServletContext

void setServletContext(javax.servlet.ServletContext servletContext)

setServletRequest

void setServletRequest(javax.servlet.http.HttpServletRequest servletRequest)

setServletResponse

void setServletResponse(javax.servlet.http.HttpServletResponse servletResponse)

setSession

void setSession(javax.jcr.Session session)

setResolvedMount

void setResolvedMount(ResolvedMount resolvedMount)

setResolvedSiteMapItem

void setResolvedSiteMapItem(ResolvedSiteMapItem resolvedSiteMapItem)

setBaseURL

void setBaseURL(HstContainerURL baseURL)

setURLFactory

void setURLFactory(HstURLFactory urlFactory)

setSiteMapMatcher

void setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)

setLinkCreator

void setLinkCreator(HstLinkCreator linkCreator)

setParameterInfoProxyFactory

void setParameterInfoProxyFactory(HstParameterInfoProxyFactory parameterInfoProxyFactory)

setHstSiteMenus

void setHstSiteMenus(HstSiteMenus siteMenus)

setHstQueryManagerFactory

void setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)

setContainerConfiguration

void setContainerConfiguration(ContainerConfiguration containerConfiguration)

setSubject

void setSubject(Subject subject)

setPreferredLocale

void setPreferredLocale(Locale locale)

Sets the preferred locale associated with this request.

Parameters:

locale - The preferred locale associated with this request.

setLocales

void setLocales(List<Locale> locales)

Sets the locales assocaited with this request.

Parameters:

locales -

setPathSuffix

void setPathSuffix(String pathSuffix)

Sets the path suffix

Parameters:

pathSuffix -

setComponentFilterTags

void setComponentFilterTags(Set<String> conditions)

set the conditions that will trigger a component to be added to the component window hierarchy.

Parameters:

conditions - the Set of String conditions

addComponentWindowFilter

@Deprecated
void addComponentWindowFilter(HstComponentWindowFilter filter)

Deprecated. since 2.30.02 (CMS 10.0.2). Instead, use spring bean 'org.hippoecm.hst.core.container.HstComponentWindowFilter.list' to add HstComponentWindowFilter items

Adds the HstComponentWindowFilter to the HstRequestContext

Parameters:

filter - the HstComponentWindowFilter to be added to the HstRequestContext.getComponentWindowFilters()

setComponentWindowFilters

void setComponentWindowFilters(List<HstComponentWindowFilter> filters)

Sets the HstComponentWindowFilters on the HstRequestContext

Parameters:

filters - the HstComponentWindowFilters to be set for the HstRequestContext.getComponentWindowFilters()

setFullyQualifiedURLs

void setFullyQualifiedURLs(boolean fullyQualifiedURLs)

Parameters:

fullyQualifiedURLs - sets whether created URLs will be fully qualified

setRenderHost

void setRenderHost(String renderHost)

Sets a specific render host. This can be used to render the request as if host renderHost was the actual used host in the request.

Parameters:

renderHost - the host to be used for rendering

setCmsRequest

void setCmsRequest(boolean cmsRequest)

Parameters:

cmsRequest - when the request is a cmsRequest have this parameter equal to true

See Also:

HstRequestContext.isCmsRequest()

setContentBeansTool

void setContentBeansTool(ContentBeansTool contentBeansTool)

Sets ContentBeansTool instance for this request context

Parameters:

contentBeansTool -

setCachingObjectConverter

void setCachingObjectConverter(boolean enabled)

clearObjectAndQueryManagers

void clearObjectAndQueryManagers()

dispose

void dispose()

Dispose all the internal objects maintained for the current request processing state. After disposed, this request context will be in an illegal state to use.

matchingFinished

void matchingFinished()

Marks the HstRequestContext that its matching phase has been finished

setHstSiteMenusManager

void setHstSiteMenusManager(HstSiteMenusManager siteMenusManager)