atg.nucleus.servlet
Class ServletService

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener, javax.servlet.Servlet
Direct Known Subclasses:
HttpServletService

public abstract class ServletService
extends TimedOperationService
implements javax.servlet.Servlet

A base class implementation of the Nucleus Service and the Java Servlet interfaces.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static java.lang.String SERVLET_INFO_KEY
          Should be used as a key to retrieve the servletInfo property from ResourceBundles
 
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
ServletService()
           
 
Method Summary
 void destroy()
          Destroys the servlet and cleans up whatever resources are being held.
 javax.servlet.ServletConfig getServletConfig()
          Returns the configuration for this servlet.
 java.lang.String getServletInfo()
          Returns the information string for this servlet
 void init(javax.servlet.ServletConfig pConfig)
          Initializes the servlet.
abstract  void service(javax.servlet.ServletRequest pRequest, javax.servlet.ServletResponse pResponse)
          Services a single request from the client.
 void setServletInfo(java.lang.String pServletInfo)
          Sets the information string for this servlet
 
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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
 
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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


SERVLET_INFO_KEY

public static final java.lang.String SERVLET_INFO_KEY
Should be used as a key to retrieve the servletInfo property from ResourceBundles

See Also:
Constant Field Values
Constructor Detail

ServletService

public ServletService()
Method Detail

init

public void init(javax.servlet.ServletConfig pConfig)
          throws javax.servlet.ServletException
Initializes the servlet. This is called automatically by the system when the servlet is first loaded.

Specified by:
init in interface javax.servlet.Servlet
Parameters:
pServletConfig - servlet configuration information
Throws:
javax.servlet.ServletException - if a servlet exception has occurred

getServletConfig

public javax.servlet.ServletConfig getServletConfig()
Returns the configuration for this servlet.

Specified by:
getServletConfig in interface javax.servlet.Servlet

service

public abstract void service(javax.servlet.ServletRequest pRequest,
                             javax.servlet.ServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException
Services a single request from the client.

Specified by:
service in interface javax.servlet.Servlet
Parameters:
pRequest - the servlet request
pResponse - the servlet response
Throws:
javax.servlet.ServletException - if a servlet exception has occurred
java.io.IOException - if an I/O exception has occurred

getServletInfo

public java.lang.String getServletInfo()
Returns the information string for this servlet

Specified by:
getServletInfo in interface javax.servlet.Servlet

setServletInfo

public void setServletInfo(java.lang.String pServletInfo)
Sets the information string for this servlet


destroy

public void destroy()
Destroys the servlet and cleans up whatever resources are being held.

Specified by:
destroy in interface javax.servlet.Servlet