01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57200 $
42: */
43: public interface MetaDataBuilder {
44:
45: /**
46: * Constructs the Model MBean metadata.
47: *
48: * @return initialized MBean info
49: * @throws NotCompliantMBeanException if there were errors building the
50: * MBean info from the given data source
51: */
52: public MBeanInfo build() throws NotCompliantMBeanException;
53:
54: /**
55: * Sets a property that can be used to control the behaviour of the builder
56: * implementation.
57: *
58: * @param key unique string key for a property
59: * @param value property value
60: */
61: public void setProperty(String key, Object value);
62:
63: /**
64: * Returns an existing property for this builder implementation.
65: *
66: * @param key property key string
67: *
68: * @return property value
69: */
70: public Object getProperty(String key);
71: }
|