Package org.jppf.management.doc

Class WikiMBeanInfoWriter

java.lang.Object

org.jppf.management.doc.MBeanInfoVisitorAdapter

org.jppf.management.doc.WikiMBeanInfoWriter

All Implemented Interfaces:

MBeanInfoVisitor

public class WikiMBeanInfoWriter
extends MBeanInfoVisitorAdapter

Visits the JPPF MBean in a remote JVM and generates a reference documentation page in wikimedia format. The intent is to copy/paste the generated wikimedia markup into the JPPF online doc wiki.

Author:

Laurent Cohen

Nested Class Summary

Nested classes/interfaces inherited from interface org.jppf.management.doc.MBeanInfoVisitor

MBeanInfoVisitor.MBeanFeatureFilter, MBeanInfoVisitor.MBeanFilter

Constructor Summary

Constructors

Constructor	Description
WikiMBeanInfoWriter(Writer writer)	Initialize this visitor witht he specified Writer.

Method Summary

Modifier and Type	Method	Description
void	end(DriverConnectionInfo connectionInfo)	End the visit for the specified remote MBean server.
static void	main(String[] args)	Entry point.
void	start(DriverConnectionInfo connectionInfo)	Start the visit for the specified remote MBean server.
void	startAttributes(MBeanAttributeInfo[] attributes)	Start visiting the attributes of the specified mbean.
void	startMBean(ObjectName name, MBeanInfo info)	Start the visit for the specified mbean.
void	startOperations(MBeanOperationInfo[] operations)	Start visiting the operations of the specified mbean.
void	visitAttribute(MBeanAttributeInfo attribute)	Visit the specified mbean attribute.
void	visitOperation(MBeanOperationInfo operation)	Visit the specified mbean operation.

Methods inherited from class org.jppf.management.doc.MBeanInfoVisitorAdapter

endAttributes, endMBean, endOperations

Methods inherited from class java.lang.Object

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

Constructor Details

WikiMBeanInfoWriter

public WikiMBeanInfoWriter(Writer writer)

Initialize this visitor witht he specified Writer.

Parameters:

writer - the writer in which to print the generated wiki code.

Method Details

start

public void start(DriverConnectionInfo connectionInfo)
           throws Exception

Description copied from interface: MBeanInfoVisitor

Start the visit for the specified remote MBean server.

Specified by:

start in interface MBeanInfoVisitor

Overrides:

start in class MBeanInfoVisitorAdapter

Parameters:

connectionInfo - represent the information to connect the remote JMX server.

Throws:

Exception - if any error occurs.

end

public void end(DriverConnectionInfo connectionInfo)
         throws Exception

Description copied from interface: MBeanInfoVisitor

End the visit for the specified remote MBean server.

Specified by:

end in interface MBeanInfoVisitor

Overrides:

end in class MBeanInfoVisitorAdapter

Parameters:

connectionInfo - information of the remote JVM to connect to.

Throws:

Exception - if any error occurs.

startMBean

public void startMBean(ObjectName name,
 MBeanInfo info)
                throws Exception

Description copied from interface: MBeanInfoVisitor

Start the visit for the specified mbean.

Specified by:

startMBean in interface MBeanInfoVisitor

Overrides:

startMBean in class MBeanInfoVisitorAdapter

Parameters:

name - the object name of the mbea,.

info - full information on the mbena.

Throws:

Exception - if any error occurs.

startAttributes

public void startAttributes(MBeanAttributeInfo[] attributes)
                     throws Exception

Description copied from interface: MBeanInfoVisitor

Start visiting the attributes of the specified mbean.

Specified by:

startAttributes in interface MBeanInfoVisitor

Overrides:

startAttributes in class MBeanInfoVisitorAdapter

Parameters:

attributes - the attributes to visit.

Throws:

Exception - if any error occurs.

visitAttribute

public void visitAttribute(MBeanAttributeInfo attribute)
                    throws Exception

Description copied from interface: MBeanInfoVisitor

Visit the specified mbean attribute.

Specified by:

visitAttribute in interface MBeanInfoVisitor

Overrides:

visitAttribute in class MBeanInfoVisitorAdapter

Parameters:

attribute - info on the mbean attribute

Throws:

Exception - if any error occurs.

startOperations

public void startOperations(MBeanOperationInfo[] operations)
                     throws Exception

Description copied from interface: MBeanInfoVisitor

Start visiting the operations of the specified mbean.

Specified by:

startOperations in interface MBeanInfoVisitor

Overrides:

startOperations in class MBeanInfoVisitorAdapter

Parameters:

operations - the mbean operations to visit.

Throws:

Exception - if any error occurs.

visitOperation

public void visitOperation(MBeanOperationInfo operation)
                    throws Exception

Description copied from interface: MBeanInfoVisitor

Visit the specified mbean operation.

Specified by:

visitOperation in interface MBeanInfoVisitor

Overrides:

visitOperation in class MBeanInfoVisitorAdapter

Parameters:

operation - info on the mbean operation.

Throws:

Exception - if any error occurs.

main

public static void main(String[] args)

Entry point.

Parameters:

args - not used.