EZBManagementIdentifier


1   /**
2    * EasyBeans
3    * Copyright (C) 2006 Bull S.A.S.
4    * Contact: easybeans@objectweb.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   * USA
20   *
21   * --------------------------------------------------------------------------
22   * $Id: EZBManagementIdentifier.java 643 2006-06-13 11:44:43Z sauthieg $
23   * --------------------------------------------------------------------------
24   */
25  
26  package org.objectweb.easybeans.api.jmx;
27  
28  /**
29   * JMX Identifier, used to create a JMX ObjectName from an Object.
30   * @author Guillaume Sauthier
31   * @param <ManagedType> Managed resource Type
32   */
33  public interface EZBManagementIdentifier<ManagedType> {
34  
35      /**
36       * @return Returns the JMX Domain name of the MBean.
37       */
38      String   getDomain();
39  
40      /**
41       * May differ if JSR77 MBean or "normal" MBean.<br/>
42       * A JSR77 MBean has j2eeType=XX, but a "normal" MBean has type=YY.
43       * Will probably be implemented by an abstract class.
44       * @return Returns the type=type_name couple.
45       */
46      String   getTypeProperty();
47  
48      /**
49       * @return Returns the 'type' property name : <code>j2eeType</code>
50       *         for JSR 77 and <code>type</code> for others.
51       */
52      String   getTypeName();
53  
54      /**
55       * This method has to be implemented by each {@link EZBManagementIdentifier}.
56       * @return Returns the type value. (example : <code>J2EEServer</code>)
57       */
58      String   getTypeValue();
59  
60      /**
61       * @param instance Managed instance from which the name will be extracted.
62       * @return Returns the ObjectName 'name' property value.
63       */
64      String   getNamePropertyValue(final ManagedType instance);
65  
66      /**
67       * @param instance Managed instance from which the additionnal
68       *        properties will be extracted.
69       * @return Returns a comma separated(,) list of properties (name=value)
70       */
71      String   getAdditionnalProperties(final ManagedType instance);
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags