public class ProcPropertyRestriction extends GenericService implements PipelineProcessor
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
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 |
---|
ProcPropertyRestriction() |
Modifier and Type | Method and Description |
---|---|
protected void |
addErrorMessageToPipelineResult(PipelineResult pResult,
java.lang.String pErrorMessage)
This method adds the given error message to the given PipelineResult object.
|
void |
doStartService()
This is called after a Service has been created, placed into the
naming hierarchy, and initialized with its configured property
values.
|
boolean |
getAddErrorToResultOnTrueEval()
Returns property AddErrorToResultOnTrueEval
|
java.lang.String |
getErrorMessage()
Returns property errorMessage
|
ExpressionParser |
getExpressionParser()
Returns property ExpressionParser
|
java.lang.String |
getPipelineResultErrorMessageKey()
Returns property pipelineResultErrorMessageKey
|
int[] |
getRetCodes()
Returns the valid return codes
1 - The processor completed successfully
2 - The processor failed
|
int |
getReturnValueForFalseEvaluation()
Returns property returnValueForFalseEvaluation
|
int |
getReturnValueForTrueEvaluation()
Returns property returnValueForTrueEvaluation
|
Rule |
getRule()
Returns property rule
|
RuleEvaluator |
getRuleEvaluator()
Returns property RuleEvaluator
|
java.lang.String |
getRuleExpression()
Returns property ruleExpression
|
static void |
main(java.lang.String[] args) |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Evaluates the ruleExpression and if true, will add the string in the errorMessage
property to the PipelineResult object keyed by the string in the pipelineResultErrorMessageKey
property.
|
void |
setAddErrorToResultOnTrueEval(boolean pAddErrorToResultOnTrueEval)
Sets property AddErrorToResultOnTrueEval
|
void |
setErrorMessage(java.lang.String pErrorMessage)
Sets property errorMessage
|
void |
setExpressionParser(ExpressionParser pExpressionParser)
Sets property ExpressionParser
|
void |
setPipelineResultErrorMessageKey(java.lang.String pPipelineResultErrorMessageKey)
Sets property pipelineResultErrorMessageKey
|
void |
setReturnValueForFalseEvaluation(int pReturnValueForFalseEvaluation)
Sets property returnValueForFalseEvaluation
|
void |
setReturnValueForTrueEvaluation(int pReturnValueForTrueEvaluation)
Sets property returnValueForTrueEvaluation
|
void |
setRule(Rule pRule)
Sets property rule
|
void |
setRuleEvaluator(RuleEvaluator pRuleEvaluator)
Sets property RuleEvaluator
|
void |
setRuleExpression(java.lang.String pRuleExpression)
Sets property ruleExpression
|
addLogListener, createAdminServlet, 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 int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
public ExpressionParser getExpressionParser()
public void setExpressionParser(ExpressionParser pExpressionParser)
pExpressionParser
- the value to set for property ExpressionParserpublic RuleEvaluator getRuleEvaluator()
public void setRuleEvaluator(RuleEvaluator pRuleEvaluator)
pRuleEvaluator
- the value to set for property RuleEvaluatorpublic Rule getRule()
public void setRule(Rule pRule)
pRule
- the value to set for property rulepublic java.lang.String getRuleExpression()
public void setRuleExpression(java.lang.String pRuleExpression)
pRuleExpression
- the value to set for property ruleExpressionpublic boolean getAddErrorToResultOnTrueEval()
public void setAddErrorToResultOnTrueEval(boolean pAddErrorToResultOnTrueEval)
pAddErrorToResultOnTrueEval
- the value to set for property AddErrorToResultOnTrueEvalpublic java.lang.String getPipelineResultErrorMessageKey()
public void setPipelineResultErrorMessageKey(java.lang.String pPipelineResultErrorMessageKey)
pPipelineResultErrorMessageKey
- the value to set for property pipelineResultErrorMessageKeypublic java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String pErrorMessage)
pErrorMessage
- the value to set for property errorMessagepublic int getReturnValueForTrueEvaluation()
public void setReturnValueForTrueEvaluation(int pReturnValueForTrueEvaluation)
pReturnValueForTrueEvaluation
- the value to set for property returnValueForTrueEvaluationpublic int getReturnValueForFalseEvaluation()
public void setReturnValueForFalseEvaluation(int pReturnValueForFalseEvaluation)
pReturnValueForFalseEvaluation
- the value to set for property returnValueForFalseEvaluationpublic void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- a HashMap which must contain the objects to satisfy the rulespResult
- a PipelineResult object which stores any information which must
be returned from this method invokationjava.lang.Exception
- throws any exception back to the callerPipelineProcessor.runProcess(Object, PipelineResult)
protected void addErrorMessageToPipelineResult(PipelineResult pResult, java.lang.String pErrorMessage)
pResult
- the PipelineResult object to store the error message inpErrorMessage
- the error message to storePipelineResult
public static void main(java.lang.String[] args)