|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface HstRequestContext
HstRequestContext provides repository content context and page/components configuration context. Also, HstRequestContext is shared among all the HstComponent windows in a request lifecycle.
| Method Summary | |
|---|---|
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()
The tags that will be used to render container items. |
ContainerConfiguration |
getContainerConfiguration()
Returns the container configuration |
HstContainerURLProvider |
getContainerURLProvider()
Returns the HstContainerURLProvider to create HstContainerURLs |
ContextCredentialsProvider |
getContextCredentialsProvider()
Returns the context credentials provider |
String |
getContextNamespace()
Returns the context namespace. |
String |
getEmbeddingContextPath()
Returns the contextPath of the embedding application for an embedded request, otherwise null |
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 alias,
String type)
a mount with Mount.getAlias() equal to alias and one of its Mount.getTypes() equal to type. |
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. |
String |
getRenderHost()
|
ResolvedMount |
getResolvedEmbeddingMount()
Returns the ResolvedMount to be used for link rewriting when this request is embedded, otherwise null |
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. |
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. |
String |
getTargetComponentPath()
Returns a target component path relative to HstComponentConfiguration of the {@link #getResolvedSiteMapItem(). |
HstURLFactory |
getURLFactory()
Returns the HstURLFactory to create HstURLs |
VirtualHost |
getVirtualHost()
Returns the matched virtual host object |
boolean |
isCmsRequest()
|
boolean |
isEmbeddedRequest()
Returns true if this request is embedded and link rewriting needs to use the getResolvedEmbeddingMount()
for the target Mount path and context path (if to be included). |
boolean |
isFullyQualifiedURLs()
|
boolean |
isPortletContext()
Returns true if invoked from a Portlet. |
boolean |
isPreview()
|
void |
removeAttribute(String name)
Removes the attribute by the attribute name. |
void |
setAttribute(String name,
Object object)
Set an attribute to be shared among each HstComponent windows. |
| Method Detail |
|---|
javax.servlet.ServletContext getServletContext()
javax.servlet.http.HttpServletRequest getServletRequest()
javax.servlet.http.HttpServletResponse getServletResponse()
javax.jcr.Session getSession()
throws javax.jcr.LoginException,
javax.jcr.RepositoryException
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.
javax.jcr.LoginException
javax.jcr.RepositoryException
javax.jcr.Session getSession(boolean create)
throws javax.jcr.LoginException,
javax.jcr.RepositoryException
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.
javax.jcr.LoginException
javax.jcr.RepositoryExceptionResolvedMount getResolvedMount()
ResolvedMount for this request
ResolvedMount for this requestResolvedSiteMapItem getResolvedSiteMapItem()
ResolvedSiteMapItem for this request
String getTargetComponentPath()
HstComponentConfiguration of the {@link #getResolvedSiteMapItem().
If not null the targeted sub component configuration will be used as root component for this request instead.
boolean isPreview()
true when this request is matched to a preview siteMount.isPreview()String getContextNamespace()
HstContainerURL getBaseURL()
HstContainerURL ) of the current request lifecycle.
HstURLFactory getURLFactory()
HstURLFactory to create HstURLs
HstContainerURLProvider getContainerURLProvider()
HstContainerURLProvider to create HstContainerURLs
HstSiteMapMatcher getSiteMapMatcher()
HstSiteMapMatcher to be able to match a path to a sitemap item
HstLinkCreator getHstLinkCreator()
HstLinkCreator to create navigational links
HstSiteMenus getHstSiteMenus()
HstQueryManagerFactory getHstQueryManagerFactory()
HstQueryManagerFactory instance responsible for creating a query manager
HstParameterInfoProxyFactory getParameterInfoProxyFactory()
HstParameterInfoProxyFactory to create a proxy for an interface that is referred to by a ParametersInfo annotation
on a HstComponent
annotated interface getters
HstParameterInfoProxyFactory
void setAttribute(String name,
Object object)
name - attribute nameobject - attribute valueObject getAttribute(String name)
void removeAttribute(String name)
Enumeration<String> getAttributeNames()
Map<String,Object> getAttributes()
VirtualHost getVirtualHost()
ContainerConfiguration getContainerConfiguration()
boolean isEmbeddedRequest()
getResolvedEmbeddingMount()
for the target Mount path and context path (if to be included).
boolean isCmsRequest()
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 cmsString getEmbeddingContextPath()
isEmbeddedRequest()ResolvedMount getResolvedEmbeddingMount()
ResolvedMount to be used for link rewriting when this request is embedded, otherwise null
isEmbeddedRequest()boolean isPortletContext()
ContextCredentialsProvider getContextCredentialsProvider()
Subject getSubject()
Locale getPreferredLocale()
Enumeration<Locale> getLocales()
String getPathSuffix()
null if there is no path suffixMount getMount(String alias)
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!
alias - the alias the found Mount or XXX in hst:mountXXX property
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.
IllegalArgumentException - when alias is null
Mount getMount(String alias,
String type)
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.
alias - the alias the found Mount or or XXX in hst:mountXXX propertytype - the type the found Mount should have
Mount.getAlias() equal to alias or mappedAlias and one of its Mount.getTypes() equal to type. null if there is no suitable mount.
IllegalArgumentException - when alias or type is nullSet<String> getComponentFilterTags()
The tags that will be used to render container items.
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.
boolean isFullyQualifiedURLs()
true when all URLs must be fully qualified, ie, including scheme, domain and portnumber (if present)String getRenderHost()
null when no specific render host is defined. Typically,
there is only a render host when the request originated from the CMS
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||