|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.droplet.multisite.SharingSitesDroplet
@Service(requiredProperties={"siteGroupManager","siteContextManager"}) public class SharingSitesDroplet
This Droplet returns all the sharing sites
within the given site group
.
If the siteId
is not provided as an input parameter, it will be retrieved from the
SiteContext
. Similarly, the ShareableTypeId
may be provided
as an optional input parameter. If not, the value specified in the configuration file will
instead be used. If excludeInputSite
is true, the input site,
either specified by siteId
or the current site, will not be included
in the returned site collection. The output parameters for this
Droplet are:
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ParameterName |
EMPTY
ParameterName for empty |
static java.lang.String |
ERROR_MSG_PROP_NAME
Parameter name for errorMessage |
static ParameterName |
EXCLUDE_INPUT_SITE
ParameterName for excludeInputSite |
static ParameterName |
INCLUDE_ACTIVE_SITES
ParameterName for includeActiveSites |
protected boolean |
mExcludeInputSite
ExcludeInputSite |
protected boolean |
mIncludeActiveSites
IncludeActiveSites |
protected java.lang.String |
mShareableTypeId
ShareableTypeId |
protected SiteContextManager |
mSiteContextManager
SiteContextManager |
protected SiteGroupManager |
mSiteGroupManager
SiteGroupManager |
protected SiteManager |
mSiteManager
SiteManager |
static ParameterName |
OUTPUT
ParameterName for output |
static ParameterName |
SHAREABLE_TYPE_ID
ParameterName for shareableTypeId |
static ParameterName |
SITE_ID
ParameterName for siteId |
static java.lang.String |
SITES_PROP_NAME
Parameter name for site |
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
SharingSitesDroplet()
|
Method Summary | |
---|---|
protected java.util.Collection<Site> |
filterSites(java.util.Collection<Site> pSites)
This method returns sites that are active |
java.lang.String |
getShareableTypeId()
|
SiteContextManager |
getSiteContextManager()
Gets the SiteContextManager. |
SiteGroupManager |
getSiteGroupManager()
Returns the SiteGroupManager. |
SiteManager |
getSiteManager()
Returns the SiteManager. |
boolean |
isExcludeInputSite()
|
boolean |
isIncludeActiveSites()
Returns the includeActiveSites parameter, determining whether only active sites should be retrieved |
void |
service(DynamoHttpServletRequest pReq,
DynamoHttpServletResponse pRes)
Services the output oparam if a site can be determined. |
void |
setExcludeInputSite(boolean pExcludeInputSite)
|
void |
setIncludeActiveSites(boolean pIncludeActiveSites)
Sets the includeActiveSites parameter, determining whether only active site should be retrieved |
void |
setShareableTypeId(java.lang.String pShareableTypeId)
|
void |
setSiteContextManager(SiteContextManager pSiteContextManager)
Sets the SiteContextManager |
void |
setSiteGroupManager(SiteGroupManager pSiteGroupManager)
Sets the SiteGroupManager |
void |
setSiteManager(SiteManager pSiteManager)
Sets the SiteManager |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName SITE_ID
public static final ParameterName SHAREABLE_TYPE_ID
public static final ParameterName EXCLUDE_INPUT_SITE
public static final ParameterName INCLUDE_ACTIVE_SITES
public static final ParameterName OUTPUT
public static final ParameterName EMPTY
public static final java.lang.String ERROR_MSG_PROP_NAME
public static final java.lang.String SITES_PROP_NAME
protected SiteManager mSiteManager
protected SiteGroupManager mSiteGroupManager
protected SiteContextManager mSiteContextManager
protected java.lang.String mShareableTypeId
protected boolean mExcludeInputSite
protected boolean mIncludeActiveSites
Constructor Detail |
---|
public SharingSitesDroplet()
Method Detail |
---|
public void setSiteManager(SiteManager pSiteManager)
pSiteManager
- the siteManager to setpublic SiteManager getSiteManager()
public SiteGroupManager getSiteGroupManager()
public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)
pSiteGroupManager
- the siteGroupManager to setpublic SiteContextManager getSiteContextManager()
public void setSiteContextManager(SiteContextManager pSiteContextManager)
pSiteContextManager
- the siteContextManager to setpublic java.lang.String getShareableTypeId()
public void setShareableTypeId(java.lang.String pShareableTypeId)
mShareableTypeId
- the mShareableTypeId to setpublic boolean isExcludeInputSite()
public void setExcludeInputSite(boolean pExcludeInputSite)
pExcludeInputSite
- the excludeInputSite to setpublic boolean isIncludeActiveSites()
The default value for this property is false
.
public void setIncludeActiveSites(boolean pIncludeActiveSites)
The default value for this property is false
.
pIncludeActiveSites
- the activeOnly to setpublic void service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
service
in class DynamoServlet
pReq
- The requestpRes
- The response
javax.servlet.ServletException
java.io.IOException
DynamoServlet.service(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse)
,
SiteGroupManager.findSharingSites(String, String, boolean, boolean)
protected java.util.Collection<Site> filterSites(java.util.Collection<Site> pSites)
If the site type is empty, then this method returns pSites
.
pSites
- The collection of sites
SiteManager#isSiteActive()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |