atg.droplet.multisite
Class SitesShareShareableDroplet

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.SitesShareShareableDroplet

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class SitesShareShareableDroplet
extends DynamoServlet

Droplet that tests if 2 sites share a ShareableType. The site ids are set with the siteId and otherSiteId parameters. If the siteId isn't provided, the current site will be used. The ShareableType can be specified by the shareableTypeId parameter. If the shareableTypeId parameter is not set, the shareableType property of the droplet will be used. The output parameters for this Droplet are:

true

This parameter is rendered once if the sites share the shareable.

false

This parameter is rendered once if the sites do not share the shareable

error

This optional parameter is rendered if there was an error getting the site.

errorMessage

This parameter is set with an error message if there is one.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static ParameterName	ERROR ParameterName for error
static java.lang.String	ERROR_MSG_PROP_NAME Parameter name for errorMessage
static ParameterName	FALSE ParameterName for false
static ParameterName	OTHER_SITE_ID Class version string
static ParameterName	SHAREABLE_TYPE_ID ParameterName for shareable
static ParameterName	SITE_ID ParameterName for siteId
static ParameterName	TRUE ParameterName for true

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

SitesShareShareableDroplet()

Method Summary

ShareableType	getShareableType() Gets the ShareableType to check if sharing
SiteGroupManager	getSiteGroupManager() Gets the SiteGroupManager.
void	service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
void	setShareableType(ShareableType pShareableType) Sets the ShareableType to check if sharing.
void	setSiteGroupManager(SiteGroupManager pSiteGroupManager) Sets the SiteGroupManager

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

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

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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

OTHER_SITE_ID

public static final ParameterName OTHER_SITE_ID

Class version string

SITE_ID

public static final ParameterName SITE_ID

ParameterName for siteId

SHAREABLE_TYPE_ID

public static final ParameterName SHAREABLE_TYPE_ID

ParameterName for shareable

ERROR

public static final ParameterName ERROR

ParameterName for error

ERROR_MSG_PROP_NAME

public static final java.lang.String ERROR_MSG_PROP_NAME

Parameter name for errorMessage

See Also:

Constant Field Values

TRUE

public static final ParameterName TRUE

ParameterName for true

FALSE

public static final ParameterName FALSE

ParameterName for false

Constructor Detail

SitesShareShareableDroplet

public SitesShareShareableDroplet()

Method Detail

getSiteGroupManager

public SiteGroupManager getSiteGroupManager()

Gets the SiteGroupManager. The default path will be resolved if this property has not been set.

Returns:

the SiteGroupManager

setSiteGroupManager

public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)

Sets the SiteGroupManager

Parameters:

pSiteGroupManager - the SiteGroupManager to set

getShareableType

public ShareableType getShareableType()

Gets the ShareableType to check if sharing

Returns:

the shareableType

setShareableType

public void setShareableType(ShareableType pShareableType)

Sets the ShareableType to check if sharing. If not set the "shareableId" droplet parameter will be used.

Parameters:

pShareableType - the shareableType to set

service

public void service(DynamoHttpServletRequest pReq,
                    DynamoHttpServletResponse pRes)
             throws javax.servlet.ServletException,
                    java.io.IOException

Description copied from class: DynamoServlet

This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".

Overrides:

service in class DynamoServlet

Parameters:

pReq - The Request

pRes - The Response

Throws:

javax.servlet.ServletException - The ServletException

java.io.IOException - The IOException

See Also:

DynamoServlet.service(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)