View Javadoc

1   /*
2    * $Id: AfterPerformInterceptor.java,v 1.3 2004/05/23 10:26:57 eelco12 Exp $
3    * $Revision: 1.3 $
4    * $Date: 2004/05/23 10:26:57 $
5    *
6    * ====================================================================
7    * Copyright (c) 2003, Open Edge B.V.
8    * All rights reserved.
9    * Redistribution and use in source and binary forms, with or without 
10   * modification, are permitted provided that the following conditions are met:
11   * Redistributions of source code must retain the above copyright notice, 
12   * this list of conditions and the following disclaimer. Redistributions 
13   * in binary form must reproduce the above copyright notice, this list of 
14   * conditions and the following disclaimer in the documentation and/or other 
15   * materials provided with the distribution. Neither the name of OpenEdge B.V. 
16   * nor the names of its contributors may be used to endorse or promote products 
17   * derived from this software without specific prior written permission.
18   * 
19   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
20   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
21   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
22   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
23   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
24   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
25   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
26   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
27   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
29   * THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package nl.openedge.baritus.interceptors;
32  
33  import javax.servlet.ServletException;
34  
35  import nl.openedge.baritus.FormBeanContext;
36  
37  import org.infohazard.maverick.flow.ControllerContext;
38  
39  /***
40   * Registered instances will have their command method executed after the
41   * normal action execution took place. That means that makeFormBean was called,
42   * the form was populated and - if that population was succesfull - the 
43   * command method was called prior to this execution. Hence, this interceptor
44   * will allways be executed, regardless population/ validation and regardless
45   * whether the perform method actually was executed.
46   * 
47   * @author Eelco Hillenius
48   */
49  public interface AfterPerformInterceptor extends Interceptor
50  {
51  
52  	/***
53  	 * Executed after the normal action execution took place. That means that 
54  	 * makeFormBean was called, the form was populated and - if that population 
55  	 * was succesfull - the command method was called prior to this execution.
56  	 *  Hence, this interceptor will allways be executed, regardless 
57  	 * population/ validation and regardless whether the perform method 
58  	 * actually was executed.
59  	 * 
60  	 * NOTE. You cannot be sure that the form was populated successfully. Therefore
61  	 * it's dangerous and generally bad practice to rely on form properties that are 
62  	 * populated from the http request. A good usage example: a lot of views need
63  	 * data to fill their dropdown lists etc. In this method, you could load that data and
64  	 * save it in the form (or as a request attribute if that's your style). As this method
65  	 * is allways executed, you have a guaranteed data delivery to your view, regardless
66  	 * the normal execution outcome of the control. 
67  	 * 
68  	 * @param cctx maverick context
69  	 * @param formBeanContext the context with the (possibly succesfull) populated formBean
70       * @throws ServletException
71       * @throws RedirectingException when an interceptor wants to redirect
72       * @throws DirectReturnFlowException when an interceptor wants to return directly
73  	 */
74  	public void doAfterPerform(
75  		ControllerContext cctx,
76  		FormBeanContext formBeanContext) 
77          throws ServletException, 
78          DispatchNowFlowException, 
79          ReturnNowFlowException;
80  
81  }