|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.client.model.SitePathBuilder
public class SitePathBuilder
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 |
---|
public SitePathBuilder(Configuration configuration)
configuration
- the configuration objectpublic SitePathBuilder(java.lang.String sitesRoot, java.lang.String modePattern, java.lang.String wcmRoot, java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)
sitesRoot
- the root for all sitesmodePattern
- the pattern for modeswcmRoot
- the root of the wcm public directory in the web appsiteUrlPatterns
- the patterns for all available sitesMethod Detail |
---|
public void populateContext(SiteContext siteContext, boolean overwrite)
UrlRequest.UrlRoot.Site
and UrlRequest.UrlRoot.PublicDir
. Uses the mode and siteID configured in the SiteContext to determine URLs.siteContext
- the site contextoverwrite
- if true, overwrite existing values even if already setpublic java.lang.String getUrlPath(UrlRequest.UrlRoot root, SiteRequest.Mode mode, java.lang.String siteID)
root
- the url typemode
- the current modesiteID
- the site ID (if applicable)public java.lang.String getSitesRoot()
public void setSitesRoot(java.lang.String sitesRoot)
public java.lang.String getModePattern()
public void setModePattern(java.lang.String modePattern)
public java.util.Map<java.lang.String,java.lang.String> getSiteUrlPatterns()
public void setSiteUrlPatterns(java.util.Map<java.lang.String,java.lang.String> siteUrlPatterns)
public java.lang.String getWcmRoot()
public void setWcmRoot(java.lang.String wcmRoot)
protected java.lang.String buildSitesRootPath(SiteRequest.Mode mode)
mode
- the modeprotected java.lang.String buildSitePath(SiteRequest.Mode mode, java.lang.String siteID)
mode
- the modesiteID
- the ID of the site
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |