org.apache.wiki.ui.admin.beans

Class CoreBean

java.lang.Object

org.apache.wiki.management.SimpleMBean

org.apache.wiki.ui.admin.SimpleAdminBean

org.apache.wiki.ui.admin.beans.CoreBean

All Implemented Interfaces:

DynamicMBean, AdminBean, GenericHTTPHandler

public class CoreBean
extends SimpleAdminBean

An AdminBean which manages the JSPWiki core operations.

Field Summary

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

m_engine

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
CoreBean(WikiEngine engine)

Method Summary

Modifier and Type	Method and Description
String[]	getAttributeNames() This method must return a list of attributes which are exposed by the SimpleMBean.
String	getId() By default, this method returns the class name of the bean.
String[]	getMethodNames() This method must return a list of operations which are to be exposed by the SimpleMBean.
int	getPages() Return the page count in the Wiki.
String	getPagesDescription()
String	getTitle() Return a human-readable title for this AdminBean.
int	getType() Returns a type (UNKNOWN, EDITOR, etc).
String	getVersion()
String	getVersionDescription()

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

doGet, doPost, 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

CoreBean

public CoreBean(WikiEngine engine)
         throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

getPages

public int getPages()

Return the page count in the Wiki.

Returns:

the page content

getPagesDescription

public String getPagesDescription()

getVersion

public String getVersion()

getVersionDescription

public String getVersionDescription()

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

getId

public String getId()

Description copied from class: SimpleAdminBean

By default, this method returns the class name of the bean. This is suitable, if you have a singleton bean.

Specified by:

getId in interface GenericHTTPHandler

Overrides:

getId in class SimpleAdminBean

Returns:

the identifier for the bean

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.