atg.adc.pipeline
Class PipelinedDataReporter

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.pipeline.PipelinedDataReporter

All Implemented Interfaces:

ADCDataReporter, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class PipelinedDataReporter
extends GenericService
implements ADCDataReporter

This implementation of ADCDataReporter will determine the ADC data by executing a pipeline.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected static java.util.ResourceBundle	sResourceBundle Resource Bundle

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

PipelinedDataReporter()

Method Summary

ADCPipelineArgs	createPipelineArgs(ADCRequestData pRequestData) Create the argument class that gets passed into the pipeline By default, this creates an instance of atg.adc.pipeline.ADCPipelineArgs.
java.lang.String	getADCClientName() This method returns the unique client name assoicated with this data reporter.
java.lang.String	getPipelineArgsClass()
PipelineManager	getPipelineManager()
java.lang.String	getProcessADCDataChainName()
java.lang.String	processADCData(ADCRequestData pRequestData) Execute the chain.
void	setADCClientName(java.lang.String pADCClientName) The name of the ADC client, unique among all clients
void	setPipelineArgsClass(java.lang.String pPipelineArgsClass) The atg.adc.pipeline.ADCPipelineArgs that should be passed to each pipeline
void	setPipelineManager(PipelineManager pPipelineManager) The pipeline manager that is configured with the relevant pipeline chains
void	setProcessADCDataChainName(java.lang.String pProcessADCDataChainName) The name of the pipeline chain that is used to process the ADC data

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 final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

PipelinedDataReporter

public PipelinedDataReporter()

Method Detail

setADCClientName

public void setADCClientName(java.lang.String pADCClientName)

The name of the ADC client, unique among all clients

Parameters:

pADCClientName - The name of the ADC client

getADCClientName

public java.lang.String getADCClientName()

Description copied from interface: ADCDataReporter

This method returns the unique client name assoicated with this data reporter.

Specified by:

getADCClientName in interface ADCDataReporter

Returns:

The unique name of the ADC client

setPipelineManager

public void setPipelineManager(PipelineManager pPipelineManager)

The pipeline manager that is configured with the relevant pipeline chains

Parameters:

pPipelineManager - The pipeline manager that is configured with the relevant pipeline chains

getPipelineManager

public PipelineManager getPipelineManager()

Returns:

The pipeline manager that is configured with the relevant pipeline chains

setProcessADCDataChainName

public void setProcessADCDataChainName(java.lang.String pProcessADCDataChainName)

The name of the pipeline chain that is used to process the ADC data

Parameters:

pProcessADCDataChainName - The name of the pipeline chain that is used to process the ADC data

getProcessADCDataChainName

public java.lang.String getProcessADCDataChainName()

Returns:

The name of the pipeline chain that is used to process the ADC data

setPipelineArgsClass

public void setPipelineArgsClass(java.lang.String pPipelineArgsClass)

The atg.adc.pipeline.ADCPipelineArgs that should be passed to each pipeline

Parameters:

pPipelineArgsClass - The atg.adc.pipeline.ADCPipelineArgs \ that should be passed to each pipeline

getPipelineArgsClass

public java.lang.String getPipelineArgsClass()

Returns:

The atg.adc.pipeline.ADCPipelineArgs that should be passed to each pipeline

processADCData

public java.lang.String processADCData(ADCRequestData pRequestData)
                                throws ADCException

Execute the chain. The end result is a String that can be inserted into the page.

Specified by:

processADCData in interface ADCDataReporter

Parameters:

pRequestData - The request scoped collection of data seen in this request

Returns:

A String that can be inserted in the page sent back in the response

Throws:

ADCException

createPipelineArgs

public ADCPipelineArgs createPipelineArgs(ADCRequestData pRequestData)
                                   throws ADCException

Create the argument class that gets passed into the pipeline By default, this creates an instance of atg.adc.pipeline.ADCPipelineArgs. However, you can set pipelineArgsClass to a subclass of ADCPipelineArgs if you want to use something else.

Parameters:

pRequestData - The request scoped data for this request

Returns:

A new instance of ADCPipelineArgs

Throws:

ADCException