atg.servlet

Class DynamoServlet

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.nucleus.TimedOperationService

atg.nucleus.servlet.ServletService

atg.nucleus.servlet.HttpServletService

atg.servlet.DynamoServlet

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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

Direct Known Subclasses:

AbandonmentDroplet, ADCDroplet, AddItemToCartServlet, AgentEventDroplet, ApprovalRequiredDroplet, ApprovedDroplet, ArrayIncludesValue, AuthorizedPaymentTypesDroplet, AvailableShippingMethodsDroplet, BeanProperty, BeanPropertyServlet, BrowserTyper, Cache, ClosenessQualifierDroplet, CollectionFilter, Compare, ComplexPriceDroplet, ComponentExists, ContentDroplet, ContentFolderView, atg.droplet.ContextAffectingDropletImpl, CostCenterDroplet, CouponDroplet, CurrencyFormatter, CurrentUser, DimensionValueCacheDroplet, DisplaySkuProperties, EndTransactionDroplet, EventSenderDroplet, FileServlet, For, ForEach, Format, GeoLocatorDroplet, GetClickThroughId, GetSiteDroplet, GiftitemDroplet, GiftlistDroplet, GiftlistShoppingCartQuantityDroplet, GiftShippingGroupDroplet, GiftShippingGroupsDroplet, GiftWithPurchaseSelectionChoicesDroplet, GiftWithPurchaseSelectionsDroplet, HasFunction, InventoryDroplet, Invoke, InvokeAssembler, IsEmpty, IsExchangeOrder, IsHardGoodsDroplet, IsNull, IsReturnable, IsReturnActive, ItemLink, ItemLookupDroplet, ItemPricingDroplet, ItemsSplitbyType, LostPromotions, MapRPCDroplet, MapToArrayDefaultFirst, MarkerDroplet, NavHistoryCollector, NodeMatch, NonReturnItemDetailsDroplet, OrderLookup, OverrideContextPathMode, PageEventTriggerDroplet, PaymentGroupDroplet, PossibleValues, PriceDroplet, ProductListContains, PromotionDroplet, ProtocolChange, Range, Redirect, RepositoryLookup, RepositoryServlet, ReturnDroplet, ReturnRequestLookup, RuleBasedRepositoryItemGroupFilter, ScheduledOrderInfo, ScheduledOrderLookup, SecurityAccessor, SharingSitesDroplet, ShipItemRelPriceDroplet, ShippableGroupsDroplet, ShippingDroplet, ShippingGroupDroplet, ShippingGroupSubtotal, SiteGroupsDroplet, SiteIdForItemDroplet, SiteLinkDroplet, SitesShareShareableDroplet, StateDescriptionDroplet, Switch, TableForEach, TableRange, TargetPrincipalsDroplet, TypeAheadDroplet, UnitOfMeasureDroplet, UnitPriceDetailDroplet, UserListDroplet, ViewPrincipalsDroplet, WorkflowInstanceQueryDroplet, WorkflowTaskQueryDroplet, XMLToDOM, XMLTransform

public abstract class DynamoServlet
extends HttpServletService
implements ParameterServlet

This is an HttpServlet implementation that is also a Nucleus service. In addition, this passes calls with DynamoHttpServletRequest/Response objects to a separate service method that should be implemented.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected boolean	mAllowCleanupRequest Set to false to prevent request cleanup code from being called.
protected java.util.Dictionary	mParameters Any parameters defined for this servlet

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

Constructors

Constructor and Description
DynamoServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doDelete(DynamoHttpServletRequest req, DynamoHttpServletResponse res) Default implementation of DELETE.
protected void	doGet(DynamoHttpServletRequest req, DynamoHttpServletResponse res) Default implementation of GET.
protected void	doPost(DynamoHttpServletRequest req, DynamoHttpServletResponse res) Default implementation of POST.
protected void	doPut(DynamoHttpServletRequest req, DynamoHttpServletResponse res) Default implementation of PUT.
java.lang.Object	getParameter(java.lang.String pName) Return the specified parameters defined for this servlet
java.util.Dictionary	getParameters() Return any parameters defined for this servlet
javax.servlet.ServletContext	getServletContext() Returns this servlet's ServletContext
void	init(javax.servlet.ServletConfig config) Initializes the servlet.
void	service(DynamoHttpServletRequest req, DynamoHttpServletResponse res) This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do".
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) The service method
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) The service method - go directly from a Servlet to a DynamoHttpServlet for efficiency.
void	setParameter(java.lang.String pName, java.lang.Object pValue)

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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mAllowCleanupRequest

protected boolean mAllowCleanupRequest

Set to false to prevent request cleanup code from being called.

mParameters

protected java.util.Dictionary mParameters

Any parameters defined for this servlet

Constructor Detail

DynamoServlet

public DynamoServlet()

Method Detail

setParameter

public void setParameter(java.lang.String pName,
                         java.lang.Object pValue)

Specified by:

setParameter in interface ParameterServlet

getParameters

public java.util.Dictionary getParameters()

Return any parameters defined for this servlet

Specified by:

getParameters in interface ParameterServlet

getParameter

public java.lang.Object getParameter(java.lang.String pName)

Return the specified parameters defined for this servlet

Specified by:

getParameter in interface ParameterServlet

getServletContext

public javax.servlet.ServletContext getServletContext()

Returns this servlet's ServletContext

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Description copied from class: ServletService

Initializes the servlet. This is called automatically by the system when the servlet is first loaded.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class ServletService

Throws:

javax.servlet.ServletException - if a servlet exception has occurred

service

public void service(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    java.io.IOException

The service method - go directly from a Servlet to a DynamoHttpServlet for efficiency.

Specified by:

service in interface javax.servlet.Servlet

Overrides:

service in class HttpServletService

Parameters:

req - the servlet request

res - the servlet response

Throws:

javax.servlet.ServletException - if an error occurred while processing the servlet request

java.io.IOException - if an error occurred while reading or writing the servlet request

service

public void service(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)
             throws javax.servlet.ServletException,
                    java.io.IOException

The service method

Specified by:

service in class HttpServletService

Parameters:

req - the servlet request

res - the servlet response

Throws:

javax.servlet.ServletException - if an error occurred while processing the servlet request

java.io.IOException - if an error occurred while reading or writing the servlet request

service

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

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

Parameters:

req - the request to be processed

res - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

doGet

protected void doGet(DynamoHttpServletRequest req,
                     DynamoHttpServletResponse res)
              throws javax.servlet.ServletException,
                     java.io.IOException

Default implementation of GET. Simply returns a bad request error.

Parameters:

req - the request to be processed

res - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

doPut

protected void doPut(DynamoHttpServletRequest req,
                     DynamoHttpServletResponse res)
              throws javax.servlet.ServletException,
                     java.io.IOException

Default implementation of PUT. Simply returns a bad request error.

Parameters:

req - the request to be processed

res - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

doDelete

protected void doDelete(DynamoHttpServletRequest req,
                        DynamoHttpServletResponse res)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Default implementation of DELETE. Simply returns a bad request error.

Parameters:

req - the request to be processed

res - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.

doPost

protected void doPost(DynamoHttpServletRequest req,
                      DynamoHttpServletResponse res)
               throws javax.servlet.ServletException,
                      java.io.IOException

Default implementation of POST. Simply returns a bad request error.

Parameters:

req - the request to be processed

res - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.