MetaDataBuilder


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.metadata;
23  
24  import javax.management.MBeanInfo  ;
25  import javax.management.NotCompliantMBeanException  ;
26  
27  /**
28   * The <tt>MetaDataBuilder</tt> interface defines the contract between the
29   * Model MBean and a metadata builder implementation. The metadata builder
30   * implementations can extract the MBean management interface definition from
31   * a given data source and construct the corresponding JMX MBeanInfo object
32   * instances that define the Model MBean. <p>
33   *
34   * This interface also defines accessor methods for setting properties which
35   * can be used to configure the builder implementations. See 
36   * {@link #setProperty} and {@link #getProperty} methods for more information.
37   *
38   * @see     org.jboss.mx.metadata.AbstractBuilder
39   *
40   * @author  <a HREF="mailto:juha@jboss.org">Juha Lindfors</a>.
41   * @version $Revision: 37459 $
42   */
43  public interface MetaDataBuilder
44  {
45  
46     /**
47      * Constructs the Model MBean metadata.
48      *
49      * @return initialized MBean info
50      * @throws NotCompliantMBeanException if there were errors building the 
51      *         MBean info from the given data source
52      */
53     public MBeanInfo   build() throws NotCompliantMBeanException  ;
54  
55     /**
56      * Sets a property that can be used to control the behaviour of the builder
57      * implementation.
58      *
59      * @param   key      unique string key for a property
60      * @param   value    property value
61      */
62     public void setProperty(String   key, Object   value);
63     
64     /**
65      * Returns an existing property for this builder implementation.
66      *
67      * @param   key      property key string
68      *
69      * @return  property value
70      */
71     public Object   getProperty(String   key);
72  }
73  
74
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags