org.apache.felix.ipojo.handlers.jmx
Class JmxConfigFieldMap

java.lang.Object
  extended by org.apache.felix.ipojo.handlers.jmx.JmxConfigFieldMap

public class JmxConfigFieldMap
extends Object

JmxConfigFieldMap : use to store the informations needed to build the Dynamic MBean.

Author:
Felix Project Team

Constructor Summary
JmxConfigFieldMap()
          Constructor.
 
Method Summary
 void addMethodFromName(String name, MethodField methodField)
          Adds a new method descriptor from its name.
 void addMethodFromName(String name, MethodField[] methodsField)
          Adds new methods descriptors from one name.
 void addNotificationFromName(String name, NotificationField notificationField)
          Adds a notification.
 void addPropertyFromName(String name, PropertyField propertyField)
          Adds a new attribute exposed in the Mbean.
 String getDecription()
          Gets the description of the MBean.
 MethodField[] getMethodFromName(String name)
          Returns the method(s) with the given name.
 MethodField getMethodFromName(String operationName, String[] signature)
          Gets the method with the good signature.
  getMethods()
          Returns all methods store.
 NotificationField getNotificationFromName(String name)
          Returns the notification with the given name.
  getNotifications()
          Gets all notifications defined.
  getProperties()
          Gets all of the properties exposed.
 PropertyField getPropertyFromField(String field)
          Gets the property by the field.
 PropertyField getPropertyFromName(String name)
          Gets the property by the name.
 void overrideMethodFromName(String name, MethodField methodField)
          Adds a method from name and erases the older if exists.
 void overrideMethodFromName(String name, MethodField[] methodsField)
          Add methods from name and erases the olders if exists.
 void setDescription(String description)
          Sets the description of the MBean.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmxConfigFieldMap

public JmxConfigFieldMap()
Constructor.

Method Detail

getDecription

public String getDecription()
Gets the description of the MBean.

Returns:
the description of the MBean

setDescription

public void setDescription(String description)
Sets the description of the MBean.

Parameters:
description - a String which describes the Mbean

addPropertyFromName

public void addPropertyFromName(String name,
                                PropertyField propertyField)
Adds a new attribute exposed in the Mbean.

Parameters:
name - the name of the new property
propertyField - the field which describes the property

getProperties

public  getProperties()
Gets all of the properties exposed.

Returns:
the collection of all properties

getPropertyFromName

public PropertyField getPropertyFromName(String name)
Gets the property by the name.

Parameters:
name - the name of the required property
Returns:
the field required or null if is not found

getPropertyFromField

public PropertyField getPropertyFromField(String field)
Gets the property by the field.

Parameters:
field - the required field
Returns:
the property by the field

addMethodFromName

public void addMethodFromName(String name,
                              MethodField methodField)
Adds a new method descriptor from its name.

Parameters:
name - the name of the method
methodField - the description of the method

addMethodFromName

public void addMethodFromName(String name,
                              MethodField[] methodsField)
Adds new methods descriptors from one name. (the method must have the same name but different signature).

Parameters:
name - the name of the method
methodsField - the description of the methods

overrideMethodFromName

public void overrideMethodFromName(String name,
                                   MethodField methodField)
Adds a method from name and erases the older if exists.

Parameters:
name - the name of the method
methodField - the method to be added

overrideMethodFromName

public void overrideMethodFromName(String name,
                                   MethodField[] methodsField)
Add methods from name and erases the olders if exists.

Parameters:
name - the name of the method
methodsField - the array of methods to be added

getMethodFromName

public MethodField[] getMethodFromName(String name)
Returns the method(s) with the given name.

Parameters:
name - the name of the methods
Returns:
the list of methods with the given name

getMethodFromName

public MethodField getMethodFromName(String operationName,
                                     String[] signature)
Gets the method with the good signature.

Parameters:
operationName - the name of the method requiered
signature - the required signature
Returns:
the method which the same signature or null if not found

getMethods

public  getMethods()
Returns all methods store.

Returns:
the collection of methodField[]

addNotificationFromName

public void addNotificationFromName(String name,
                                    NotificationField notificationField)
Adds a notification.

Parameters:
name - the name of the notification
notificationField - the field involved with the notification.

getNotificationFromName

public NotificationField getNotificationFromName(String name)
Returns the notification with the given name.

Parameters:
name - the name of the notification to return
Returns:
the notification if it exists, null otherwise

getNotifications

public  getNotifications()
Gets all notifications defined.

Returns:
the collection of NotificationField


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.