org.apache.wiki.ui.admin.beans

Class PluginBean

java.lang.Object

org.apache.wiki.management.SimpleMBean

org.apache.wiki.ui.admin.SimpleAdminBean

org.apache.wiki.ui.admin.beans.PluginBean

All Implemented Interfaces:

DynamicMBean, AdminBean, GenericHTTPHandler

public class PluginBean
extends SimpleAdminBean

Field Summary

Fields inherited from class org.apache.wiki.management.SimpleMBean

m_beanInfo

Fields inherited from interface org.apache.wiki.ui.admin.AdminBean

CORE, EDITOR, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
PluginBean(WikiEngine engine)

Method Summary

Methods

Modifier and Type	Method and Description
String	doGet(WikiContext context) By default, this method creates a blob of HTML, listing all the attributes which can be read or written to.
String[]	getAttributeNames() This method must return a list of attributes which are exposed by the SimpleMBean.
String[]	getMethodNames() This method must return a list of operations which are to be exposed by the SimpleMBean.
String	getTitle() Return a human-readable title for this AdminBean.
int	getType() Returns a type (UNKNOWN, EDITOR, etc).

Methods inherited from class org.apache.wiki.ui.admin.SimpleAdminBean

doPost, getId, initialize

Methods inherited from class org.apache.wiki.management.SimpleMBean

getAttribute, getAttributes, getDescription, getMBeanInfo, invoke, setAttribute, setAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginBean

public PluginBean(WikiEngine engine)
           throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

getAttributeNames

public String[] getAttributeNames()

Description copied from class: SimpleMBean

This method must return a list of attributes which are exposed by the SimpleMBean. If there's a getXXX() method available, it'll be exposed as a getter, and if there's a setXXX() method available, it'll be exposed as a setter. For example:

     public void setFoo( String foo ) ...
     public String getFoo() ...

     public String[] getAttributeNames()
     {
         String[] attrs = { "foo" };

         return attrs;
     }
  

Also, methods starting with "is" are also recognized as getters (e.g. public boolean isFoo().)

Specified by:

getAttributeNames in class SimpleMBean

Returns:

An array of attribute names that can be get and optionally set.

getMethodNames

public String[] getMethodNames()

Description copied from class: SimpleMBean

This method must return a list of operations which are to be exposed by the SimpleMBean. Note that using overloaded method names is not supported - only one will be exposed as a JMX method at random.

Specified by:

getMethodNames in class SimpleMBean

Returns:

An array of method names that should be exposed as JMX operations.

getTitle

public String getTitle()

Description copied from interface: AdminBean

Return a human-readable title for this AdminBean.

Returns:

the bean's title

getType

public int getType()

Description copied from interface: AdminBean

Returns a type (UNKNOWN, EDITOR, etc).

Returns:

the bean's type

doGet

public String doGet(WikiContext context)

Description copied from class: SimpleAdminBean

By default, this method creates a blob of HTML, listing all the attributes which can be read or written to. If the attribute is read-only, a readonly input widget is created. The value is determined by the toString() method of the attribute.

Specified by:

doGet in interface GenericHTTPHandler

Overrides:

doGet in class SimpleAdminBean

Returns:

the HTML for the bean