atg.repository.servlet
Class RepositoryServlet

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
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.repository.servlet.RepositoryServlet
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet
Direct Known Subclasses:
RepositoryQueryServlet

public class RepositoryServlet
extends DynamoServlet

This class serves as a base class for servlet interaction with a Repository.

See Also:
RepositoryQueryServlet

Nested Class Summary
 class RepositoryServlet.RepositoryParameters
          A class used to hold parameters sent to a RepositoryServlet
 
Field Summary
static java.lang.String CLASS_VERSION
           
static java.lang.String OUTPUT
          Parameter used to hold output of the servlet
static java.lang.String REPOSITORY
          Parameter used to hold the name of a repository
static java.lang.String VIEWNAME
          Parameter used to hold the name of a view in a repository
 
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
RepositoryServlet()
          Constructs an instanceof RepositoryServlet
 
Method Summary
protected  RepositoryView getDefaultView(Repository pRepository)
          Access the default view of a repository
protected  java.lang.String getDefaultViewName(Repository pRepository)
          Access the default view name of a repository
protected  void getInputParameters(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, RepositoryServlet.RepositoryParameters pRParams)
          Gets the RepositoryParameters for a serviced request
 Repository getRepository()
          Returns property Repository
protected  Repository getRepositoryParam(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
          Gets the Repository param for a serviced request
protected  RepositoryView getRepositoryView(Repository pRepository, java.lang.String pViewName)
          Access a view of a repository
protected  java.lang.String getViewNameParam(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
          Gets the Repository view for a serviced request
 void setRepository(Repository r)
          Sets property Repository
 
Methods inherited from class atg.servlet.DynamoServlet
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, service, setParameter
 
Methods inherited from class atg.nucleus.servlet.ServletService
destroy, getServletConfig, getServletInfo, init, 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, 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, reResolveThis, 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

REPOSITORY

public static final java.lang.String REPOSITORY
Parameter used to hold the name of a repository

See Also:
getRepositoryParam(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse), Constant Field Values

VIEWNAME

public static final java.lang.String VIEWNAME
Parameter used to hold the name of a view in a repository

See Also:
getViewNameParam(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse), Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT
Parameter used to hold output of the servlet

See Also:
Constant Field Values
Constructor Detail

RepositoryServlet

public RepositoryServlet()
Constructs an instanceof RepositoryServlet

Method Detail

getRepository

public Repository getRepository()
Returns property Repository


setRepository

public void setRepository(Repository r)
Sets property Repository


getDefaultViewName

protected java.lang.String getDefaultViewName(Repository pRepository)
Access the default view name of a repository

Parameters:
pRepository - the repository
Returns:
default repository view name

getDefaultView

protected RepositoryView getDefaultView(Repository pRepository)
Access the default view of a repository

Parameters:
pRepository - the repository
Returns:
default repository view

getRepositoryView

protected RepositoryView getRepositoryView(Repository pRepository,
                                           java.lang.String pViewName)
Access a view of a repository

Parameters:
pRepository - the repository
pViewName - the name of the view
Returns:
repository view

getInputParameters

protected void getInputParameters(DynamoHttpServletRequest pRequest,
                                  DynamoHttpServletResponse pResponse,
                                  RepositoryServlet.RepositoryParameters pRParams)
Gets the RepositoryParameters for a serviced request

Parameters:
pRequest - the servlet request
pResponse - the servlet response
pRParams - RepositoryParameters

getRepositoryParam

protected Repository getRepositoryParam(DynamoHttpServletRequest pRequest,
                                        DynamoHttpServletResponse pResponse)
Gets the Repository param for a serviced request

Parameters:
pRequest - the servlet request
pResponse - the servlet response
Returns:
a Repository or null

getViewNameParam

protected java.lang.String getViewNameParam(DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)
Gets the Repository view for a serviced request

Parameters:
pRequest - the servlet request
pResponse - the servlet response
Returns:
a Repository View name or null