EventHandler


1   /*
2    * $Id: EventHandler.java 5462 2005-08-05 18:35:48Z jonesde $
3    *
4    * Copyright (c) 2001-2003 The Open For Business Project - www.ofbiz.org
5    *
6    * Permission is hereby granted, free of charge, to any person obtaining a
7    * copy of this software and associated documentation files (the "Software"),
8    * to deal in the Software without restriction, including without limitation
9    * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10   * and/or sell copies of the Software, and to permit persons to whom the
11   * Software is furnished to do so, subject to the following conditions:
12   *
13   * The above copyright notice and this permission notice shall be included
14   * in all copies or substantial portions of the Software.
15   *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19   * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20   * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21   * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23   *
24   */
25  package org.ofbiz.webapp.event;
26  
27  import javax.servlet.http.HttpServletRequest  ;
28  import javax.servlet.http.HttpServletResponse  ;
29  import javax.servlet.ServletContext  ;
30  
31  /**
32   * EventHandler - Event Handler Interface
33   *
34   * @author     <a HREF="mailto:jaz@ofbiz.org">Andy Zeneski</a>
35   * @author     <a HREF="mailto:jonesde@ofbiz.org">David E. Jones</a>
36   * @version    $Rev: 5462 $
37   * @since      2.0
38   */
39  
40  public interface EventHandler {
41  
42      /**
43       * Initializes the handler. Since handlers use the singleton pattern this method should only be called
44       * the first time the handler is used.
45       * 
46       * @param context ServletContext This may be needed by the handler in order to lookup properties or XML
47       * definition files for rendering pages or handler options.
48       * @throws EventHandlerException
49       */
50      public void init(ServletContext   context) throws EventHandlerException;
51  
52      /**
53       * Invoke the web event
54       * 
55       *@param eventPath The path or location of this event
56       *@param eventMethod The method to invoke
57       *@param request The servlet request object
58       *@param response The servlet response object
59       *@return String Result code
60       *@throws EventHandlerException
61       */
62      public String   invoke(String   eventPath, String   eventMethod, HttpServletRequest   request, HttpServletResponse   response) throws EventHandlerException;
63  }
64  
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags