org.hippoecm.hst.configuration.components
Class HstComponentsConfigurationService

java.lang.Object
  org.hippoecm.hst.configuration.components.HstComponentsConfigurationService

All Implemented Interfaces:

HstComponentsConfiguration

public class HstComponentsConfigurationService
extends Object
implements HstComponentsConfiguration

Constructor Summary

HstComponentsConfigurationService(HstNode configurationNode, HstManagerImpl hstManager)

Method Summary

List<HstComponentConfiguration>	getAvailableContainerItems() Returns all the available HstComponentConfiguration's belonging to the HstSite Implementations should return an unmodifiable List
HstComponentConfiguration	getComponentConfiguration(String id) Returns the root HstComponentConfiguration whose HstComponentInfo.getId() equals this id.
Map<String,HstComponentConfiguration>	getComponentConfigurations() Return the map of all root HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()).

Methods inherited from class java.lang.Object

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

Constructor Detail

HstComponentsConfigurationService

public HstComponentsConfigurationService(HstNode configurationNode,
                                         HstManagerImpl hstManager)
                                  throws ServiceException

Throws:

ServiceException

Method Detail

getComponentConfiguration

public HstComponentConfiguration getComponentConfiguration(String id)

Description copied from interface: HstComponentsConfiguration

Returns the root HstComponentConfiguration whose HstComponentInfo.getId() equals this id.

Specified by:

getComponentConfiguration in interface HstComponentsConfiguration

Parameters:

id - the id of the root HstComponentConfiguration

Returns:

a root HstComponentConfiguration whose HstComponentInfo.getId() equals this id. When there is no HstComponentConfiguration with this id, null is returned.

getComponentConfigurations

public Map<String,HstComponentConfiguration> getComponentConfigurations()

Description copied from interface: HstComponentsConfiguration

Return the map of all root HstComponentConfiguration's where the keys are the the HstComponentConfiguration's (HstComponentInfo.getId()). Implementations should return an unmodifiable map, for example Collections.UnmodifiableMap to avoid client code changing configuration

Specified by:

getComponentConfigurations in interface HstComponentsConfiguration

Returns:

the map of all root HstComponentConfiguration's and an empty map if not root HstComponentConfiguration's are present. The keys in the map are the id's of the HstComponentConfiguration's (HstComponentInfo.getId())

getAvailableContainerItems

public List<HstComponentConfiguration> getAvailableContainerItems()

Description copied from interface: HstComponentsConfiguration

Returns all the available HstComponentConfiguration's belonging to the HstSite Implementations should return an unmodifiable List

Specified by:

getAvailableContainerItems in interface HstComponentsConfiguration

Returns:

the List of all available container items