BaseEventListener


1   /*
2    * Copyright (C) 2003  Christian Cryder [christianc@granitepeaks.com]
3    *
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2.1 of the License, or (at your option) any later version.
8    *
9    * This library is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   * Lesser General Public License for more details.
13   *
14   * You should have received a copy of the GNU Lesser General Public
15   * License along with this library; if not, write to the Free Software
16   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17   *
18   * $Id: BaseEventListener.java,v 1.6 2004/02/01 05:16:27 christianc Exp $
19   */
20  package org.enhydra.barracuda.core.event;
21  
22  import java.io.*;
23  import java.util.*;
24  
25  /**
26   * This class defines the methods for Event listeners
27   */
28  public interface BaseEventListener extends EventListener {
29  
30      /**
31       * Handle all events. This represents a default implementation 
32       * that will route the event on to the convenience respective 
33       * convenience methods. Notice that we get servlet response and
34       * request information from the queue state. This means that if
35       * you use a custom event broker, it needs to set this information
36       * in the queue.
37       *
38       * @param context the event context containing event, queue, and, sometimes, http information
39       * @throws EventException
40       */
41      public void handleEvent(EventContext context) throws EventException;
42  
43      /**
44       * Return true if the event was handled in the handleEvent method. 
45       * By default, most implementations will return true for you, so 
46       * the only time you'd need to override is if the handler wanted 
47       * to specifically indicate that it had NOT handled the event 
48       * (ie in logging scenarios).
49       *
50       * @return true if the event was handled in the handleEvent method
51       */
52      public boolean isHandled();
53  
54      /**
55       * Get the ID that identifies this listener. This will typically be the 
56       * class name.
57       *
58       * @return a string that uniquely identifies this listener
59       */
60      public String   getListenerID();
61  
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags