public class SiteContextManager extends GenericService
This service manages a stack of SiteContext objects so threads can manipulate the current SiteContext via push and pop methods.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
SiteContextManager()
Constructs an instanceof SiteContextManager
|
Modifier and Type | Method and Description |
---|---|
void |
clearSiteContextStack()
clear the stack of all site contexts
|
protected void |
displayStackContents()
display the contents of the stack for debugging purposes
|
void |
doStartService()
start service
|
static Site |
getCurrentSite()
a convenience method to get the site
associated with the current site context
|
static SiteContext |
getCurrentSiteContext()
get the current site context.
|
static java.lang.String |
getCurrentSiteId()
a convenience method to get the id
for the site associated with the current site context
|
SiteContext |
getEmptySiteContext()
get an empty site context
|
ProfileRealmManager |
getProfileRealmManager()
get ProfileRealmManager
|
Site |
getSite(java.lang.String pSiteId)
get a site by site id
|
SiteContext |
getSiteContext(Site pSite)
create a site context using a specific site item
|
SiteContext |
getSiteContext(java.lang.String pSiteId)
get a specific site context
|
static SiteContextManager |
getSiteContextManager()
Return the global site context manager (the first instance instantiated).
|
SiteManager |
getSiteManager()
get SiteManager
|
atg.multisite.SiteMembershipManager |
getSiteMembershipManager()
get SiteMembershipManager
|
java.util.Set<Site> |
getSites(java.util.Set<java.lang.String> pSiteIds)
get a set of Sites by site IDs
|
atg.multisite.SiteStorageAdapter |
getSiteStorageAdapter()
get SiteStorageAdapter
|
boolean |
isEnableStackWarnings()
get EnableStackWarnings
|
boolean |
isMaintainMembershipContext() |
boolean |
isProfileRealmsEnabled()
check to see if profile realms are enabled
|
protected boolean |
isSiteSnapshotsEnabledLive()
check to see if site snapshots are enabled
in the live setting, regardless of the current
value of enableSiteSnapshots.
|
SiteContext |
popSiteContext(SiteContext pContext)
pop the current site context off the stack.
|
SiteContext |
popSiteContext(SiteContext pContext,
boolean pIgnoreWarning)
pop the current site context off the stack.
|
boolean |
pushSiteContext(SiteContext pContext)
push current site context on stack
|
protected java.lang.String |
registerSessionWithSnapshotCache()
register a site session with the current
site snapshot cache.
|
void |
setEnableStackWarnings(boolean pEnableStackWarnings)
set EnableStackWarnings - if true, will generate warnings for
issues with the site context stack
|
void |
setMaintainMembershipContext(boolean pMaintainMembershipContext)
Do not change this property on a running system.
|
void |
setProfileRealmManager(ProfileRealmManager pProfileRealmManager)
set ProfileRealmManager
|
void |
setSiteManager(SiteManager pSiteManager)
set SiteManager
|
void |
setSiteMembershipManager(atg.multisite.SiteMembershipManager pSiteMembershipManager)
set SiteMembershipManager
|
void |
setSiteStorageAdapter(atg.multisite.SiteStorageAdapter pSiteStorageAdapter)
set SiteStorageAdapter
|
addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public SiteContextManager()
public void setSiteStorageAdapter(atg.multisite.SiteStorageAdapter pSiteStorageAdapter)
pSiteStorageAdapter
- the SiteStorageAdapterpublic atg.multisite.SiteStorageAdapter getSiteStorageAdapter()
public void setEnableStackWarnings(boolean pEnableStackWarnings)
pEnableStackWarnings
- the EnableStackWarningspublic boolean isEnableStackWarnings()
public void setSiteManager(SiteManager pSiteManager)
pSiteManager
- the SiteManagerpublic SiteManager getSiteManager()
public void setProfileRealmManager(ProfileRealmManager pProfileRealmManager)
pProfileRealmManager
- the ProfileRealmManagerpublic ProfileRealmManager getProfileRealmManager()
public void setSiteMembershipManager(atg.multisite.SiteMembershipManager pSiteMembershipManager)
pSiteMembershipManager
- the SiteMembershipManagerpublic atg.multisite.SiteMembershipManager getSiteMembershipManager()
public boolean isMaintainMembershipContext()
public void setMaintainMembershipContext(boolean pMaintainMembershipContext)
pMaintainMembershipContext
- public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic Site getSite(java.lang.String pSiteId) throws SiteContextException
pSiteId
- the ID of the site to getSiteContextException
- if there was an error getting
the sitepublic java.util.Set<Site> getSites(java.util.Set<java.lang.String> pSiteIds) throws SiteContextException
pSiteIds
- the set of site Id.SiteContextException
- if there was an error getting
the sitespublic boolean pushSiteContext(SiteContext pContext) throws SiteContextException
pContext
- the SiteContext to push on the stackSiteContextException
- if pContext is nullpublic SiteContext popSiteContext(SiteContext pContext)
If loggingDebug is set to true on this component, then the stack contents are displayed in the debug output on each push/pop call. Each SiteContext on the stack is displayed along with the name of the calling class and method, as well as the line number of where the push call was made that placed the given SiteContext on the stact.
pContext
- the SiteContext to get popped off the stack. must
match the SiteContext currently on the top of the stackpublic SiteContext popSiteContext(SiteContext pContext, boolean pIgnoreWarning)
If loggingDebug is set to true on this component, then the stack contents are displayed in the debug output on each push/pop call. Each SiteContext on the stack is displayed along with the name of the calling class and method, as well as the line number of where the push call was made that placed the given SiteContext on the stact.
pContext
- the SiteContext to get popped off the stack. must
match the SiteContext currently on the top of the stackpIgnoreWarning
- if true, do not log warnings about stack inconsistenciespublic void clearSiteContextStack()
public static java.lang.String getCurrentSiteId()
public static Site getCurrentSite()
public static SiteContext getCurrentSiteContext()
public SiteContext getSiteContext(java.lang.String pSiteId) throws SiteContextException
pSiteId
- the Id of the site to base the
SiteContext object off ofSiteContextException
- if pSiteId is nullpublic SiteContext getSiteContext(Site pSite) throws SiteContextException
pSite
- the site object to use for this contextSiteContextException
- if pSite is nullpublic SiteContext getEmptySiteContext()
protected void displayStackContents()
protected java.lang.String registerSessionWithSnapshotCache()
protected boolean isSiteSnapshotsEnabledLive()
public boolean isProfileRealmsEnabled()
public static SiteContextManager getSiteContextManager()