Skip navigation links

oracle.stellent.wcm.core.config
Interface SitesConfiguration

All Known Implementing Classes:

JAXBSitesConfiguration

public interface SitesConfiguration

Configuration of the existing site IDs

Method Summary

void	addSiteConfig(SiteConfiguration siteConfiguration) Add a site configuration
java.lang.String	getModePattern()
SiteConfiguration	getSiteConfig(java.lang.String siteID) Retrieve a site configuration by site ID
java.util.List<SiteConfiguration>	getSiteConfigs() Retrieve a list of all the site configurations in the config file.
java.util.Set<java.lang.String>	getSiteIDs()
java.lang.String	getSiteRoot()
void	removeSiteConfig(java.lang.String siteID) Remove a site configuration
void	setModePattern(java.lang.String modePattern) Set the mode pattern
void	setSiteRoot(java.lang.String siteRoot) Set the site root

Method Detail

getSiteIDs

java.util.Set<java.lang.String> getSiteIDs()

Returns:

the site IDs

getSiteConfig

SiteConfiguration getSiteConfig(java.lang.String siteID)

Retrieve a site configuration by site ID

Parameters:

siteID - the site ID

Returns:

the site configuration or null if not found

getSiteConfigs

java.util.List<SiteConfiguration> getSiteConfigs()

Retrieve a list of all the site configurations in the config file.

Returns:

a list of site configurations.

addSiteConfig

void addSiteConfig(SiteConfiguration siteConfiguration)

Add a site configuration

Parameters:

siteConfiguration - the site configuration

removeSiteConfig

void removeSiteConfig(java.lang.String siteID)

Remove a site configuration

Parameters:

siteID - the site ID

getSiteRoot

java.lang.String getSiteRoot()

Returns:

the relative url that is the base for all site roots

setSiteRoot

void setSiteRoot(java.lang.String siteRoot)

Set the site root

Parameters:

siteRoot - the site root

getModePattern

java.lang.String getModePattern()

Returns:

the pattern for urls in a given mode

setModePattern

void setModePattern(java.lang.String modePattern)

Set the mode pattern

Parameters:

modePattern - the mode pattern

Skip navigation links