org.hippoecm.hst.configuration.site
Interface HstSite

All Known Implementing Classes:

HstSiteService

public interface HstSite

The HstSite object is the object representing a site. It contains a reference to the site content base path returned by #getContentPath(), to the site's components configuration returned by getComponentsConfiguration() and the site's sitemap, returned by getSiteMap() and the site's LocationMapTree return by getLocationMapTree()

Method Summary

String	getCanonicalIdentifier() Returns the identifier of the backing canonical configuration node of the HstSite.
HstComponentsConfiguration	getComponentsConfiguration()
String	getConfigurationPath()
LocationMapTree	getLocationMapTree() The location map is an inverted version from the HstSiteMap: Instead of mapping for URLs to relativecontentpath's, the location map is a mapping from relativecontentpaths to URLs
Mount	getMount() Deprecated. Through the HstRequestContext#getResolvedMount()#getMount() the Mount should be accessed
String	getName() Each contained HstSite within its HstSites container has a unique name.
HstSiteMap	getSiteMap()
HstSiteMapItemHandlersConfiguration	getSiteMapItemHandlersConfiguration()
HstSiteMenusConfiguration	getSiteMenusConfiguration() Returns the configured HstSiteMenusConfiguration for this HstSite or null if this HstSite does not make use of a HstSiteMenusConfiguration

Method Detail

getName

String getName()

Each contained HstSite within its HstSites container has a unique name. getName() returns this unique name.

Returns:

the unique name for this HstSite within its HstSites container.

getCanonicalIdentifier

String getCanonicalIdentifier()

Returns the identifier of the backing canonical configuration node of the HstSite.

Returns:

the identifier of the backing HstSite

getSiteMapItemHandlersConfiguration

HstSiteMapItemHandlersConfiguration getSiteMapItemHandlersConfiguration()

Returns:

the siteMapItemHandlersConfiguration for this HstSite

getComponentsConfiguration

HstComponentsConfiguration getComponentsConfiguration()

Returns:

the componentsConfiguration for this HstSite

getSiteMap

HstSiteMap getSiteMap()

Returns:

the hstSiteMap for this HstSite

getLocationMapTree

LocationMapTree getLocationMapTree()

The location map is an inverted version from the HstSiteMap: Instead of mapping for URLs to relativecontentpath's, the location map is a mapping from relativecontentpaths to URLs

Returns:

the location map for this HstSite

getSiteMenusConfiguration

HstSiteMenusConfiguration getSiteMenusConfiguration()

Returns the configured HstSiteMenusConfiguration for this HstSite or null if this HstSite does not make use of a HstSiteMenusConfiguration

Returns:

the HstSiteMenusConfiguration for this HstSite or null

getMount

@Deprecated
Mount getMount()

Deprecated. Through the HstRequestContext#getResolvedMount()#getMount() the Mount should be accessed

Returns:

the Mount object through which this hstSite is accessible

getConfigurationPath

String getConfigurationPath()

Returns:

the absolute location where the configuration for this HstSite is stored