atg.droplet.multisite
Class GetSiteDroplet

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

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 GetSiteDroplet
extends DynamoServlet

Droplet that get the Site for a given siteId. If the siteId isn't provided or the site with that ID could not be found, the empty output param will be rendered. The output parameters for this Droplet are:

output

This parameter is rendered once if the site is found.

empty

This parameter is rendered once if no site is found or if siteId is null.

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.

site

This parameter is set to the Site object for the given siteId

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static ParameterName	EMPTY ParameterName for empty
static ParameterName	ERROR ParameterName for error
static java.lang.String	ERROR_MSG_PROP_NAME Parameter name for errorMessage
static ParameterName	OUTPUT ParameterName for output
static ParameterName	SITE_ID ParameterName for siteId
static java.lang.String	SITE_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

GetSiteDroplet()

Method Summary

SiteContextManager	getSiteContextManager() Gets the SiteContextManager.
void	service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) Services the output oparam if a site can be determined.
void	setSiteContextManager(SiteContextManager pSiteContextManager) Sets the SiteContextManager

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

SITE_ID

public static final ParameterName SITE_ID

ParameterName for siteId

OUTPUT

public static final ParameterName OUTPUT

ParameterName for output

EMPTY

public static final ParameterName EMPTY

ParameterName for empty

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

SITE_PROP_NAME

public static final java.lang.String SITE_PROP_NAME

Parameter name for site

See Also:

Constant Field Values

Constructor Detail

GetSiteDroplet

public GetSiteDroplet()

Method Detail

getSiteContextManager

public SiteContextManager getSiteContextManager()

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

Returns:

the siteContextManager

setSiteContextManager

public void setSiteContextManager(SiteContextManager pSiteContextManager)

Sets the SiteContextManager

Parameters:

pSiteContextManager - the siteContextManager to set

service

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

Services the output oparam if a site can be determined. Otherwise the error oparam is serviced.

Overrides:

service in class DynamoServlet

Parameters:

pReq - The request

pRes - The response

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

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