com.opensymphony.xwork2.interceptor
Class DefaultWorkflowInterceptor

java.lang.Object
  extended by com.opensymphony.xwork2.interceptor.AbstractInterceptor
      extended by com.opensymphony.xwork2.interceptor.MethodFilterInterceptor
          extended by com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor
All Implemented Interfaces:
Interceptor, java.io.Serializable

public class DefaultWorkflowInterceptor
extends MethodFilterInterceptor

An interceptor that does some basic validation workflow before allowing the interceptor chain to continue.

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".

The order of execution in the workflow is:

  1. If the action being executed implements Validateable, the action's validate method is called.
  2. Next, if the action implements ValidationAware, the action's hasErrors method is called. If this method returns true, this interceptor stops the chain from continuing and immediately returns Action.INPUT

Note: if the action doesn't implement either interface, this interceptor effectively does nothing. This interceptor is often used with the validation interceptor. However, it does not have to be, especially if you wish to write all your validation rules by hand in the validate() method rather than in XML files.

NOTE: As this method extends off MethodFilterInterceptor, it is capable of deciding if it is applicable only to selective methods in the action class. See MethodFilterInterceptor for more info.

Update: Added logic to execute a validate{MethodName} and then conditionally followed than a general validate method, depending on the 'alwaysInvokeValidate' parameter/property which is by default set to true. This allows us to run some validation logic based on the method name we specify in the ActionProxy. For example, you can specify a validateInput() method that will be run before the invocation of the input method.

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 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</param>
     </interceptor-ref name="workflow">
     <result name="success">good_result.ftl</result>
 </action>
 
 
 

Version:
$Date: 2006-09-14 11:50:43 -0500 (Thu, 14 Sep 2006) $ $Id: DefaultWorkflowInterceptor.java 1136 2006-09-14 16:50:43Z tm_jee $
Author:
Jason Carreira, Rainer Hermanns, Alexandru Popescu, Philip Luppens, tm_jee
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.opensymphony.xwork2.interceptor.MethodFilterInterceptor
excludeMethods, includeMethods, log
 
Constructor Summary
DefaultWorkflowInterceptor()
           
 
Method Summary
protected  java.lang.String doIntercept(ActionInvocation invocation)
          Subclasses must override to implement the interceptor logic.
 void setAlwaysInvokeValidate(java.lang.String alwaysInvokeValidate)
           
 
Methods inherited from class com.opensymphony.xwork2.interceptor.MethodFilterInterceptor
applyInterceptor, getExcludeMethodsSet, getIncludeMethodsSet, intercept, setExcludeMethods, setIncludeMethods
 
Methods inherited from class com.opensymphony.xwork2.interceptor.AbstractInterceptor
destroy, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultWorkflowInterceptor

public DefaultWorkflowInterceptor()
Method Detail

setAlwaysInvokeValidate

public void setAlwaysInvokeValidate(java.lang.String alwaysInvokeValidate)

doIntercept

protected java.lang.String doIntercept(ActionInvocation invocation)
                                throws java.lang.Exception
Description copied from class: MethodFilterInterceptor
Subclasses must override to implement the interceptor logic.

Specified by:
doIntercept in class MethodFilterInterceptor
Parameters:
invocation - the action invocation
Returns:
the result of invocation
Throws:
java.lang.Exception


Copyright © 2006 OpenSymphony. All Rights Reserved.