org.hippoecm.hst.configuration.site
Class HstSiteService

java.lang.Object
  org.hippoecm.hst.configuration.site.HstSiteService

All Implemented Interfaces:

HstSite

public class HstSiteService
extends Object
implements HstSite

Constructor Summary

HstSiteService(HstSiteRootNode site, ContextualizableMount mount, HstManagerImpl hstManager)

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.
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

Methods inherited from class java.lang.Object

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

Constructor Detail

HstSiteService

public HstSiteService(HstSiteRootNode site,
                      ContextualizableMount mount,
                      HstManagerImpl hstManager)
               throws ServiceException

Throws:

ServiceException

Method Detail

getMount

@Deprecated
public Mount getMount()

Deprecated.

Specified by:

getMount in interface HstSite

Returns:

the Mount object through which this hstSite is accessible

getComponentsConfiguration

public HstComponentsConfiguration getComponentsConfiguration()

Specified by:

getComponentsConfiguration in interface HstSite

Returns:

the componentsConfiguration for this HstSite

getSiteMap

public HstSiteMap getSiteMap()

Specified by:

getSiteMap in interface HstSite

Returns:

the hstSiteMap for this HstSite

getSiteMapItemHandlersConfiguration

public HstSiteMapItemHandlersConfiguration getSiteMapItemHandlersConfiguration()

Specified by:

getSiteMapItemHandlersConfiguration in interface HstSite

Returns:

the siteMapItemHandlersConfiguration for this HstSite

getCanonicalIdentifier

public String getCanonicalIdentifier()

Description copied from interface: HstSite

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

Specified by:

getCanonicalIdentifier in interface HstSite

Returns:

the identifier of the backing HstSite

getConfigurationPath

public String getConfigurationPath()

Specified by:

getConfigurationPath in interface HstSite

Returns:

the absolute location where the configuration for this HstSite is stored

getName

public String getName()

Description copied from interface: HstSite

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

Specified by:

getName in interface HstSite

Returns:

the unique name for this HstSite within its HstSites container.

getLocationMapTree

public LocationMapTree getLocationMapTree()

Description copied from interface: HstSite

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

Specified by:

getLocationMapTree in interface HstSite

Returns:

the location map for this HstSite

getSiteMenusConfiguration

public HstSiteMenusConfiguration getSiteMenusConfiguration()

Description copied from interface: HstSite

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

Specified by:

getSiteMenusConfiguration in interface HstSite

Returns:

the HstSiteMenusConfiguration for this HstSite or null