org.hippoecm.hst.mock.core.request

Class MockHstRequestContext

java.lang.Object

org.hippoecm.hst.mock.core.request.MockHstRequestContext

All Implemented Interfaces:

HstMutableRequestContext, HstRequestContext

public class MockHstRequestContext
extends Object
implements HstMutableRequestContext

Constructor Summary

Constructors

Constructor and Description
MockHstRequestContext()

Method Summary

Modifier and Type	Method and Description
void	addComponentWindowFilter(HstComponentWindowFilter filter) Adds the HstComponentWindowFilter to the HstRequestContext
void	addMount(String alias, Mount mount)
void	addMount(String type, String alias, Mount mount)
void	clearObjectAndQueryManagers()
void	dispose() Dispose all the internal objects maintained for the current request processing state.
Object	getAttribute(String name) Retrieve the attribute value by the attribute name.
Enumeration<String>	getAttributeNames() Enumerates the attribute names
Map<String,Object>	getAttributes() Returns attribute map which is unmodifiable.
HstContainerURL	getBaseURL() Returns the base container URL (HstContainerURL ) of the current request lifecycle.
Set<String>	getComponentFilterTags() Expert: The tags that will be used to render container items.
List<HstComponentWindowFilter>	getComponentWindowFilters() Expert: Option to add filters to the HstRequestContext.
ContainerConfiguration	getContainerConfiguration()
HstContainerURLProvider	getContainerURLProvider() Returns the HstContainerURLProvider to create HstContainerURLs
HippoBean	getContentBean() Returns the content HippoBean for this request.
<T extends HippoBean> T	getContentBean(Class<T> beanMappingClass) Returns same as HstRequestContext.getContentBean() but if the found HippoBean is not of type beanMappingClass, then null is returned.
ContentBeansTool	getContentBeansTool()
ContextCredentialsProvider	getContextCredentialsProvider() Returns the context credentials provider
javax.jcr.Credentials	getDefaultCredentials()
HstLinkCreator	getHstLinkCreator() Returns the HstLinkCreator to create navigational links
HstQueryManagerFactory	getHstQueryManagerFactory() Returns a HstQueryManagerFactory instance responsible for creating a query manager
HstSiteMenus	getHstSiteMenus()
Enumeration<Locale>	getLocales() Returns an Enumeration of Locale objects
Mount	getMount(String alias) a mount with Mount.getAlias() equal to alias and at least one common type with the mount from the current request.
Mount	getMount(String type, String alias) a mount with Mount.getAlias() equal to alias and one of its Mount.getTypes() equal to type.
ObjectBeanManager	getObjectBeanManager()
ObjectBeanManager	getObjectBeanManager(javax.jcr.Session session)
ObjectConverter	getObjectConverter() Returns the ObjectConverter for the current HstRequestContext.
HstParameterInfoProxyFactory	getParameterInfoProxyFactory() Expert: Returns HstParameterInfoProxyFactory to create a proxy for an interface that is referred to by a ParametersInfo annotation on a HstComponent annotated interface getters
String	getPathSuffix() Returns the path suffix from the resolved site map item.
Locale	getPreferredLocale() Gets the preferred locale associated with this request.
HstQueryManager	getQueryManager()
HstQueryManager	getQueryManager(javax.jcr.Session session)
String	getRenderHost()
ResolvedMount	getResolvedMount() Returns the ResolvedMount for this request
ResolvedSiteMapItem	getResolvedSiteMapItem() Returns the ResolvedSiteMapItem for this request
javax.servlet.ServletContext	getServletContext() Returns the ServletContext for this request
javax.servlet.http.HttpServletRequest	getServletRequest() Returns the current HttpServletRequest
javax.servlet.http.HttpServletResponse	getServletResponse() Returns the current HttpServletResponse
javax.jcr.Session	getSession() Returns a session which is normally retrieved from a session pooling repository.
javax.jcr.Session	getSession(boolean create) Returns a session which can be retrieved from a session pooling repository.
HippoBean	getSiteContentBaseBean() Returns the siteContentBaseBean HippoBean for this request.
String	getSiteContentBasePath()
HstSiteMapMatcher	getSiteMapMatcher() Returns the HstSiteMapMatcher to be able to match a path to a sitemap item
Subject	getSubject() Gets the subject associated with the authorized entity.
HstURLFactory	getURLFactory() Returns the HstURLFactory to create HstURLs
VirtualHost	getVirtualHost() Returns the matched virtual host object
boolean	isCmsRequest()
boolean	isFullyQualifiedURLs()
boolean	isPreview()
void	matchingFinished() Marks the HstRequestContext that its matching phase has been finished
void	removeAttribute(String name) Removes the attribute by the attribute name.
void	removeMount(String alias)
void	removeMount(String type, String alias)
void	setAttribute(String name, Object value) Set an attribute to be shared among each HstComponent windows.
void	setBaseURL(HstContainerURL baseURL)
void	setCachingObjectConverter(boolean enabled)
void	setCmsRequest(boolean cmsRequest)
void	setComponentFilterTags(Set<String> componentFilterTags) 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	setContentBean(HippoBean contentBean)
void	setContentBeansTool(ContentBeansTool contentBeansTool) Sets ContentBeansTool instance for this request context
void	setContextCredentialsProvider(ContextCredentialsProvider contextCredentialsProvider)
void	setDefaultCredentials(javax.jcr.Credentials defaultCredentials)
void	setDefaultHstQueryManager(HstQueryManager defaultHstQueryManager)
void	setDefaultObjectBeanManager(ObjectBeanManager defaultObjectBeanManager)
void	setFullyQualifiedURLs(boolean fullyQualifiedURLs)
void	setHstLinkCreator(HstLinkCreator linkCreator)
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	setNonDefaultHstQueryManagers(Map<javax.jcr.Session,HstQueryManager> nonDefaultHstQueryManagers)
void	setNonDefaultObjectBeanManagers(Map<javax.jcr.Session,ObjectBeanManager> nonDefaultObjectBeanManagers)
void	setParameterInfoProxyFactory(HstParameterInfoProxyFactory parameterInfoProxyFactory)
void	setPathSuffix(String pathSuffix) Sets the path suffix
void	setPreferredLocale(Locale preferredLocale) 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	setSiteContentBaseBean(HippoBean siteContentBean)
void	setSiteContentBasePath(String siteContentBasePath)
void	setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)
void	setSubject(Subject subject)
void	setURLFactory(HstURLFactory urlFactory)
void	setVirtualHost(VirtualHost virtualHost)

Methods inherited from class java.lang.Object

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

Constructor Detail

MockHstRequestContext

public MockHstRequestContext()

Method Detail

isPreview

public boolean isPreview()

Specified by:

isPreview in interface HstRequestContext

Returns:

true when this request is matched to a preview site

See Also:

Mount.isPreview()

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: HstRequestContext

Returns the ServletContext for this request

Specified by:

getServletContext in interface HstRequestContext

Returns:

the ServletContext for this request

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface HstMutableRequestContext

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

Description copied from interface: HstRequestContext

Returns the current HttpServletRequest

Specified by:

getServletRequest in interface HstRequestContext

Returns:

the current HttpServletRequest

setServletRequest

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

Specified by:

setServletRequest in interface HstMutableRequestContext

getServletResponse

public javax.servlet.http.HttpServletResponse getServletResponse()

Description copied from interface: HstRequestContext

Returns the current HttpServletResponse

Specified by:

getServletResponse in interface HstRequestContext

Returns:

the current HttpServletResponse

setServletResponse

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

Specified by:

setServletResponse in interface HstMutableRequestContext

getAttribute

public Object getAttribute(String name)

Description copied from interface: HstRequestContext

Retrieve the attribute value by the attribute name. Because this attribute is not prefixed by the reference namespace of the HstComponent window, this method can be used if the attribute is to be shared among HstComponent windows.

Specified by:

getAttribute in interface HstRequestContext

getAttributeNames

public Enumeration<String> getAttributeNames()

Description copied from interface: HstRequestContext

Enumerates the attribute names

Specified by:

getAttributeNames in interface HstRequestContext

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: HstRequestContext

Returns attribute map which is unmodifiable. So, do not try to put or remove items directly from the returned map.

Specified by:

getAttributes in interface HstRequestContext

Returns:

attribute map which is unmodifiable. So, do not try to put or remove items directly from the returned map.

getBaseURL

public HstContainerURL getBaseURL()

Description copied from interface: HstRequestContext

Returns the base container URL (HstContainerURL ) of the current request lifecycle.

Specified by:

getBaseURL in interface HstRequestContext

Returns:

HstContainerURL

setBaseURL

public void setBaseURL(HstContainerURL baseURL)

Specified by:

setBaseURL in interface HstMutableRequestContext

getDefaultCredentials

public javax.jcr.Credentials getDefaultCredentials()

setDefaultCredentials

public void setDefaultCredentials(javax.jcr.Credentials defaultCredentials)

getSiteMapMatcher

public HstSiteMapMatcher getSiteMapMatcher()

Description copied from interface: HstRequestContext

Returns the HstSiteMapMatcher to be able to match a path to a sitemap item

Specified by:

getSiteMapMatcher in interface HstRequestContext

Returns:

HstSiteMapMatcher

setSiteMapMatcher

public void setSiteMapMatcher(HstSiteMapMatcher siteMapMatcher)

Specified by:

setSiteMapMatcher in interface HstMutableRequestContext

getHstLinkCreator

public HstLinkCreator getHstLinkCreator()

Description copied from interface: HstRequestContext

Returns the HstLinkCreator to create navigational links

Specified by:

getHstLinkCreator in interface HstRequestContext

Returns:

HstLinkCreator

setHstLinkCreator

public void setHstLinkCreator(HstLinkCreator linkCreator)

getHstQueryManagerFactory

public HstQueryManagerFactory getHstQueryManagerFactory()

Description copied from interface: HstRequestContext

Returns a HstQueryManagerFactory instance responsible for creating a query manager

Specified by:

getHstQueryManagerFactory in interface HstRequestContext

Returns:

HstQueryManagerFactory

setHstQueryManagerFactory

public void setHstQueryManagerFactory(HstQueryManagerFactory hstQueryManagerFactory)

Specified by:

setHstQueryManagerFactory in interface HstMutableRequestContext

setHstSiteMenus

public void setHstSiteMenus(HstSiteMenus siteMenus)

Specified by:

setHstSiteMenus in interface HstMutableRequestContext

getHstSiteMenus

public HstSiteMenus getHstSiteMenus()

Specified by:

getHstSiteMenus in interface HstRequestContext

Returns:

the HstSiteMenus

getResolvedMount

public ResolvedMount getResolvedMount()

Description copied from interface: HstRequestContext

Returns the ResolvedMount for this request

Specified by:

getResolvedMount in interface HstRequestContext

Returns:

the ResolvedMount for this request

setResolvedMount

public void setResolvedMount(ResolvedMount resolvedMount)

Specified by:

setResolvedMount in interface HstMutableRequestContext

getResolvedSiteMapItem

public ResolvedSiteMapItem getResolvedSiteMapItem()

Description copied from interface: HstRequestContext

Returns the ResolvedSiteMapItem for this request

Specified by:

getResolvedSiteMapItem in interface HstRequestContext

Returns:

the resolvedSiteMapItem for this request

setResolvedSiteMapItem

public void setResolvedSiteMapItem(ResolvedSiteMapItem resolvedSiteMapItem)

Specified by:

setResolvedSiteMapItem in interface HstMutableRequestContext

setSession

public void setSession(javax.jcr.Session session)

Specified by:

setSession in interface HstMutableRequestContext

getSession

public javax.jcr.Session getSession()
                             throws javax.jcr.LoginException,
                                    javax.jcr.RepositoryException

Description copied from interface: HstRequestContext

Returns a session which is normally retrieved from a session pooling repository.

Returns the current javax.jcr.Session associated with this requestContext or, if if there is no current JCR session, creates and returns a new JCR session.

Specified by:

getSession in interface HstRequestContext

Returns:

a session, which is normally retrieved from a session pooling repository

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

getSession

public javax.jcr.Session getSession(boolean create)
                             throws javax.jcr.LoginException,
                                    javax.jcr.RepositoryException

Description copied from interface: HstRequestContext

Returns a session which can be retrieved from a session pooling repository.

Returns the current javax.jcr.Session associated with this requestContext or, if if there is no current JCR session and create is true, returns a new JCR session.

If create is false and the requestContext has no javax.jcr.Session, this method returns null.

Specified by:

getSession in interface HstRequestContext

Returns:

a session, which is normally retrieved from a session pooling repository

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

getURLFactory

public HstURLFactory getURLFactory()

Description copied from interface: HstRequestContext

Returns the HstURLFactory to create HstURLs

Specified by:

getURLFactory in interface HstRequestContext

Returns:

HstURLFactory

setURLFactory

public void setURLFactory(HstURLFactory urlFactory)

Specified by:

setURLFactory in interface HstMutableRequestContext

getParameterInfoProxyFactory

public HstParameterInfoProxyFactory getParameterInfoProxyFactory()

Description copied from interface: HstRequestContext

Expert: Returns HstParameterInfoProxyFactory to create a proxy for an interface that is referred to by a ParametersInfo annotation on a HstComponent annotated interface getters

Specified by:

getParameterInfoProxyFactory in interface HstRequestContext

Returns:

the HstParameterInfoProxyFactory

getContainerURLProvider

public HstContainerURLProvider getContainerURLProvider()

Description copied from interface: HstRequestContext

Returns the HstContainerURLProvider to create HstContainerURLs

Specified by:

getContainerURLProvider in interface HstRequestContext

Returns:

HstContainerURLProvider

removeAttribute

public void removeAttribute(String name)

Description copied from interface: HstRequestContext

Removes the attribute by the attribute name.

Specified by:

removeAttribute in interface HstRequestContext

setAttribute

public void setAttribute(String name,
                         Object value)

Description copied from interface: HstRequestContext

Set an attribute to be shared among each HstComponent windows. Because this attribute is not prefixed by the reference namespace of the HstComponent window, this method can be used if the attribute is to be shared among HstComponent windows.

Specified by:

setAttribute in interface HstRequestContext

Parameters:

name - attribute name

value - attribute value

getContainerConfiguration

public ContainerConfiguration getContainerConfiguration()

Specified by:

getContainerConfiguration in interface HstRequestContext

Returns:

Returns the ContainerConfiguration

setContainerConfiguration

public void setContainerConfiguration(ContainerConfiguration containerConfiguration)

Specified by:

setContainerConfiguration in interface HstMutableRequestContext

getVirtualHost

public VirtualHost getVirtualHost()

Description copied from interface: HstRequestContext

Returns the matched virtual host object

Specified by:

getVirtualHost in interface HstRequestContext

Returns:

the matched virtual host object

setVirtualHost

public void setVirtualHost(VirtualHost virtualHost)

getContextCredentialsProvider

public ContextCredentialsProvider getContextCredentialsProvider()

Description copied from interface: HstRequestContext

Returns the context credentials provider

Specified by:

getContextCredentialsProvider in interface HstRequestContext

Returns:

the context credentials provider

setContextCredentialsProvider

public void setContextCredentialsProvider(ContextCredentialsProvider contextCredentialsProvider)

getSubject

public Subject getSubject()

Description copied from interface: HstRequestContext

Gets the subject associated with the authorized entity.

Specified by:

getSubject in interface HstRequestContext

Returns:

The JAAS subject on this request.

setSubject

public void setSubject(Subject subject)

Specified by:

setSubject in interface HstMutableRequestContext

getPreferredLocale

public Locale getPreferredLocale()

Description copied from interface: HstRequestContext

Gets the preferred locale associated with this request.

Specified by:

getPreferredLocale in interface HstRequestContext

Returns:

The preferred locale associated with this request.

setPreferredLocale

public void setPreferredLocale(Locale preferredLocale)

Description copied from interface: HstMutableRequestContext

Sets the preferred locale associated with this request.

Specified by:

setPreferredLocale in interface HstMutableRequestContext

Parameters:

preferredLocale - The preferred locale associated with this request.

getLocales

public Enumeration<Locale> getLocales()

Description copied from interface: HstRequestContext

Returns an Enumeration of Locale objects

Specified by:

getLocales in interface HstRequestContext

Returns:

The locale associated with this request.

setLocales

public void setLocales(List<Locale> locales)

Description copied from interface: HstMutableRequestContext

Sets the locales assocaited with this request.

Specified by:

setLocales in interface HstMutableRequestContext

setPathSuffix

public void setPathSuffix(String pathSuffix)

Description copied from interface: HstMutableRequestContext

Sets the path suffix

Specified by:

setPathSuffix in interface HstMutableRequestContext

getPathSuffix

public String getPathSuffix()

Description copied from interface: HstRequestContext

Returns the path suffix from the resolved site map item. If it is null, then returns the path suffix from the resolved Mount.

Specified by:

getPathSuffix in interface HstRequestContext

Returns:

the matched path suffix and null if there is no path suffix

getMount

public Mount getMount(String alias)

Description copied from interface: HstRequestContext

a mount with Mount.getAlias() equal to alias and at least one common type with the mount from the current request. Thus, at least one of the types of the found Mount.getTypes() must be equal to one of the types of the mount of the current request.

If there can be found a Mount with the same primary type ( Mount.getType() ) as the one for the mount of the current request, this Mount has precedence. If there is no primary type match, we'll return the mount that has most types in common

There will be looked if the Mount of the current HstRequestContext has a property that is called hst:mountXXX where XXX is equal to alias. If so, there will be tried to return a Mount that has an alias equal to the value of this mappedAlias property hst:mountXXX. If there cannot be found a Mount for via a mapped hst:mountXXX property, there will be looked for a Mount with which has Mount.getAlias() equal to alias. Thus a mapped alias has precedence!

Specified by:

getMount in interface HstRequestContext

Parameters:

alias - the alias the found Mount or XXX in hst:mountXXX property

Returns:

a mount with Mount.getAlias() equal to alias or mappedAlias and at least one common type with the mount from the current request. null if there is no suitable mount.

addMount

public void addMount(String alias,
                     Mount mount)

removeMount

public void removeMount(String alias)

getMount

public Mount getMount(String type,
                      String alias)

Description copied from interface: HstRequestContext

a mount with Mount.getAlias() equal to alias and one of its Mount.getTypes() equal to type.

There will be looked if the Mount of the current HstRequestContext has a property that is called hst:mountXXX where XXX is equal to alias. If so, there will be tried to return a Mount that has an alias equal to the value of this mappedAlias property hst:mountXXX. If there cannot be found a Mount for via a mapped hst:mountXXX property, there will be looked for a Mount with which has Mount.getAlias() equal to alias.

Specified by:

getMount in interface HstRequestContext

Parameters:

type - the alias the found Mount or or XXX in hst:mountXXX property

alias - the type the found Mount should have

Returns:

a mount with Mount.getAlias() equal to alias or mappedAlias and one of its Mount.getTypes() equal to type. null if there is no suitable mount.

addMount

public void addMount(String type,
                     String alias,
                     Mount mount)

removeMount

public void removeMount(String type,
                        String alias)

setComponentFilterTags

public void setComponentFilterTags(Set<String> componentFilterTags)

Description copied from interface: HstMutableRequestContext

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

Specified by:

setComponentFilterTags in interface HstMutableRequestContext

Parameters:

componentFilterTags - the Set of String conditions

getComponentFilterTags

public Set<String> getComponentFilterTags()

Description copied from interface: HstRequestContext

Expert: The tags that will be used to render container items. These tags can be used by a HstComponentFactory implementation to decide to load some specific HstComponentWindows only.

This method is in general not useful for frontend developers and is more targetted for the HST Core

HST Core HstComponentFactory implementations behave as follows: When tags are available, and there is a container item in a container that matches the tag, those container items will be rendered at the exclusion of the other items. If no tags are provided, or none matches any of the tags on the container items, only those container items that do not have a tag will be rendered.

Specified by:

getComponentFilterTags in interface HstRequestContext

Returns:

The (immutable) active set of filter tags, empty when conditional rendering is not used.

getComponentWindowFilters

public List<HstComponentWindowFilter> getComponentWindowFilters()

Description copied from interface: HstRequestContext

Expert: Option to add filters to the HstRequestContext. Note that this only affects outcome if it is done before the actual doBeforeRender / doAction etc or rendering is invoked by the HST

Specified by:

getComponentWindowFilters in interface HstRequestContext

Returns:

the (immutable) List of HstComponentWindowFilters and if none present, return a empty List

addComponentWindowFilter

public void addComponentWindowFilter(HstComponentWindowFilter filter)

Adds the HstComponentWindowFilter to the HstRequestContext

Specified by:

addComponentWindowFilter in interface HstMutableRequestContext

Parameters:

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

setComponentWindowFilters

public void setComponentWindowFilters(List<HstComponentWindowFilter> filters)

Description copied from interface: HstMutableRequestContext

Sets the HstComponentWindowFilters on the HstRequestContext

Specified by:

setComponentWindowFilters in interface HstMutableRequestContext

Parameters:

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

isFullyQualifiedURLs

public boolean isFullyQualifiedURLs()

Specified by:

isFullyQualifiedURLs in interface HstRequestContext

Returns:

true when all URLs must be fully qualified, ie, including scheme, domain and portnumber (if present)

getRenderHost

public String getRenderHost()

Specified by:

getRenderHost in interface HstRequestContext

Returns:

the render host to use for rendering the request or null when no specific render host is defined. Typically, there is only a render host when the request originated from the CMS

isCmsRequest

public boolean isCmsRequest()

Specified by:

isCmsRequest in interface HstRequestContext

Returns:

true when the request is from a cms context: This can be some REST call from the cms, or a channel preview request inside the cms or over the HOST of the cms

setLinkCreator

public void setLinkCreator(HstLinkCreator linkCreator)

Specified by:

setLinkCreator in interface HstMutableRequestContext

setParameterInfoProxyFactory

public void setParameterInfoProxyFactory(HstParameterInfoProxyFactory parameterInfoProxyFactory)

Specified by:

setParameterInfoProxyFactory in interface HstMutableRequestContext

setFullyQualifiedURLs

public void setFullyQualifiedURLs(boolean fullyQualifiedURLs)

Specified by:

setFullyQualifiedURLs in interface HstMutableRequestContext

Parameters:

fullyQualifiedURLs - sets whether created URLs will be fully qualified

setRenderHost

public void setRenderHost(String renderHost)

Description copied from interface: HstMutableRequestContext

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.

Specified by:

setRenderHost in interface HstMutableRequestContext

Parameters:

renderHost - the host to be used for rendering

setCmsRequest

public void setCmsRequest(boolean cmsRequest)

Specified by:

setCmsRequest in interface HstMutableRequestContext

Parameters:

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

See Also:

HstRequestContext.isCmsRequest()

getContentBean

public HippoBean getContentBean()

Description copied from interface: HstRequestContext

Returns the content HippoBean for this request. After first retrieval, the content bean is cached and the same instance will be returned when calling HstRequestContext.getContentBean() multiple times. The backing jcr Node is fetched through jcr Session HstRequestContext.getSession()

Specified by:

getContentBean in interface HstRequestContext

Returns:

HippoBean belonging to the ResolvedSiteMapItem or null HstSiteMapItem.getRelativeContentPath() is null or when there is no content (jcr node) to be found at HstSiteMapItem.getRelativeContentPath().

getContentBean

public <T extends HippoBean> T getContentBean(Class<T> beanMappingClass)

Description copied from interface: HstRequestContext

Returns same as HstRequestContext.getContentBean() but if the found HippoBean is not of type beanMappingClass, then null is returned.

Specified by:

getContentBean in interface HstRequestContext

Returns:

HippoBean of type beanMappingClass or null

See Also:

getContentBean()

setContentBean

public void setContentBean(HippoBean contentBean)

getSiteContentBaseBean

public HippoBean getSiteContentBaseBean()

Description copied from interface: HstRequestContext

Returns the siteContentBaseBean HippoBean for this request. After first retrieval, the bean is cached and the same instance will be returned when calling HstRequestContext.getSiteContentBaseBean() multiple times. The backing jcr Node is fetched through jcr Session HstRequestContext.getSession()

Specified by:

getSiteContentBaseBean in interface HstRequestContext

Returns:

the HippoBean belonging to for HstRequestContext.getSiteContentBasePath()

setSiteContentBaseBean

public void setSiteContentBaseBean(HippoBean siteContentBean)

getContentBeansTool

public ContentBeansTool getContentBeansTool()

Specified by:

getContentBeansTool in interface HstRequestContext

Returns:

A ContentBeansTool instance. Note that the ContentBeansTool instance is an object shared by multiple threads. Invoking this method before the ContentBeansTool is set on the HstRequestContext results in null being returned. As of 2.26.xx, this is for example the case when invoking HstRequestContext.getContentBeansTool() during execution of a HstSiteMapItemHandler

setContentBeansTool

public void setContentBeansTool(ContentBeansTool contentBeansTool)

Description copied from interface: HstMutableRequestContext

Sets ContentBeansTool instance for this request context

Specified by:

setContentBeansTool in interface HstMutableRequestContext

getObjectConverter

public ObjectConverter getObjectConverter()

Description copied from interface: HstRequestContext

Returns the ObjectConverter for the current HstRequestContext. Note the returned ObjectConverter is likely to be a different one than returned vua getContentBeansTool().getObjectConverter() because the latter is a non-caching object converter while this HstRequestContext.getObjectConverter() returns possibly a caching object converter

Specified by:

getObjectConverter in interface HstRequestContext

Returns:

the ObjectConverter for the current HstRequestContext

setCachingObjectConverter

public void setCachingObjectConverter(boolean enabled)

Specified by:

setCachingObjectConverter in interface HstMutableRequestContext

setHstSiteMenusManager

public void setHstSiteMenusManager(HstSiteMenusManager siteMenusManager)

Specified by:

setHstSiteMenusManager in interface HstMutableRequestContext

getSiteContentBasePath

public String getSiteContentBasePath()

Specified by:

getSiteContentBasePath in interface HstRequestContext

Returns:

the root content path relative to the root node for the ResolvedMount belonging to the current HttpServletRequest. The path never starts with a "/" as it is relative to the root node.

setSiteContentBasePath

public void setSiteContentBasePath(String siteContentBasePath)

setDefaultObjectBeanManager

public void setDefaultObjectBeanManager(ObjectBeanManager defaultObjectBeanManager)

setNonDefaultObjectBeanManagers

public void setNonDefaultObjectBeanManagers(Map<javax.jcr.Session,ObjectBeanManager> nonDefaultObjectBeanManagers)

setDefaultHstQueryManager

public void setDefaultHstQueryManager(HstQueryManager defaultHstQueryManager)

setNonDefaultHstQueryManagers

public void setNonDefaultHstQueryManagers(Map<javax.jcr.Session,HstQueryManager> nonDefaultHstQueryManagers)

getObjectBeanManager

public ObjectBeanManager getObjectBeanManager()
                                       throws IllegalStateException

Specified by:

getObjectBeanManager in interface HstRequestContext

Returns:

a ObjectBeanManager instance for the current HstRequestContext backed by the HstRequestContext.getSession()

Throws:

IllegalStateException - if the application is unable to provide a ObjectBeanManager

getObjectBeanManager

public ObjectBeanManager getObjectBeanManager(javax.jcr.Session session)
                                       throws IllegalStateException

Specified by:

getObjectBeanManager in interface HstRequestContext

Parameters:

session - the Session to create this ObjectBeanManager with

Returns:

a ObjectBeanManager instance for the current HstRequestContext backed by the session

Throws:

IllegalStateException - if the application is unable to provide a ObjectBeanManager

getQueryManager

public HstQueryManager getQueryManager()
                                throws IllegalStateException

Specified by:

getQueryManager in interface HstRequestContext

Returns:

the HstQueryManager backed by the HstRequestContext.getSession()

Throws:

IllegalStateException - if the application is unable to provide a HstQueryManager

getQueryManager

public HstQueryManager getQueryManager(javax.jcr.Session session)
                                throws IllegalStateException

Specified by:

getQueryManager in interface HstRequestContext

Parameters:

session - the Session to create this ObjectBeanManager with

Returns:

the HstQueryManager backed by the session

Throws:

IllegalStateException - if the application is unable to provide a HstQueryManager

clearObjectAndQueryManagers

public void clearObjectAndQueryManagers()

Specified by:

clearObjectAndQueryManagers in interface HstMutableRequestContext

dispose

public void dispose()

Description copied from interface: HstMutableRequestContext

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.

Specified by:

dispose in interface HstMutableRequestContext

matchingFinished

public void matchingFinished()

Description copied from interface: HstMutableRequestContext

Marks the HstRequestContext that its matching phase has been finished

Specified by:

matchingFinished in interface HstMutableRequestContext