|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.b2bcommerce.approval.processor.ProcPopulatePipelineParams
public class ProcPopulatePipelineParams
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.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 |
---|
public static java.lang.String CLASS_VERSION
public final int SUCCESS
public final int FAILURE
Constructor Detail |
---|
public ProcPopulatePipelineParams()
ProcPopulatePipelineParams
instance.
Method Detail |
---|
public int getSuccessReturnValue()
public void setSuccessReturnValue(int pSuccessReturnValue)
pSuccessReturnValue
- the value to set for property successReturnValuepublic int getFailureReturnValue()
public void setFailureReturnValue(int pFailureReturnValue)
pFailureReturnValue
- the value to set for property failureReturnValuepublic boolean getReturnFailureOnPropertyNotFound()
public void setReturnFailureOnPropertyNotFound(boolean pReturnFailureOnPropertyNotFound)
pReturnFailureOnPropertyNotFound
- the value to set for property ReturnFailureOnPropertyNotFoundpublic java.util.Properties getObjectMsgToPipelineParamMap()
public void setObjectMsgToPipelineParamMap(java.util.Properties pObjectMsgToPipelineParamMap)
pObjectMsgToPipelineParamMap
- public ServiceMap getNucleusComponentParamMap()
public void setNucleusComponentParamMap(ServiceMap pNucleusComponentParamMap)
pNucleusComponentParamMap
- the value to set for property nucleusComponentParamMappublic int[] getRetCodes()
PipelineProcessor
getRetCodes
in interface PipelineProcessor
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
PipelineProcessor
runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other data
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |