Package org.hippoecm.hst.core.internal
Interface HstMutableRequestContext
- All Superinterfaces:
HstRequestContext
,ModelContributable
This is an INTERNAL USAGE ONLY API. Clients should not cast to these interfaces as they should never be used from
client code
- Version:
- $Id$
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.hippoecm.hst.core.request.HstRequestContext
HstRequestContext.HstRequestType
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
dispose()
Dispose all the internal objects maintained for the current request processing state.void
Marks theHstRequestContext
that its matching phase has been finishedvoid
setBaseURL
(HstContainerURL baseURL) void
setCachingObjectConverter
(boolean enabled) void
Marks the request to be a channelMngrPreviewRequestvoid
Marks the request to be a channelMngrRestRequestvoid
setCmsRequest
(boolean cmsRequest) Deprecated.void
setComponentFilterTags
(Set<String> conditions) set the conditions that will trigger a component to be added to the component window hierarchy.void
Sets theHstComponentWindowFilter
s on theHstRequestContext
void
setContainerConfiguration
(ContainerConfiguration containerConfiguration) void
setContentBeansTool
(ContentBeansTool contentBeansTool) Sets ContentBeansTool instance for this request contextvoid
setContentTypes
(ContentTypes contentTypes) Store current versionContentTypes
in currentHstRequestContext
void
setFullyQualifiedURLs
(boolean fullyQualifiedURLs) void
setHstQueryManagerFactory
(HstQueryManagerFactory hstQueryManagerFactory) void
setHstRequestType
(HstRequestContext.HstRequestType hstRequestType) 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
setPageModelApiRequest
(boolean pageModelApiRequest) void
setParameterInfoProxyFactory
(HstParameterInfoProxyFactory parameterInfoProxyFactory) void
setPathSuffix
(String pathSuffix) Sets the path suffixvoid
setPreferredLocale
(Locale locale) Sets the preferred locale associated with this request.void
setRenderHost
(String renderHost) Sets a specific render host.void
setRenderingHistory
(boolean renderingHistory) void
setResolvedMount
(ResolvedMount resolvedMount) void
setResolvedSiteMapItem
(ResolvedSiteMapItem resolvedSiteMapItem) void
setServletContext
(jakarta.servlet.ServletContext servletContext) void
setServletRequest
(jakarta.servlet.http.HttpServletRequest servletRequest) void
setServletResponse
(jakarta.servlet.http.HttpServletResponse servletResponse) void
setSession
(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, getContentTypes, getContextCredentialsProvider, getHeadContributable, getHeadContributableMap, getHstLinkCreator, getHstQueryManagerFactory, getHstRequestType, 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, isChannelManagerPreviewRequest, isChannelManagerRestRequest, isFullyQualifiedURLs, isPageModelApiRequest, isPreview, isRenderingHistory, isSearchEngineOrBotRequest, removeAttribute, setAttribute, setHeadContributable
Methods inherited from interface org.hippoecm.hst.core.ModelContributable
getModel, getModelNames, getModelsMap, removeModel, setModel
-
Method Details
-
setServletContext
void setServletContext(jakarta.servlet.ServletContext servletContext) -
setServletRequest
void setServletRequest(jakarta.servlet.http.HttpServletRequest servletRequest) -
setServletResponse
void setServletResponse(jakarta.servlet.http.HttpServletResponse servletResponse) -
setSession
-
setResolvedMount
-
setResolvedSiteMapItem
-
setBaseURL
-
setURLFactory
-
setSiteMapMatcher
-
setLinkCreator
-
setParameterInfoProxyFactory
-
setHstQueryManagerFactory
-
setContainerConfiguration
-
setSubject
-
setPreferredLocale
Sets the preferred locale associated with this request.- Parameters:
locale
- The preferred locale associated with this request.
-
setLocales
Sets the locales assocaited with this request.- Parameters:
locales
-
-
setPathSuffix
Sets the path suffix- Parameters:
pathSuffix
-
-
setComponentFilterTags
set the conditions that will trigger a component to be added to the component window hierarchy. -
setComponentWindowFilters
Sets theHstComponentWindowFilter
s on theHstRequestContext
- Parameters:
filters
- theHstComponentWindowFilter
s to be set for theHstRequestContext.getComponentWindowFilters()
-
setFullyQualifiedURLs
void setFullyQualifiedURLs(boolean fullyQualifiedURLs) - Parameters:
fullyQualifiedURLs
- sets whether created URLs will be fully qualified
-
setRenderHost
Sets a specific render host. This can be used to render the request as if hostrenderHost
was the actual used host in the request.- Parameters:
renderHost
- the host to be used for rendering
-
setChannelManagerPreviewRequest
void setChannelManagerPreviewRequest()Marks the request to be a channelMngrPreviewRequest -
setCmsRequest
Deprecated.since 13.2.0, usesetChannelManagerPreviewRequest()
instead Marks the request to be a channelMngrRestRequest -
setChannelManagerRestRequest
void setChannelManagerRestRequest()Marks the request to be a channelMngrRestRequest -
setHstRequestType
-
setContentBeansTool
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 theHstRequestContext
that its matching phase has been finished -
setContentTypes
Store current versionContentTypes
in currentHstRequestContext
- Parameters:
contentTypes
-
-
setPageModelApiRequest
void setPageModelApiRequest(boolean pageModelApiRequest) -
setRenderingHistory
void setRenderingHistory(boolean renderingHistory)
-
setChannelManagerPreviewRequest()
instead Marks the request to be a channelMngrRestRequest