Package org.apache.wiki.ui.admin

Class SimpleAdminBean

java.lang.Object

org.apache.wiki.management.SimpleMBean

org.apache.wiki.ui.admin.SimpleAdminBean

All Implemented Interfaces:

DynamicMBean, AdminBean, GenericHTTPHandler

Direct Known Subclasses:

CoreBean, ModuleBean, SearchManagerBean, UserBean

public abstract class SimpleAdminBean
extends SimpleMBean
implements AdminBean

Provides an easy-to-use interface for JSPWiki AdminBeans, which also are JMX MBeans. This class provides a default interface for the doGet() and doPost() interfaces by using the introspection capabilities of the SimpleMBean.

Since:

2.5.52

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.wiki.api.core.Engine	m_engine	Provides access to a Engine instance to which this AdminBean belongs to.

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

Modifier	Constructor	Description
protected	SimpleAdminBean()	Constructor reserved for subclasses only.

Method Summary

Modifier and Type	Method	Description
String	doGet(org.apache.wiki.api.core.Context context)	By default, this method creates a blob of HTML, listing all the attributes which can be read or written to.
String	doPost(org.apache.wiki.api.core.Context context)	Not implemented yet.
String	getId()	By default, this method returns the class name of the bean.
void	initialize(org.apache.wiki.api.core.Engine engine)	Initialize the AdminBean by setting up a Engine instance internally.

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

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

Methods inherited from class java.lang.Object

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

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

getTitle, getType

Field Details

m_engine

protected org.apache.wiki.api.core.Engine m_engine

Provides access to a Engine instance to which this AdminBean belongs to.

Constructor Details

SimpleAdminBean

protected SimpleAdminBean()
                   throws NotCompliantMBeanException

Constructor reserved for subclasses only.

Throws:

NotCompliantMBeanException

Method Details

initialize

public void initialize(org.apache.wiki.api.core.Engine engine)

Initialize the AdminBean by setting up a Engine instance internally.

Specified by:

initialize in interface AdminBean

doGet

public String doGet(org.apache.wiki.api.core.Context context)

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

Parameters:

context - associated WikiContext

Returns:

the HTML for the bean

doPost

public String doPost(org.apache.wiki.api.core.Context context)

Not implemented yet.

Specified by:

doPost in interface GenericHTTPHandler

Parameters:

context - associated WikiContext

Returns:

the response string resulting from the POST

getId

public String getId()

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

Returns:

the identifier for the bean