Skip navigation links

oracle.stellent.wcm.client.model
Class SitePathBuilder

java.lang.Object
oracle.stellent.wcm.client.model.SitePathBuilder

public class SitePathBuilder

extends java.lang.Object

Class for building the paths used to create URLs to this site

Constructor Summary

SitePathBuilder(Configuration configuration)
Build a site pattern builder using the configuration in the given bean

SitePathBuilder(java.lang.String sitesRoot, java.lang.String modePattern, java.lang.String wcmRoot, java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)
Create a site builder by specifying the individual root patterns to use to create subsequent patterns

Method Summary

protected java.lang.String	buildSitePath(SiteRequest.Mode mode, java.lang.String siteID) Create the root pattern of given site
protected java.lang.String	buildSitesRootPath(SiteRequest.Mode mode) Create the root path of all the sites
java.lang.String	getModePattern()
java.lang.String	getSitesRoot()
java.util.Map<java.lang.String,java.lang.String>	getSiteUrlPatterns()
java.lang.String	getUrlPath(UrlRequest.UrlRoot root, SiteRequest.Mode mode, java.lang.String siteID) Retrieve the url path
java.lang.String	getWcmRoot()
void	populateContext(SiteContext siteContext, boolean overwrite) Populate the SiteContext with the pattern values for UrlRequest.UrlRoot.Site and UrlRequest.UrlRoot.PublicDir.
void	setModePattern(java.lang.String modePattern)
void	setSitesRoot(java.lang.String sitesRoot)
void	setSiteUrlPatterns(java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)
void	setWcmRoot(java.lang.String wcmRoot)

Methods inherited from class java.lang.Object

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

Constructor Detail

SitePathBuilder

public SitePathBuilder(Configuration configuration)

Build a site pattern builder using the configuration in the given bean

Parameters:

configuration - the configuration object

SitePathBuilder

public SitePathBuilder(java.lang.String sitesRoot,
                       java.lang.String modePattern,
                       java.lang.String wcmRoot,
                       java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)

Create a site builder by specifying the individual root patterns to use to create subsequent patterns

Parameters:

sitesRoot - the root for all sites

modePattern - the pattern for modes

wcmRoot - the root of the wcm public directory in the web app

siteUrlPatterns - the patterns for all available sites

Method Detail

populateContext

public void populateContext(SiteContext siteContext,
                            boolean overwrite)

Populate the SiteContext with the pattern values for UrlRequest.UrlRoot.Site and UrlRequest.UrlRoot.PublicDir. Uses the mode and siteID configured in the SiteContext to determine URLs.

Parameters:

siteContext - the site context

overwrite - if true, overwrite existing values even if already set

getUrlPath

public java.lang.String getUrlPath(UrlRequest.UrlRoot root,
                                   SiteRequest.Mode mode,
                                   java.lang.String siteID)

Retrieve the url path

Parameters:

root - the url type

mode - the current mode

siteID - the site ID (if applicable)

Returns:

the url pattern

getSitesRoot

public java.lang.String getSitesRoot()

Returns:

the root of all the sites

setSitesRoot

public void setSitesRoot(java.lang.String sitesRoot)

getModePattern

public java.lang.String getModePattern()

Returns:

the mode pattern

setModePattern

public void setModePattern(java.lang.String modePattern)

getSiteUrlPatterns

public java.util.Map<java.lang.String,java.lang.String> getSiteUrlPatterns()

Returns:

the site url patterns

setSiteUrlPatterns

public void setSiteUrlPatterns(java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)

getWcmRoot

public java.lang.String getWcmRoot()

Returns:

the root of the wcm directory

setWcmRoot

public void setWcmRoot(java.lang.String wcmRoot)

buildSitesRootPath

protected java.lang.String buildSitesRootPath(SiteRequest.Mode mode)

Create the root path of all the sites

Parameters:

mode - the mode

Returns:

the path that is the root of all sites on this server

buildSitePath

protected java.lang.String buildSitePath(SiteRequest.Mode mode,
                                         java.lang.String siteID)

Create the root pattern of given site

Parameters:

mode - the mode

siteID - the ID of the site

Returns:

the path that is the root of all sites on this server

Skip navigation links