atg.b2bcommerce.approval.processor
Class ProcPopulatePipelineParams

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.b2bcommerce.approval.processor.ProcPopulatePipelineParams

All Implemented Interfaces:

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

public class ProcPopulatePipelineParams
extends GenericService
implements PipelineProcessor

This processor extracts properties from a JMS message object and populates them into the pParam parameter. In addition it will also add nucleus components to the pParam parameter. This processor assumes that pParam is a java.util.Map object. The ObjectMsgToPipelineParamMap property maps property names to Strings which will be used as the keys in the map. See example: objectMsgToPipelineParamMap=\ order=Order,\ profile=Profile In the above, the property value named "order" will be added to the Map referenced by the key "Order". The nucleusComponentParamMap contains nucleus object references mapped to Strings which will be used as the keys in the map. nucleusComponentParamMap=\ OrderManager=/atg/commerce/order/OrderManager In the above, the nucleus component /atg/commerce/order/OrderManager will be added to the Map referenced by the key "OrderManager". Note that all properties supplied in the objectMsgToPipelineParamMap need to by objects and cannot be primitive types.

Field Summary

static java.lang.String	CLASS_VERSION
int	FAILURE
int	SUCCESS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

ProcPopulatePipelineParams()
Creates a new ProcPopulatePipelineParams instance.

Method Summary

int	getFailureReturnValue() Returns property failureReturnValue
ServiceMap	getNucleusComponentParamMap() Returns property nucleusComponentParamMap
java.util.Properties	getObjectMsgToPipelineParamMap() Return the ObjectMsgToPipelineParamMap property.
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
boolean	getReturnFailureOnPropertyNotFound() Returns property ReturnFailureOnPropertyNotFound
int	getSuccessReturnValue() Returns property successReturnValue
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method runs the actual processor and does the work.
void	setFailureReturnValue(int pFailureReturnValue) Sets property failureReturnValue
void	setNucleusComponentParamMap(ServiceMap pNucleusComponentParamMap) Sets property nucleusComponentParamMap
void	setObjectMsgToPipelineParamMap(java.util.Properties pObjectMsgToPipelineParamMap) Set the ObjectMsgToPipelineParamMap property.
void	setReturnFailureOnPropertyNotFound(boolean pReturnFailureOnPropertyNotFound) Sets property ReturnFailureOnPropertyNotFound
void	setSuccessReturnValue(int pSuccessReturnValue) Sets property successReturnValue

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

SUCCESS

public final int SUCCESS

See Also:

Constant Field Values

FAILURE

public final int FAILURE

See Also:

Constant Field Values

Constructor Detail

ProcPopulatePipelineParams

public ProcPopulatePipelineParams()

Creates a new ProcPopulatePipelineParams instance.

Method Detail

getSuccessReturnValue

public int getSuccessReturnValue()

Returns property successReturnValue

Returns:

returns property successReturnValue

setSuccessReturnValue

public void setSuccessReturnValue(int pSuccessReturnValue)

Sets property successReturnValue

Parameters:

pSuccessReturnValue - the value to set for property successReturnValue

getFailureReturnValue

public int getFailureReturnValue()

Returns property failureReturnValue

Returns:

returns property failureReturnValue

setFailureReturnValue

public void setFailureReturnValue(int pFailureReturnValue)

Sets property failureReturnValue

Parameters:

pFailureReturnValue - the value to set for property failureReturnValue

getReturnFailureOnPropertyNotFound

public boolean getReturnFailureOnPropertyNotFound()

Returns property ReturnFailureOnPropertyNotFound

Returns:

returns property ReturnFailureOnPropertyNotFound

setReturnFailureOnPropertyNotFound

public void setReturnFailureOnPropertyNotFound(boolean pReturnFailureOnPropertyNotFound)

Sets property ReturnFailureOnPropertyNotFound

Parameters:

pReturnFailureOnPropertyNotFound - the value to set for property ReturnFailureOnPropertyNotFound

getObjectMsgToPipelineParamMap

public java.util.Properties getObjectMsgToPipelineParamMap()

Return the ObjectMsgToPipelineParamMap property.

Returns:

setObjectMsgToPipelineParamMap

public void setObjectMsgToPipelineParamMap(java.util.Properties pObjectMsgToPipelineParamMap)

Set the ObjectMsgToPipelineParamMap property.

Parameters:

pObjectMsgToPipelineParamMap -

getNucleusComponentParamMap

public ServiceMap getNucleusComponentParamMap()

Returns property nucleusComponentParamMap

Returns:

returns property nucleusComponentParamMap

setNucleusComponentParamMap

public void setNucleusComponentParamMap(ServiceMap pNucleusComponentParamMap)

Sets property nucleusComponentParamMap

Parameters:

pNucleusComponentParamMap - the value to set for property nucleusComponentParamMap

getRetCodes

public int[] getRetCodes()

Description copied from interface: PipelineProcessor

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

Description copied from interface: PipelineProcessor

This method runs the actual processor and does the work. pParam is user data and pResult is an object which contains result data. The return value of the method is what determines what the next link to be executed is.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

pResult - the PipelineResult object which is used to return errors or other data

Returns:

an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception