org.jboss.mx.metadata
Interface MetaDataBuilder

All Known Implementing Classes:

AbstractBuilder (src)

public interface MetaDataBuilder

The MetaDataBuilder interface defines the contract between the Model MBean and a metadata builder implementation. The metadata builder implementations can extract the MBean management interface definition from a given data source and construct the corresponding JMX MBeanInfo object instances that define the Model MBean.

This interface also defines accessor methods for setting properties which can be used to configure the builder implementations. See setProperty(java.lang.String, java.lang.Object) and getProperty(java.lang.String) methods for more information.

See Also:

AbstractBuilder (src)

build

public MBeanInfo (src)  build()
                throws NotCompliantMBeanException (src) 

Constructs the Model MBean metadata.

Returns:

initialized MBean info

Throws:

NotCompliantMBeanException (src) - if there were errors building the MBean info from the given data source

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Sets a property that can be used to control the behaviour of the builder implementation.

Parameters:

key - unique string key for a property

value - property value

getProperty

public java.lang.Object getProperty(java.lang.String key)

Returns an existing property for this builder implementation.

Parameters:

key - property key string

Returns:

property value