atg.endeca.assembler.droplet
Class InvokeAssembler

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.endeca.assembler.droplet.InvokeAssembler

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

A Droplet used to invoke the Assembler. The Assembler assembles the content defined in Experience Manager.

Input Parameters

includePath: Path passed to ContentInclude. For example "/pages/browse" contentCollection: Path passed to ContentSlotConfig. For example "/shared/SearchBoxAutoSuggestContent". ruleLimit: Rule limit passed to ContentSlotConfig

Open Parameters

output: Rendered when the assembler returned content. error: An error occurred

Output Parameters

contentItem: The content assembled by the assembler.

Field Summary

static java.lang.String	CONTENT_COLLECTION
static java.lang.String	CONTENT_ITEM_PARAM
static java.lang.String	ERROR_OPARAM
static java.lang.String	INCLUDE_PATH
static java.lang.String	OUTPUT_OPARAM
static java.lang.String	RULE_LIMIT

Fields inherited from class atg.servlet.DynamoServlet

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

InvokeAssembler()

Method Summary

AssemblerTools	getAssemblerTools()
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Invokes the Assembler and assembles the content specified by the "includePath" input parameter or the "contentCollection" input parameter.
void	setAssemblerTools(AssemblerTools pAssemblerTools) Set a new assembler tools class

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

INCLUDE_PATH

public static final java.lang.String INCLUDE_PATH

See Also:

Constant Field Values

CONTENT_COLLECTION

public static final java.lang.String CONTENT_COLLECTION

See Also:

Constant Field Values

RULE_LIMIT

public static final java.lang.String RULE_LIMIT

See Also:

Constant Field Values

OUTPUT_OPARAM

public static final java.lang.String OUTPUT_OPARAM

See Also:

Constant Field Values

ERROR_OPARAM

public static final java.lang.String ERROR_OPARAM

See Also:

Constant Field Values

CONTENT_ITEM_PARAM

public static final java.lang.String CONTENT_ITEM_PARAM

See Also:

Constant Field Values

Constructor Detail

InvokeAssembler

public InvokeAssembler()

Method Detail

getAssemblerTools

public AssemblerTools getAssemblerTools()

Returns:

The assembler tools class

setAssemblerTools

public void setAssemblerTools(AssemblerTools pAssemblerTools)

Set a new assembler tools class

Parameters:

pAssemblerTools -

service

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

Invokes the Assembler and assembles the content specified by the "includePath" input parameter or the "contentCollection" input parameter. The assembled content will be available in the "contentItem" output parameter rendered inside the "output" open parameter. If no content is assembled the "empty" open parameter is rendered. If an error occurs the "error" open parameter is rendered.

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

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