public class SiteManager extends GenericService implements PropertiesChangedListener, atg.multisite.MultisiteSnapshotDeploymentHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected java.lang.String |
mAdditionalProductionURLPropertyName |
protected java.lang.String |
mCloseDatePropertyName |
protected java.lang.String |
mCreatedByPropertyName |
protected java.lang.String |
mDefaultAccessLevelPropertyName |
protected java.lang.String |
mDefaultItemMappingName |
protected java.lang.String |
mEnabledPropertyName |
protected java.lang.String |
mLastModifiedByPropertyName |
protected java.lang.String |
mNamePropertyName |
protected java.lang.String |
mOpenDatePropertyName |
protected java.lang.String |
mPostClosingURLPropertyName |
protected java.lang.String |
mPreOpeningURLPropertyName |
protected java.lang.String |
mProductionURLPropertyName |
protected java.lang.String |
mSiteConfigurationItemDescriptorName |
protected java.lang.String |
mSiteDownURLPropertyName |
protected java.lang.String |
mSiteGroupItemDescriptorName |
protected java.lang.String |
mSiteGroupSitesPropertyName |
protected static SiteManager |
mSiteManager |
protected java.lang.String |
mSitePriorityPropertyName |
protected MutableRepository |
mSiteRepository |
protected atg.multisite.SiteRepositoryChangedListener[] |
mSiteRepositoryChangedListeners |
protected SiteStateProcessor |
mSiteStateProcessor |
protected java.lang.String |
mSiteTemplateItemDescriptorName |
protected java.lang.String |
mSiteTemplateItemMappingIdPropertyName |
protected java.lang.String |
mSiteTemplatePropertyName |
protected java.lang.String |
mSiteTypePropertyName |
protected java.lang.String[] |
mSiteTypes |
protected javax.transaction.TransactionManager |
mTransactionManager |
protected static java.lang.String |
RESOURCE_NAME |
protected static java.util.ResourceBundle |
sResourceBundle |
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 |
---|
SiteManager() |
Modifier and Type | Method and Description |
---|---|
RepositoryItem |
createSite(java.lang.String pId)
Creates a transient site in the siteRepository using the supplied ID, and
then returns the transient repository item.
|
void |
doStartService()
This is called after a Service has been created, placed into the
naming hierarchy, and initialized with its configured property
values.
|
RepositoryItem[] |
filterDisabledSites(RepositoryItem[] pSites)
Removes disabled sites from an array of site RepositoryItems.
|
java.lang.String[] |
filterDisabledSites(java.lang.String[] pSiteIds)
Removes disabled sites from an array of site IDs.
|
RepositoryItem[] |
filterInactiveSites(RepositoryItem[] pSites)
Removes inactive sites from an array of site RepositoryItems.
|
java.lang.String[] |
filterInactiveSites(java.lang.String[] pSiteIds)
Removes inactive sites from an array of site IDs.
|
RepositoryItem[] |
filterSites(RepositoryItem[] pSites,
boolean pActive)
Filter sites by active/inactive.
|
protected void |
fireSiteChangedEvent()
Fires an event to registered SiteRepositoryChangedListeners indicating that
the SiteRepository has been updated.
|
RepositoryItem[] |
getActiveSites()
Returns an array of site RepositoryItems for all active sites.
|
RepositoryItem[] |
getActiveSitesByType(java.lang.String pType)
Returns a RepositoryItem array containing active sites of the supplied type
|
java.lang.String |
getAdditionalProductionURLPropertyName()
Returns the name of the additionalPropertyURL property in the repository.
|
RepositoryItem[] |
getAllSites()
Queries the repository and returns an array of all site RepositoryItems.
|
RepositoryItem[] |
getAllSites(Repository pSiteRepository)
Queries the repository and returns an array of all site RepositoryItems.
|
java.lang.String |
getCloseDatePropertyName()
Returns the name of the propertyURL property in the repository.
|
java.lang.String |
getCreatedByPropertyName()
Returns the name of the created by property in the repository
|
java.lang.String |
getDefaultAccessLevelPropertyName()
Returns the default access level property name.
|
java.lang.String |
getDefaultItemMappingName()
Returns the default template item mapping name.
|
RepositoryItem[] |
getDisabledSites()
Returns sites from the SiteRepository whose enabled property is false.
|
java.lang.String |
getEnabledPropertyName()
Returns the name of the enabled property in the repository
|
RepositoryItem[] |
getEnabledSites()
Returns sites from the SiteRepository whose enabled property is true.
|
RepositoryItem[] |
getInactiveSites()
Returns an array of site RepositoryItems for all inactive sites.
|
java.lang.String |
getLastModifiedByPropertyName()
Returns the name of the last modified by property in the repository
|
java.lang.String |
getNamePropertyName()
Returns the name of the name property in the repository
|
java.lang.String |
getOpenDatePropertyName()
Returns the name of the openDate property in the repository.
|
java.lang.String |
getPostClosingURLPropertyName()
Returns the name of the postClosingURL property in the repository.
|
java.lang.String |
getPreOpeningURLPropertyName()
Returns the name of the preOpeningURL property in the repository.
|
java.lang.String |
getProductionURLPropertyName()
Returns the name of the propertyURL property in the repository.
|
RepositoryItem |
getSite(java.lang.String pId)
Returns the site RepositoryItem with the given id
|
java.lang.String |
getSiteConfigurationItemDescriptorName()
Returns the name of the site configuration item descriptor
|
int |
getSiteCount()
Query the repository a return a count of the site RepositoryItems.
|
java.lang.String |
getSiteDownURLPropertyName()
Returns the name of the siteDownURL property in the repository.
|
java.lang.String |
getSiteGroupItemDescriptorName()
Returns the name of the site group item descriptor
|
java.lang.String |
getSiteGroupSitesPropertyName()
Gets the name of the siteGroupSites property.
|
static SiteManager |
getSiteManager()
Returns the statically accessible SiteManager instance
|
java.lang.String |
getSitePriorityPropertyName()
Returns the name of the site priority property in the repository
|
MutableRepository |
getSiteRepository()
Returns the SiteRepository.
|
atg.multisite.SiteRepositoryChangedListener[] |
getSiteRepositoryChangedListeners()
Returns the SiteRepositoryChangedListeners.
|
RepositoryItem[] |
getSitesByState(boolean pActive)
Returns sites which are either active or inactive, depending on whether pEnabled is true or false.
|
RepositoryItem[] |
getSitesByTemplateId(java.lang.String pTemplateId)
Returns SiteRepository items for all sites which are based on the given template
|
RepositoryItem[] |
getSitesByType(java.lang.String pType)
Returns SiteRepository items for all sites which are of the supplied types, containing sites which contain at least
one of the provided site types.
|
SiteStateProcessor |
getSiteStateProcessor()
Gets the SiteStateProcessor component
|
java.lang.String |
getSiteTemplateItemDescriptorName()
Gets the name of the siteTemplate ItemDescriptor.
|
java.lang.String |
getSiteTemplateItemMappingIdPropertyName()
Returns the template item's itemMappingId property name.
|
java.lang.String |
getSiteTemplatePropertyName()
Returns the name of the site template property in the repository
|
java.lang.String |
getSiteTypePropertyName()
Returns the name of the site type property in the repository
|
java.lang.String[] |
getSiteTypes()
Returns all of the site types registered with the site Manager.
|
RepositoryItem |
getTemplateFromSite(RepositoryItem pSite)
Returns the template RepositoryItem associated with this site.
|
java.util.Map<java.lang.String,java.lang.Object> |
getTemplatePropertyDefaultValues(RepositoryItem pSite)
Gets the default values from the template associated with this site.
|
javax.transaction.TransactionManager |
getTransactionManager()
Returns the component that manages transaction boundaries.
|
void |
handleMultisiteChangeEvent(java.lang.String pDeploymentId)
Called whenever a deployment is made to the siteConfiguration item of the SiteRepository
|
boolean |
isMultisiteEnabled()
Indicates whether or not multi-site is enabled, i.e.
|
boolean |
isSiteActive(RepositoryItem pSite)
Returns true if the given RepositoryItem represents an active site
|
boolean |
isSiteEnabled(RepositoryItem pSite)
Returns true if the site's enabled property is set to true.
|
void |
propertiesChanged(PropertiesChangedEvent pEvent)
Called whenever a change is detected to a property value in the SiteRepository
|
void |
saveSite(MutableRepositoryItem pSite)
Saves a transient RepositoryItem to the SiteRepository
|
void |
setAdditionalPropertyURLName(java.lang.String pAdditionalPropertyURLPropertyName)
Sets the name of the additionalPropertyURL property in the repository
|
void |
setCloseDatePropertyName(java.lang.String pCloseDatePropertyName)
Sets the name of the propertyURL property in the repository
|
void |
setCreatedByPropertyName(java.lang.String pCreatedByPropertyName)
Sets the name of the created by property in the repository
|
void |
setDefaultAccessLevelPropertyName(java.lang.String pDefaultAccessLevelPropertyName)
Sets the default access level property name
|
void |
setDefaultItemMappingName(java.lang.String pDefaultItemMappingName)
Sets the default template item mapping name.
|
void |
setEnabledPropertyName(java.lang.String pEnabledPropertyName)
Sets the name of the enabled property in the repository
|
void |
setLastModifiedByPropertyName(java.lang.String pLastModifiedByPropertyName)
Sets the name of the last modified by property in the repository
|
void |
setNamePropertyName(java.lang.String pNamePropertyName)
Sets the name of the name property in the repository
|
void |
setOpenDatePropertyName(java.lang.String pOpenDatePropertyName)
Sets the name of the openDate property in the repository
|
void |
setPostClosingURLPropertyName(java.lang.String pPostClosingURLPropertyName)
Sets the name of the postClosingURL property in the repository
|
void |
setPreOpeningURLPropertyName(java.lang.String pPreOpeningURLPropertyName)
Sets the name of the preOpeningURL property in the repository
|
void |
setProductionURLPropertyName(java.lang.String pProductionURLPropertyName)
Sets the name of the productionURL property in the repository
|
void |
setSiteConfigurationItemDescriptorName(java.lang.String pSiteConfigurationItemDescriptorName)
Sets the name of the site configuration item descriptor
|
void |
setSiteDownURLPropertyName(java.lang.String pSiteDownURLPropertyName)
Sets the name of the siteDownURL property in the repository
|
void |
setSiteGroupItemDescriptorName(java.lang.String pSiteGroupItemDescriptorName)
Sets the name of the site group item descriptor
|
void |
setSiteGroupSitesPropertyName(java.lang.String pSiteGroupSitesPropertyName)
Sets the name of the siteGroupSites property.
|
void |
setSitePriorityPropertyName(java.lang.String pSitePriorityPropertyName)
Sets the name of the site priority property in the repository
|
void |
setSiteRepository(MutableRepository pSiteRepository)
Set the SiteRepository.
|
void |
setSiteRepositoryChangedListeners(atg.multisite.SiteRepositoryChangedListener[] pSiteRepositoryChangedListeners)
Set the SiteRepositoryChangedListeners.
|
void |
setSiteStateProcessor(SiteStateProcessor pSiteStateProcessor)
Sets the SiteStateProcessor component
|
void |
setSiteTemplateItemDescriptorName(java.lang.String pSiteTemplateItemDescriptorName)
Sets the name of the siteTemplateItemDescriptorName property.
|
void |
setSiteTemplateItemMappingIdPropertyName(java.lang.String pSiteTemplateItemMappingIdPropertyName)
Sets the template item's itemMappingId property name.
|
void |
setSiteTemplatePropertyName(java.lang.String pSiteTemplatePropertyName)
Sets the name of the site template property in the repository
|
void |
setSiteTypePropertyName(java.lang.String pSiteTypePropertyName)
Sets the name of the site type property in the repository
|
void |
setSiteTypes(java.lang.String[] pSiteTypes)
Sets the valid site type values.
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
Set the component that manages transaction boundaries.
|
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 static java.lang.String CLASS_VERSION
protected static final java.lang.String RESOURCE_NAME
protected static java.util.ResourceBundle sResourceBundle
protected static SiteManager mSiteManager
protected MutableRepository mSiteRepository
protected atg.multisite.SiteRepositoryChangedListener[] mSiteRepositoryChangedListeners
protected SiteStateProcessor mSiteStateProcessor
protected javax.transaction.TransactionManager mTransactionManager
protected java.lang.String mSiteConfigurationItemDescriptorName
protected java.lang.String mSiteGroupItemDescriptorName
protected java.lang.String mCreatedByPropertyName
protected java.lang.String mSiteGroupSitesPropertyName
protected java.lang.String mSiteTemplateItemDescriptorName
protected java.lang.String mEnabledPropertyName
protected java.lang.String mLastModifiedByPropertyName
protected java.lang.String mNamePropertyName
protected java.lang.String mSitePriorityPropertyName
protected java.lang.String mSiteTemplatePropertyName
protected java.lang.String mSiteTypePropertyName
protected java.lang.String mAdditionalProductionURLPropertyName
protected java.lang.String mProductionURLPropertyName
protected java.lang.String mOpenDatePropertyName
protected java.lang.String mCloseDatePropertyName
protected java.lang.String mSiteDownURLPropertyName
protected java.lang.String mPreOpeningURLPropertyName
protected java.lang.String mPostClosingURLPropertyName
protected java.lang.String mDefaultItemMappingName
protected java.lang.String mSiteTemplateItemMappingIdPropertyName
protected java.lang.String mDefaultAccessLevelPropertyName
protected java.lang.String[] mSiteTypes
public static SiteManager getSiteManager()
public MutableRepository getSiteRepository()
public void setSiteRepository(MutableRepository pSiteRepository)
pSiteRepository
- The SiteRepository instance to use.public atg.multisite.SiteRepositoryChangedListener[] getSiteRepositoryChangedListeners()
public void setSiteRepositoryChangedListeners(atg.multisite.SiteRepositoryChangedListener[] pSiteRepositoryChangedListeners)
pSiteRepositoryChangedListeners
- The array of change listeners.public SiteStateProcessor getSiteStateProcessor()
public void setSiteStateProcessor(SiteStateProcessor pSiteStateProcessor)
pSiteStateProcessor
- public javax.transaction.TransactionManager getTransactionManager()
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- the manager componentpublic java.lang.String getSiteConfigurationItemDescriptorName()
public void setSiteConfigurationItemDescriptorName(java.lang.String pSiteConfigurationItemDescriptorName)
public java.lang.String getSiteGroupItemDescriptorName()
public void setSiteGroupItemDescriptorName(java.lang.String pSiteGroupItemDescriptorName)
public java.lang.String getCreatedByPropertyName()
public void setCreatedByPropertyName(java.lang.String pCreatedByPropertyName)
public void setSiteGroupSitesPropertyName(java.lang.String pSiteGroupSitesPropertyName)
pSiteGroupSitesPropertyName
- The name of the siteGroupSites property.public java.lang.String getSiteGroupSitesPropertyName()
public void setSiteTemplateItemDescriptorName(java.lang.String pSiteTemplateItemDescriptorName)
pSiteTemplateItemDescriptorName
- The name of the siteTemplate ItemDescriptor.public java.lang.String getSiteTemplateItemDescriptorName()
public java.lang.String getEnabledPropertyName()
public void setEnabledPropertyName(java.lang.String pEnabledPropertyName)
public java.lang.String getLastModifiedByPropertyName()
public void setLastModifiedByPropertyName(java.lang.String pLastModifiedByPropertyName)
public java.lang.String getNamePropertyName()
public void setNamePropertyName(java.lang.String pNamePropertyName)
public java.lang.String getSitePriorityPropertyName()
public void setSitePriorityPropertyName(java.lang.String pSitePriorityPropertyName)
public java.lang.String getSiteTemplatePropertyName()
public void setSiteTemplatePropertyName(java.lang.String pSiteTemplatePropertyName)
public java.lang.String getSiteTypePropertyName()
public void setSiteTypePropertyName(java.lang.String pSiteTypePropertyName)
public java.lang.String getAdditionalProductionURLPropertyName()
public void setAdditionalPropertyURLName(java.lang.String pAdditionalPropertyURLPropertyName)
public java.lang.String getProductionURLPropertyName()
public void setProductionURLPropertyName(java.lang.String pProductionURLPropertyName)
public java.lang.String getOpenDatePropertyName()
public void setOpenDatePropertyName(java.lang.String pOpenDatePropertyName)
public java.lang.String getCloseDatePropertyName()
public void setCloseDatePropertyName(java.lang.String pCloseDatePropertyName)
public java.lang.String getSiteDownURLPropertyName()
public void setSiteDownURLPropertyName(java.lang.String pSiteDownURLPropertyName)
public java.lang.String getPreOpeningURLPropertyName()
public void setPreOpeningURLPropertyName(java.lang.String pPreOpeningURLPropertyName)
public java.lang.String getPostClosingURLPropertyName()
public void setPostClosingURLPropertyName(java.lang.String pPostClosingURLPropertyName)
public java.lang.String getDefaultItemMappingName()
public void setDefaultItemMappingName(java.lang.String pDefaultItemMappingName)
public java.lang.String getSiteTemplateItemMappingIdPropertyName()
public void setSiteTemplateItemMappingIdPropertyName(java.lang.String pSiteTemplateItemMappingIdPropertyName)
public java.lang.String getDefaultAccessLevelPropertyName()
public void setDefaultAccessLevelPropertyName(java.lang.String pDefaultAccessLevelPropertyName)
public java.lang.String[] getSiteTypes()
public void setSiteTypes(java.lang.String[] pSiteTypes)
pSiteTypes
- The array of valid site type names.public void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic RepositoryItem[] getSitesByTemplateId(java.lang.String pTemplateId) throws RepositoryException
pTemplateId
- the ID of the site template.RepositoryException
public RepositoryItem[] getSitesByType(java.lang.String pType) throws RepositoryException
pType
- the site typeRepositoryException
public java.util.Map<java.lang.String,java.lang.Object> getTemplatePropertyDefaultValues(RepositoryItem pSite) throws RepositoryException
pSite
- RepositoryException
public RepositoryItem getTemplateFromSite(RepositoryItem pSite) throws RepositoryException
pSite
- RepositoryException
public RepositoryItem[] getActiveSites() throws RepositoryException
RepositoryException
public RepositoryItem[] getActiveSitesByType(java.lang.String pType) throws RepositoryException
pType
- the site typesRepositoryException
public RepositoryItem[] getInactiveSites() throws RepositoryException
RepositoryException
public RepositoryItem[] getSitesByState(boolean pActive) throws RepositoryException
pActive
- return sites which are enabled or disabled.RepositoryException
public RepositoryItem[] filterSites(RepositoryItem[] pSites, boolean pActive)
pSites
- the array of sites to filter.pActive
- true to return active sites, false to return inactive
sites.public RepositoryItem[] getDisabledSites() throws RepositoryException
RepositoryException
public RepositoryItem[] getEnabledSites() throws RepositoryException
RepositoryException
public final boolean isMultisiteEnabled()
public boolean isSiteActive(RepositoryItem pSite)
public boolean isSiteEnabled(RepositoryItem pSite)
pSite
- public java.lang.String[] filterInactiveSites(java.lang.String[] pSiteIds)
pSiteIds
- An array of site IDs.public RepositoryItem[] filterInactiveSites(RepositoryItem[] pSites)
pSites
- An array of Sits.public java.lang.String[] filterDisabledSites(java.lang.String[] pSiteIds)
pSiteIds
- An array of site IDs.public RepositoryItem[] filterDisabledSites(RepositoryItem[] pSites)
pSites
- An array of Sits.public RepositoryItem createSite(java.lang.String pId) throws RepositoryException
pId
- the id for the siteRepositoryException
public void saveSite(MutableRepositoryItem pSite) throws RepositoryException
pSite
- the site RepositoryItemRepositoryException
public RepositoryItem getSite(java.lang.String pId) throws RepositoryException
pId
- the repository idRepositoryException
public RepositoryItem[] getAllSites() throws RepositoryException
RepositoryException
- if there is an error while performing
the query operationpublic RepositoryItem[] getAllSites(Repository pSiteRepository) throws RepositoryException
pSiteRepository
- the site repository to use.RepositoryException
- if there is an error while performing
the query operationpublic final int getSiteCount() throws RepositoryException
RepositoryException
- if there is an error while performing
the query operationpublic void propertiesChanged(PropertiesChangedEvent pEvent)
propertiesChanged
in interface PropertiesChangedListener
public void handleMultisiteChangeEvent(java.lang.String pDeploymentId)
handleMultisiteChangeEvent
in interface atg.multisite.MultisiteSnapshotDeploymentHandler
protected void fireSiteChangedEvent()