atg.multisite
Interface SiteContext

public interface SiteContext

A SiteContext provides a way to track attributes related to a specific site. These attributes can either be static and describe properties of the site in general, or they can be dynamic attribute values that describe the state of the SiteContext as it changes during the request.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.util.Collection<Site>	getAdditionalSites() get the additional sites - in case an app has use for multiple sites for a given site context
java.lang.Object	getAttribute(java.lang.String pName) get an attribute for this SiteContext.
java.util.Set<java.lang.String>	getAttributeNames() get a list of names for all the attributes currently stored in this SiteContext
Site	getSite() get Site - the site associated with this context
SiteContextManager	getSiteContextManager() get SiteContextManager, the global component used to manage SiteContexts
SiteSession	getSiteSession() get SiteSession - the SiteSession for this context
boolean	isEmptySiteContext() this attribute will determine if the site context is actually just an empty site context.
void	setAdditionalSites(java.util.Collection<Site> pAdditionalSites) some applications may find use in being able to specify multiple sites for a given site context.
void	setAttribute(java.lang.String pName, java.lang.Object pValue) set an attribute for this SiteContext.
void	setSite(Site pSite) set Site - the site associated with this context
void	setSiteContextManager(SiteContextManager pSiteContextManager) set SiteContextManager, the global component used to manage SiteContexts
void	setSiteSession(SiteSession pSiteSession) set SiteSession - the SiteSession for this context

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

setSiteSession

void setSiteSession(SiteSession pSiteSession)

set SiteSession - the SiteSession for this context

Parameters:

pSiteSession - the SiteSession

getSiteSession

SiteSession getSiteSession()

get SiteSession - the SiteSession for this context

Returns:

the SiteSession

setSite

void setSite(Site pSite)

set Site - the site associated with this context

Parameters:

pSite - the Site

getSite

Site getSite()

get Site - the site associated with this context

Returns:

the Site

setAdditionalSites

void setAdditionalSites(java.util.Collection<Site> pAdditionalSites)

some applications may find use in being able to specify multiple sites for a given site context.

Parameters:

pAdditionalSites - a set holding the additional Sites

getAdditionalSites

java.util.Collection<Site> getAdditionalSites()

get the additional sites - in case an app has use for multiple sites for a given site context

Returns:

a set of Sites

setSiteContextManager

void setSiteContextManager(SiteContextManager pSiteContextManager)

set SiteContextManager, the global component used to manage SiteContexts

Parameters:

pSiteContextManager - the SiteContextManager

getSiteContextManager

SiteContextManager getSiteContextManager()

get SiteContextManager, the global component used to manage SiteContexts

Returns:

the SiteContextManager

getAttributeNames

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

get a list of names for all the attributes currently stored in this SiteContext

Returns:

a Set containing all the attribute names for this SiteContext

setAttribute

void setAttribute(java.lang.String pName,
                  java.lang.Object pValue)

set an attribute for this SiteContext. Attributes set in this manner will only exist for the lifetime of this SiteContext object. They will not be persisted in the SiteContext repository

Parameters:

pName - the attribute name

pValue - the attribute string value

getAttribute

java.lang.Object getAttribute(java.lang.String pName)

get an attribute for this SiteContext.

Parameters:

pName - the attribute name

Returns:

the attribute string value

isEmptySiteContext

boolean isEmptySiteContext()

this attribute will determine if the site context is actually just an empty site context. This can be used by apps that have a use for the concept of an empty site context.

Returns:

true if this is an empty site context