EventProvider


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.management.j2ee;
23  
24  /**
25   * Indicates the emitting of Events and also
26   * indicates what types of events it emits.
27   * <br><br>
28   * <b>Attention</b>: This interface is not indented to be used by the client
29   * but it is morely a desription of what the client will get when he/she
30   * receives attributes from the JSR-77 server or what method can be
31   * invoked.
32   * <br><br>
33   * All attributes (getXXX) can be received by
34   * <br>
35   * {@link javax.management.j2ee.Management#getAttribute Management.getAttribute()}
36   * <br>
37   * or in bulk by:
38   * <br>
39   * {@link javax.management.j2ee.Management#getAttributes Management.getAttributes()}
40   * <br>
41   * Methods (all except getXXX()) can be invoked by:
42   * <br>
43   * {@link javax.management.j2ee.Management#invoke Management.invoke()}
44   * <br>
45   *
46   * @author <a HREF="mailto:marc@jboss.org">Marc Fleury</a>
47   * @author Andreas Schaefer
48   * @version $Revision: 40550 $
49   */
50  public interface EventProvider
51  {
52     /**
53      * @return The actual list of Types of Events this Managed Object emits.
54      *         The list is never null nor empty
55      */
56     String  [] getEventTypes();
57  
58     /**
59      * Returns the given Type of Events it emits according to its index in the list
60      *
61      * @param index Index of the requested Event Type
62      * @return Event Type if given Index is within the boundaries otherwise null
63      */
64     String   getEventType(int index);
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags