public class ProcDispatchOnProperty extends GenericService implements PipelineProcessor
This processor allows you to specify an object in the pipeline arguments map and the name of some property on that object. It finds the named property's value, then looks up that value in a dispatch table and returns the corresponding integer value. This allows you to control pipeline transitions based on a property value.
For example, a generic "validatePaymentGroup" pipeline might branch based on the payment group class type by configuring an instance of this processor to examine the "paymentGroupClassType" property and including it in the pipeline as follows:
<pipelinelink name="DispatchOnType">
<processor jndi="/atg/commerce/order/processor/DispatchOnPaymentType"/>
<transition returnvalue="1" link="ValidateCreditCard"/>
<transition returnvalue="2" link="ValidateStoreCredit"/>
<transition returnvalue="3" link="ValidateGiftCertificate"/>
</pipelinelink>
The mapping of payment types to transition values is set through the
returnValues
property of this pipeline processor, e.g.:
returnValues=\
creditCard=1,\
storeCredit=2,\
giftCertificate=3,\
myCreditCard=1
You can assign the same return value to multiple property values if you want them to follow the same pipeline processor transition. For example, you could have your own extended credit card payment method use the same validation process as the build-in credit card payment method by assigning both methods the same return value as shown above.
This processor assumes that the type of the pipeline arguments object is compatible with and may be cast to java.util.Map.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
protected static java.util.ResourceBundle |
sDefaultResources |
SERVICE_INFO_KEY
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ProcDispatchOnProperty() |
Modifier and Type | Method and Description |
---|---|
protected void |
convertReturnValues(java.util.Properties pReturnValues)
Build the
valueMap and retCodes objects from
the values specified in pReturnValues . |
int |
getDefaultReturnValue()
Get the default value to return if
propertyName's value
is not found in the lookup table. |
java.lang.String |
getPipelineKey()
Get the lookup key that will identify the target object in the pipeline
arguments map.
|
java.lang.String |
getPropertyName()
Set the name of the property whose value will determine the next
processor invoked.
|
int[] |
getRetCodes()
Get the list of return values this processor can return.
|
java.util.Properties |
getReturnValues()
Return the mapping between values of
propertyName and
return values from runProcess . |
protected int |
getTransitionValue(java.lang.Object pPropertyValue)
Given a value for the property specified by
propertyName ,
find the corresponding return value from returnValues ,
choosing the default value if the property value was not listed in
the lookup table. |
java.util.HashMap |
getValueMap()
Get the mapping from property values to Integer return codes.
|
boolean |
isWarnOnDefaultValue()
Query whether or not to log a warning when returning
defaultReturnValue for a property value that was
not found in the lookup table. |
static void |
main(java.lang.String[] args)
Test method for
convertReturnValues and
getTransitionValue . |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Look up the object identified by
pipelineKey in the
arguments map, retrieve the property named by
propertyName , and return a value based on that property's
value. |
void |
setDefaultReturnValue(int pDefaultReturnValue)
Set the default value to return if
propertyName's value
is not found in the lookup table. |
void |
setPipelineKey(java.lang.String pPipelineKey)
Set the lookup key that will identify the target object in the pipeline
arguments map.
|
void |
setPropertyName(java.lang.String pPropertyName)
Set the name of the property whose value will determine the next
processor invoked.
|
void |
setReturnValues(java.util.Properties pReturnValues)
Specify the mapping between values of
propertyName and
return values from runProcess . |
void |
setWarnOnDefaultValue(boolean pWarnOnDefaultValue)
Specify whether or not to log a warning when returning
defaultReturnValue for a property value that was
not found in the lookup table. |
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final java.lang.String CLASS_VERSION
protected static java.util.ResourceBundle sDefaultResources
public void setPipelineKey(java.lang.String pPipelineKey)
public java.lang.String getPipelineKey()
public void setPropertyName(java.lang.String pPropertyName)
public java.lang.String getPropertyName()
public void setReturnValues(java.util.Properties pReturnValues)
propertyName
and
return values from runProcess
.pReturnValues
- A properties object that specifies mappings between property
values and return values expressed as strings. Each value in
the properties object must be parsable as an integer. The
returnValues
object is of type Properties only
to simplify setting the values from a Nucleus configuration
file.public java.util.Properties getReturnValues()
propertyName
and
return values from runProcess
.public void setDefaultReturnValue(int pDefaultReturnValue)
propertyName's
value
is not found in the lookup table.public int getDefaultReturnValue()
propertyName's
value
is not found in the lookup table.public void setWarnOnDefaultValue(boolean pWarnOnDefaultValue)
defaultReturnValue
for a property value that was
not found in the lookup table.public boolean isWarnOnDefaultValue()
defaultReturnValue
for a property value that was
not found in the lookup table. The default value is true.public java.util.HashMap getValueMap()
returnValues
Properties
object and building a parallel structure whose keys are strings, but
whose values are Integers instead of Strings, as in the Properties
object.public int[] getRetCodes()
returnValues
Properties object and
the defaultReturnValue
and building an array containing
exactly one copy of each value that can be returned.getRetCodes
in interface PipelineProcessor
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
pipelineKey
in the
arguments map, retrieve the property named by
propertyName
, and return a value based on that property's
value.runProcess
in interface PipelineProcessor
pParam
- Pipeline arguments object, assumed to be of a type that can be
cast to java.util.MappResult
- Pipeline results object, not used by this method.java.lang.ClassCastException
- If the type of pParam is not compatible with java.util.Map.InvalidParameterException
- If the object named by pipelineKey
does not appear
in the parameter map.PropertyNotFoundException
- If the object does not have a property with the name specified
by propertyName
.java.lang.Exception
protected int getTransitionValue(java.lang.Object pPropertyValue)
propertyName
,
find the corresponding return value from returnValues
,
choosing the default value if the property value was not listed in
the lookup table.pPropertyValue
- The value upon which to dispatch to the next pipeline processor.protected void convertReturnValues(java.util.Properties pReturnValues)
valueMap
and retCodes
objects from
the values specified in pReturnValues
.public static void main(java.lang.String[] args)
convertReturnValues
and
getTransitionValue
.