atg.repository.servlet
Class RepositoryQueryServlet

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.repository.servlet.RepositoryServlet
                              atg.repository.servlet.RepositoryQueryServlet

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

public class RepositoryQueryServlet
extends RepositoryServlet

Servlet used to execute a repository query

Nested Class Summary

class

RepositoryQueryServlet.QueryParameters Class used to store repository query params

Nested classes/interfaces inherited from class atg.repository.servlet.RepositoryServlet

RepositoryServlet.RepositoryParameters

Field Summary

static java.lang.String	CLASS_VERSION
static java.lang.String	QUERY Parameter used to hold the query
static java.lang.String	QUERYENDINDEX Parameter used to hold the endingindex
static java.lang.String	QUERYITEMS Parameter used to hold the resultant items
static java.lang.String	QUERYSORT Parameter used to hold the sortdirective
static java.lang.String	QUERYSTARTINDEX Parameter used to hold the startindex

Fields inherited from class atg.repository.servlet.RepositoryServlet

OUTPUT, REPOSITORY, VIEWNAME

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

RepositoryQueryServlet()

Method Summary

protected RepositoryItem[]	executeQuery(Repository pRepository, Query pQuery, RepositoryView pView, SortDirectives pSortDirectives, int pStartingIndex, int pEndingIndex) Excecute a repository query
protected RepositoryItem[]	executeQuery(Repository pRepository, Query pQuery, java.lang.String pViewName, SortDirectives pSortDirectives, int pStartingIndex, int pEndingIndex) Excecute a repository query
protected Query	getDefaultQuery(Repository pRepository, java.lang.String pViewName) Access the default query of the repository servlet
protected Query	getDefaultQuery(RepositoryView pView) Access the default query of the repository servlet
protected void	getInputParameters(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, RepositoryQueryServlet.QueryParameters pQueryParams) Gets the QueryParameters for a serviced request
void	RepositoryQuery() Constructs an instanceof RepositoryQuery
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Service the RepositoryServlet servlet

Methods inherited from class atg.repository.servlet.RepositoryServlet

getDefaultView, getDefaultViewName, getInputParameters, getRepository, getRepositoryParam, getRepositoryView, getViewNameParam, setRepository

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, 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

QUERY

public static final java.lang.String QUERY

Parameter used to hold the query

See Also:

#getQuery, Constant Field Values

QUERYSTARTINDEX

public static final java.lang.String QUERYSTARTINDEX

Parameter used to hold the startindex

See Also:

#getStartingIndex, Constant Field Values

QUERYENDINDEX

public static final java.lang.String QUERYENDINDEX

Parameter used to hold the endingindex

See Also:

#getEndingIndex, Constant Field Values

QUERYSORT

public static final java.lang.String QUERYSORT

Parameter used to hold the sortdirective

See Also:

#getSortDirectives, Constant Field Values

QUERYITEMS

public static final java.lang.String QUERYITEMS

Parameter used to hold the resultant items

See Also:

Constant Field Values

Constructor Detail

RepositoryQueryServlet

public RepositoryQueryServlet()

Method Detail

RepositoryQuery

public void RepositoryQuery()

Constructs an instanceof RepositoryQuery

service

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

Service the RepositoryServlet servlet

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the servlet request

pResponse - the servlet response

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.

getInputParameters

protected void getInputParameters(DynamoHttpServletRequest pRequest,
                                  DynamoHttpServletResponse pResponse,
                                  RepositoryQueryServlet.QueryParameters pQueryParams)

Gets the QueryParameters for a serviced request

Parameters:

pRequest - the servlet request

pResponse - the servlet response

pQueryParams - RepositoryParameters

getDefaultQuery

protected Query getDefaultQuery(Repository pRepository,
                                java.lang.String pViewName)

Access the default query of the repository servlet

Parameters:

pRepository - the repository

pViewName - a repository view

Returns:

a query

getDefaultQuery

protected Query getDefaultQuery(RepositoryView pView)

Access the default query of the repository servlet

Parameters:

pView - a repository view name

Returns:

a query

executeQuery

protected RepositoryItem[] executeQuery(Repository pRepository,
                                        Query pQuery,
                                        RepositoryView pView,
                                        SortDirectives pSortDirectives,
                                        int pStartingIndex,
                                        int pEndingIndex)

Excecute a repository query

Parameters:

pRepository - the repository

pQuery - the query

pView - a repository view

pSortDirectives - sort directives

pStartingIndex - staring index

pEndingIndex - ending index

Returns:

results of the query

executeQuery

protected RepositoryItem[] executeQuery(Repository pRepository,
                                        Query pQuery,
                                        java.lang.String pViewName,
                                        SortDirectives pSortDirectives,
                                        int pStartingIndex,
                                        int pEndingIndex)

Excecute a repository query

Parameters:

pRepository - the repository

pQuery - the query

pViewName - a repository view

pSortDirectives - sort directives

pStartingIndex - staring index

pEndingIndex - ending index

Returns:

results of the query