public class DefaultWorkflowInterceptor extends MethodFilterInterceptor
An interceptor that makes sure there are not validation, conversion or action errors before allowing the interceptor chain to continue. If a single FieldError or ActionError (including the ones replicated by the Message Store Interceptor in a redirection) is found, the INPUT result will be triggered. This interceptor does not perform any validation.
This interceptor does nothing if the name of the method being invoked is specified in the excludeMethods parameter. excludeMethods accepts a comma-delimited list of method names. For example, requests to foo!input.action and foo!back.action will be skipped by this interceptor if you set the excludeMethods parameter to "input, back".
Note: As this method extends off MethodFilterInterceptor, it is capable of
deciding if it is applicable only to selective methods in the action class. This is done by adding param tags
for the interceptor element, naming either a list of excluded method names and/or a list of included method
names, whereby includeMethods overrides excludedMethods. A single * sign is interpreted as wildcard matching
all methods for both parameters.
See MethodFilterInterceptor for more info.
This interceptor also supports the following interfaces which can implemented by actions:
You can also use InputConfig annotation to change result name returned when validation errors occurred.
Interceptor parameters:
Extending the interceptor:
There are no known extension points for this interceptor.
Example code:
<action name="someAction" class="com.examples.SomeAction">
<interceptor-ref name="params"/>
<interceptor-ref name="validation"/>
<interceptor-ref name="workflow"/>
<result name="success">good_result.ftl</result>
</action>
<-- In this case myMethod as well as mySecondMethod of the action class
will not pass through the workflow process -->
<action name="someAction" class="com.examples.SomeAction">
<interceptor-ref name="params"/>
<interceptor-ref name="validation"/>
<interceptor-ref name="workflow">
<param name="excludeMethods">myMethod,mySecondMethod</param>
</interceptor-ref name="workflow">
<result name="success">good_result.ftl</result>
</action>
<-- In this case, the result named "error" will be used when
an action / field error is found -->
<-- The Interceptor will only be applied for myWorkflowMethod method of action
classes, since this is the only included method while any others are excluded -->
<action name="someAction" class="com.examples.SomeAction">
<interceptor-ref name="params"/>
<interceptor-ref name="validation"/>
<interceptor-ref name="workflow">
<param name="inputResultName">error</param>
<param name="excludeMethods">*</param>
<param name="includeMethods">myWorkflowMethod</param>
</interceptor-ref>
<result name="success">good_result.ftl</result>
</action>
excludeMethods, includeMethods| Constructor and Description |
|---|
DefaultWorkflowInterceptor() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
doIntercept(ActionInvocation invocation)
Intercept
ActionInvocation and returns a inputResultName
when action / field errors is found registered. |
protected String |
processInputConfig(Object action,
String method,
String currentResultName)
Process
InputConfig annotation applied to method |
protected String |
processValidationErrorAware(Object action,
String currentResultName)
Notify action if it implements
ValidationErrorAware interface |
void |
setInputResultName(String inputResultName)
Set the
inputResultName (result name to be returned when
a action / field error is found registered). |
applyInterceptor, getExcludeMethodsSet, getIncludeMethodsSet, intercept, setExcludeMethods, setIncludeMethodsdestroy, initpublic void setInputResultName(String inputResultName)
inputResultName (result name to be returned when
a action / field error is found registered). Default to Action.INPUTinputResultName - what result name to use when there was validation error(s).protected String doIntercept(ActionInvocation invocation) throws Exception
ActionInvocation and returns a inputResultName
when action / field errors is found registered.doIntercept in class MethodFilterInterceptorinvocation - the action invocationException - in case of any errorsprotected String processInputConfig(Object action, String method, String currentResultName) throws Exception
InputConfig annotation applied to methodaction - action objectmethod - methodcurrentResultName - current result nameException - in case of any errorsprotected String processValidationErrorAware(Object action, String currentResultName)
ValidationErrorAware interfaceaction - action objectcurrentResultName - current result nameValidationErrorAwareCopyright © 2000–2020 Apache Software Foundation. All rights reserved.