ListenerRegistration


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.mx.notification;
23  
24  import javax.management.NotificationFilter  ;
25  import javax.management.NotificationListener  ;
26  
27  /**
28   * A notification listener registration.<p>
29   * 
30   * @see org.jboss.mx.notification.ListenerRegistry
31   * @see org.jboss.mx.notification.ListenerRegistrationFactory
32   * 
33   * @author  <a HREF="mailto:Adrian.Brock@HappeningTimes.com">Adrian Brock</a>.
34   * @version $Revision: 37459 $
35   */
36  public interface ListenerRegistration
37  {
38     /**
39      * Retrieve the listener for this registration.
40      *
41      * @return the listener
42      */
43     NotificationListener   getListener();
44  
45     /**
46      * Retrieve the filter for this registration.
47      *
48      * @return the listener
49      */
50     NotificationFilter   getFilter();
51  
52     /**
53      * Retrieve the handback object for this registration.
54      *
55      * @return the handback object
56      */
57     Object   getHandback();
58  
59     /**
60      * Retrieve the listener that was registered.
61      *
62      * This might be different from listener to use,
63      * e.g. the registration factory may generate a proxy.
64      *
65      * @return the listener
66      */
67     NotificationListener   getRegisteredListener();
68  
69     /**
70      * Retrieve the filter that was registered.
71      *
72      * This might be different from filter to use,
73      * e.g. the registration factory may generate a proxy.
74      *
75      * @return the filter
76      */
77     NotificationFilter   getRegisteredFilter();
78  
79     /**
80      * Used to tell the registration it is no longer required.
81      */
82     void removed();
83  }
84
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags