Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.bemoko.live.platform.mwc.sites
Interface SiteResolver

All Superinterfaces:
org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, com.bemoko.commons.spring.SelfAwareSpringBean<SiteResolver>, Serializable
public interface SiteResolver
extends Serializable, com.bemoko.commons.spring.SelfAwareSpringBean<SiteResolver>

Method Summary
 void addAddonLocation(String addonLocationsAsString)
           
 void addAddonLocations(List<com.bemoko.live.platform.mwc.sites.SiteLocation> addonLocations)
           
 void addLocation(com.bemoko.live.platform.mwc.sites.SiteLocation newLocation)
           
 void addLocation(String location)
           
 void addLocations(List<com.bemoko.live.platform.mwc.sites.SiteLocation> locations)
           
 URI findSiteLocation(String siteName)
           
 com.bemoko.live.platform.mwc.sites.SiteLocationWrapper findSiteLocationWrapper(String siteName)
           
 void flush()
           
 List<com.bemoko.live.platform.mwc.sites.SiteLocation> getAddonLocations()
           
 AddonsEngine getAddonsEngine()
           
 List<LiveSite> getAvailableAddons()
           
 LiveSite getDefaultSite()
           
 String getDefaultSiteName()
          Returns the default site name The default site name implicitly refers to the last site in any inheritance flow, i.e.
 Set<String> getDisabledSites()
           
 LiveExpressionManager getExpressionManager()
           
 Iterator<com.bemoko.live.platform.mwc.sites.SiteLocation> getIterator()
           
 List<com.bemoko.live.platform.mwc.sites.SiteLocation> getLocations()
           
 LivePlatformContext getPlatform()
           
 List<LiveSite> getPlatformAddons()
           
 LiveSite getPlatformSite()
           
 String getPlatformSiteName()
           
 Set<String> getReservedSiteNames()
           
 Set<String> getReservedSubSiteNames()
           
 LiveSite getRootSite(String siteName)
          Get the site of the given site name, returning non-null only if site exists and it is able to be a root site, i.e.
 LiveSite getSite(String siteName)
           
 LiveSite getSiteNullOnNotFound(String siteName)
           
 LiveSite getSiteOrDefaultIfNotFound(String siteName)
           
 LiveSite getSiteOrDefaultIfNotFound(String siteName, Stack<LiveException> localExceptionStack)
           
 List<LiveSite> getSites()
          Get list of sites deployed onto the platform
 com.bemoko.live.platform.mwc.sites.SiteWrapper getSiteWrapper(String siteName)
           
 boolean isAllowedSiteName(String siteName)
          Whether the given site name is allowed by the system.
 boolean isAllowedSubSiteName(String siteName)
           
 void setDefaultSiteName(String defaultSiteName)
           
 void setDisabledSites(Set<String> disabledSites)
           
 void setPlatformSiteName(String platformSiteName)
           
 
Methods inherited from interface com.bemoko.commons.spring.SelfAwareSpringBean
afterPropertiesSet, getSelf, setSelf
 
Methods inherited from interface org.springframework.beans.factory.BeanNameAware
setBeanName
 
Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext
 

Method Detail

addLocation

void addLocation(String location)

addLocation

void addLocation(com.bemoko.live.platform.mwc.sites.SiteLocation newLocation)

addLocations

void addLocations(List<com.bemoko.live.platform.mwc.sites.SiteLocation> locations)

addAddonLocation

void addAddonLocation(String addonLocationsAsString)

addAddonLocations

void addAddonLocations(List<com.bemoko.live.platform.mwc.sites.SiteLocation> addonLocations)

getIterator

Iterator<com.bemoko.live.platform.mwc.sites.SiteLocation> getIterator()

getLocations

List<com.bemoko.live.platform.mwc.sites.SiteLocation> getLocations()

getAddonLocations

List<com.bemoko.live.platform.mwc.sites.SiteLocation> getAddonLocations()

setDefaultSiteName

void setDefaultSiteName(String defaultSiteName)

setPlatformSiteName

void setPlatformSiteName(String platformSiteName)

getDefaultSiteName

String getDefaultSiteName()
Returns the default site name The default site name implicitly refers to the last site in any inheritance flow, i.e. both site configuration fall back and resource loader fall back.

Returns:
String

getPlatformSiteName

String getPlatformSiteName()

getDefaultSite

LiveSite getDefaultSite()
                        throws com.bemoko.live.platform.mwc.LiveSiteException,
                               LiveException
Throws:
com.bemoko.live.platform.mwc.LiveSiteException
LiveException

getPlatformSite

LiveSite getPlatformSite()
                         throws com.bemoko.live.platform.mwc.LiveSiteException,
                                LiveException
Throws:
com.bemoko.live.platform.mwc.LiveSiteException
LiveException

getSite

LiveSite getSite(String siteName)
                 throws LiveException
Throws:
LiveException

getSiteWrapper

com.bemoko.live.platform.mwc.sites.SiteWrapper getSiteWrapper(String siteName)
                                                              throws LiveException
Throws:
LiveException

getSiteNullOnNotFound

LiveSite getSiteNullOnNotFound(String siteName)
                               throws LiveException
Throws:
LiveException

getRootSite

LiveSite getRootSite(String siteName)
                     throws LiveException
Get the site of the given site name, returning non-null only if site exists and it is able to be a root site, i.e. not a linked site

Parameters:
siteName -
Returns:
root site
Throws:
LiveException

getExpressionManager

LiveExpressionManager getExpressionManager()

getPlatform

LivePlatformContext getPlatform()

findSiteLocation

URI findSiteLocation(String siteName)

findSiteLocationWrapper

com.bemoko.live.platform.mwc.sites.SiteLocationWrapper findSiteLocationWrapper(String siteName)

flush

void flush()

getSites

List<LiveSite> getSites()
                        throws LiveException
Get list of sites deployed onto the platform

Returns:
List
Throws:
LiveException

getPlatformAddons

List<LiveSite> getPlatformAddons()
                                 throws LiveException
Throws:
LiveException

getAvailableAddons

List<LiveSite> getAvailableAddons()
                                  throws LiveException
Throws:
LiveException

setDisabledSites

void setDisabledSites(Set<String> disabledSites)

getDisabledSites

Set<String> getDisabledSites()

getReservedSiteNames

Set<String> getReservedSiteNames()

getReservedSubSiteNames

Set<String> getReservedSubSiteNames()

isAllowedSiteName

boolean isAllowedSiteName(String siteName)
Whether the given site name is allowed by the system. This is true if the site name is not in the reserved site list or the disabled site list

Parameters:
siteName -
Returns:
boolean

isAllowedSubSiteName

boolean isAllowedSubSiteName(String siteName)

getAddonsEngine

AddonsEngine getAddonsEngine()

getSiteOrDefaultIfNotFound

LiveSite getSiteOrDefaultIfNotFound(String siteName)
                                    throws LiveException
Parameters:
siteName -
Returns:
LiveSite
Throws:
LiveException

getSiteOrDefaultIfNotFound

LiveSite getSiteOrDefaultIfNotFound(String siteName,
                                    Stack<LiveException> localExceptionStack)
                                    throws LiveException
Throws:
LiveException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD