public class SiteIdForItemDroplet extends DynamoServlet
true
indicates a preference for the
current site to be returned as the best possible match by
looking for it in the item's site list. This is also dependent
on the site being active (or the appropriate include flags
being set).
shareableTypeId - id of the shareable that will be used to get the list of
potential sites
siteId - a user defined siteId value that will be used as a
preference in the matching process.
includeInactiveSites - a value of true
indicates a preference for a
site in an inactive state to be considered for inclusion
in the site matching process
includeDisabledSites - a value of true
indicates a preference for a
site in a disabled state to be considered for inclusion
in the site matching process. Note, that by definition, a
disabled site is inactive so in order to include a disabled
site, both this flag and the includeInactiveSites should be
set to true.
The output parameters for this droplet are as follows:
output
siteId - the calculated siteId, which represents the best match for the given
item
offSite - will be set to true
if the derived siteId value is not
equal to the current site
active - will be set to true
if the selected site is active
enabled - will be set to true
if the selected site is enabled
inGroup - will be set to true
if the selected site and current site
are within the same sharing group defined by the shareableTypeId
.
If a valid shareableTypeId
is provided, both sites will be checked
to see whether they share the same shareable type. In case a valid
shareableTypeId
is not provided, then all sites in the system
share the same sharing group.
error
errorMessage - if an error occurred it will be detailed hereModifier and Type | Field and Description |
---|---|
static ParameterName |
ACTIVE |
static java.lang.String |
CLASS_VERSION
Class version string
|
static ParameterName |
CURRENT_SITE_FIRST |
static ParameterName |
ENABLED |
static ParameterName |
ERROR |
static ParameterName |
ERROR_MESSAGE |
static ParameterName |
IN_GROUP |
static ParameterName |
INCLUDE_DISABLED_SITES |
static ParameterName |
INCLUDE_INACTIVE_SITES |
static ParameterName |
ITEM |
static ParameterName |
OFFSITE |
static ParameterName |
OUTPUT |
static ParameterName |
SHAREABLE_TYPE_ID |
static ParameterName |
SITE_ID |
static ParameterName |
SITES_PROPERTY_NAME |
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
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 |
---|
SiteIdForItemDroplet() |
Modifier and Type | Method and Description |
---|---|
protected void |
createError(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.String message)
Logs the error if the correct logging level is set and sets the error message in the request.
|
java.lang.String |
getShareableTypeId()
Returns the mShareableTypeId property.
|
java.lang.String |
getSitesPropertyName()
Returns the mSitesPropertyName property.
|
atg.multisite.SiteTools |
getSiteTools()
Returns property mSiteTools.
|
boolean |
isCurrentSiteFirst()
Returns the mCurrentSiteFirst property.
|
boolean |
isIncludeDisabledSites()
Returns the mIncludeDisabledSites property.
|
boolean |
isIncludeInactiveSites()
Returns the mIncludeInactiveSites property.
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method provides the default implementation of service,
by dispatching to conventionally named methods which begin
with "do".
|
void |
setCurrentSiteFirst(boolean pCurrentSiteFirst)
Sets the mCurrentSiteFirst property.
|
void |
setIncludeDisabledSites(boolean pIncludeDisabledSites)
Sets the mIncludeDisabledSites property.
|
void |
setIncludeInactiveSites(boolean pIncludeInactiveSites)
Sets the mIncludeInactiveSites property.
|
void |
setShareableTypeId(java.lang.String pShareableTypeId)
Sets the mDefaultSite property.
|
void |
setSitesPropertyName(java.lang.String pSitesPropertyName)
Sets the mSitesPropertyName property.
|
void |
setSiteTools(atg.multisite.SiteTools pSiteTools)
Sets property mSiteTools.
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
addLogListener, createAdminServlet, doStartService, 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
public static final ParameterName ITEM
public static final ParameterName CURRENT_SITE_FIRST
public static final ParameterName SHAREABLE_TYPE_ID
public static final ParameterName SITE_ID
public static final ParameterName SITES_PROPERTY_NAME
public static final ParameterName INCLUDE_INACTIVE_SITES
public static final ParameterName INCLUDE_DISABLED_SITES
public static final ParameterName OUTPUT
public static final ParameterName OFFSITE
public static final ParameterName ACTIVE
public static final ParameterName ENABLED
public static final ParameterName IN_GROUP
public static final ParameterName ERROR
public static final ParameterName ERROR_MESSAGE
public boolean isCurrentSiteFirst()
true
indicates a
preference for the current site to be returned as the best possible match by looking
for it in the item's site list. This is also dependent on the site being active (or
the appropriate include flags being set).true
indicates a preference for the current site to be returned
as the best possible match by looking for it in the item's site list.public void setCurrentSiteFirst(boolean pCurrentSiteFirst)
true
indicates a
preference for the current site to be returned as the best possible match by looking
for it in the item's site list. This is also dependent on the site being active (or
the appropriate include flags being set).pCurrentSiteFirst
- true
indicates a preference for the current site
to be returned as the best possible match by looking for it in the item's site list.public java.lang.String getShareableTypeId()
public void setShareableTypeId(java.lang.String pShareableTypeId)
pShareableTypeId
- id of the shareable type to use to get
list of potential shareable sitespublic java.lang.String getSitesPropertyName()
public void setSitesPropertyName(java.lang.String pSitesPropertyName)
pSitesPropertyName
- property name to use to retrieve list of
item sitespublic boolean isIncludeInactiveSites()
public void setIncludeInactiveSites(boolean pIncludeInactiveSites)
pIncludeInactiveSites
- whether or not to include inactive sites
in the matching processpublic boolean isIncludeDisabledSites()
public void setIncludeDisabledSites(boolean pIncludeDisabledSites)
pIncludeDisabledSites
- whether or not to include disabled sites
in the matching processpublic void setSiteTools(atg.multisite.SiteTools pSiteTools)
pSiteTools
- the SiteToolspublic atg.multisite.SiteTools getSiteTools()
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
DynamoServlet
service
in class DynamoServlet
pRequest
- The requestpResponse
- The responsejavax.servlet.ServletException
- The ServletExceptionjava.io.IOException
- The IOExceptionDynamoServlet.service(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse)
protected void createError(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String message) throws java.io.IOException, javax.servlet.ServletException
pRequest
- The requestpResponse
- The responsemessage
- error messagejava.io.IOException
javax.servlet.ServletException