Added: trunk/jmx/docs/reference/en/modules/references.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/jmx/docs/reference/en/modules/references.xml =
(rev 0)
+++ trunk/jmx/docs/reference/en/modules/references.xml 2010-01-20 14:51:57 =
UTC (rev 19825)
@@ -0,0 +1,158 @@
+
+
+
+ References
+ =
+
+
+ =
+ MBean Explorer
+ The MBean Explorer displays the MBean f=
eatures (both attributes and operations) in its
+ hierarchy. Double-clicking on a feature will open a =
MBean Editor, display the page
+ corresponding to the feature type and select the feature.
+ =
+
+ MBean Explorer Features
+
+
+
+
+
+
+ =
+ Since it's possible to have many MBean Editors opened a=
t the same time, the MBean Explorer
+ has the Link With Editor button =
+ =
+ =
+
+
+
+
+ =
+ to synchronize selections between the active MBean E=
ditor and
+ the MBean Explorer (and vice versa).
+ =
+ The MBean Explorer has also a filter te=
xt that can be used to filter among all the MBeans
+ the few ones, which interest you.
+ =
+ For example, if you are only interested by MBeans related to=
memory, typing memo will show
+ any node (domain, mbean, attribute, or operation) that matches=
that text, as well as =
+ that node's parents and children. So if an MBean matches,=
all attributes and operations from =
+ that bean will show. If, however, an attribute or operation n=
ame (a leaf node) matches, =
+ only that node and its parents in the tree will show.
+ =
+
+ Query Filter
+
+
+
+
+
+
+ =
+ =
+ The
+ Collapse All button =
+ =
+ =
+
+
+
+
+ =
+ on the MBean Explorer toolbar is used to =
collapse all the MBeans and
+ display only the domains. It is also possible to double click =
on a node to expand/collapse it.
+ =
+
+
+
+ =
+ MBean Editor
+ =
+
+ MBean Editor Pages
+
+
+
+
+
+
+ =
+ The MBean Editor is composed of several=
pages:
+ =
+
+
+ the
+ Attributes page
+
+
+ the
+ Operations page
+
+
+ the
+ Notifications page
+
+
+ the
+ Info page
+
+
+ =
+ The
+ Attributes
+ and
+ Operations
+ pages display a list for either the MBean attributes o=
r operations as well as
+ details for the selection.
+ =
+ It is possible to toggle the layout between the list and th=
e details either vertically
+ (by default) or horizontally with the help of the special icon=
s =
+ =
+ =
+
+
+
+
+ =
+ in the right top corner of the editor.
+ =
+
+ MBean Editor Horizontal Layout
+
+
+
+
+
+
+
+
+ Notifications Page
+ One more page in the MBean Editor i=
s the
+ Notifications page, which =
gives the possibility to
+ subscribe (resp. unsubscribe) to a MBean to receive its no=
tifications by checking (resp.
+ unchecking) the
+ Subscribe button in th=
e right top corner.
+ The list of notifications is refreshed every time a new =
notification is
+ received:
+ =
+
+ MBean Editor Notifications Page
+
+
+
+
+
+
+ =
+
+ Note
+ It is only possible to subscribe to MBean, which emi=
ts notifications (they must be
+ NotificationBroadcaster).
+
+ =
+
+ =
+
+ =
+
Added: trunk/jmx/docs/reference/en/modules/summary.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/jmx/docs/reference/en/modules/summary.xml =
(rev 0)
+++ trunk/jmx/docs/reference/en/modules/summary.xml 2010-01-20 14:51:57 UTC=
(rev 19825)
@@ -0,0 +1,32 @@
+
+
+
+ Summary
+ In conclusion, with this document you could easily start with JX=
M Tools.
+ The chapters above walked you through the steps on how to do Tomca=
t,Eclipse Equinox or JBoss Instances managing and how to create new JMX con=
nections.
+ The document also includes the reference of JMX Tools features.
+ =
+ If you have questions or suggestions concerned both the documentat=
ion and tools behavior,
+ you are welcome to JBoss Tools Users forum.
+ Please, use Jira to report bugs and requests on documentation.
+ =
+
+ Other relevant resources on the topic
+ All JBoss Developer Studio/JBoss Tools release documentation=
you can find at
+ http://docs.jboss.o=
rg/tools in the corresponding release directory.
+ =
+ The latest documentation builds are available at http://download.jbos=
s.org/jbosstools/nightly-docs.
+ You can find a set of benefits and other extra information o=
n:
+
+
+
+ JBoss Wiki
+
+
+ For more information about JMX technology plea=
se visit
+
+ JMX Technology Home Page
+
+
+
+
\ No newline at end of file
Added: trunk/jmx/docs/reference/en/modules/tasks.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/jmx/docs/reference/en/modules/tasks.xml (=
rev 0)
+++ trunk/jmx/docs/reference/en/modules/tasks.xml 2010-01-20 14:51:57 UTC (=
rev 19825)
@@ -0,0 +1,259 @@
+
+
+
+ JMX Tools Tasks
+ This chapter will give you answers on most popular questions ask=
ed by JMX
+ plugin users.
+
+ Quick Start
+ =
+ To start using the JMX Tools, it's=
necessary to open
+ MBean Explorer. Go to Window > Show View > Other and then select
+ MBean Explorer and click OK.
+ =
+ The MBean Explorer lists all of the dom=
ains, mbeans, attributes, and operations inside a
+ connection. When you double-click on a MBean in the =
MBean Explorer, it opens a multi-page
+ editor to manage the MBean. The MBean Editor is composed of these pages:
+ =
+
+
+ Attributes page, to get/set the attributes of the MBean
+
+
+ Operations page, to invoke operations on the MBean
+
+
+ Notifications page, to receive notifications from the MBean
+
+
+ Info page,=
which displays general information about the MBean
+
+
+ =
+
+
+ Tomcat Managing
+ =
+ It's possible to manage Tomcat using JMX Tool=
s.
+ =
+ Currently, JMX Tooling is able to connect to Tomcat without =
authentication or with
+ password-based authentication.
+ Using SSL for authentication is not supported: you need to m=
ake sure that the System
+ property
+ com.sun.management.jmxremote.ssl
+ is set to false.
+ More information to manage Tomcat can be found in Tomcat man=
agement
+ documentation.
+ Instructions to manage remotely Tomcat are available in Tomc=
at's monitoring
+ documentation.
+ =
+
+ =
+
+ Eclipse Equinox Managing
+ =
+ You can manage Equinox through the Equinox monitoring framew=
ork.
+ Once you have installed the Equinox monitoring framework and=
restarted Eclipse:
+ =
+
+
+ Go to
+ Window > Open Perspective > Other
+ and select the JMX perspective
+
+ =
+
+ Select
+ JMX Server > Open Connection
+ and click on
+ OK
+
+
+ =
+
+ Switch to the MBean Explorer by=
going to
+ Window > Show View > Other
+ and selecting the MBean Explorer
+
+ =
+
+ Click on the
+ New Connection icon =
+ =
+ =
+
+
+
+
+ =
+ in the MBean Explorer menu
+ bar
+
+ =
+
+ Select the
+ Advanced tab and set t=
he JMX URL to
+ service:jmx:rmi:///jndi/rmi://:8118/jmxs=
erver
+
+
+
+ =
+ You now have access to the MBeans exposed by Equinox.
+
+ =
+ =
+
+ Managing JBoss Instances
+ =
+ Managing JBoss instances is not supported with the JMX Tools
+ alone. You must also download and install the AS Too=
ls portion of
+ the JBoss Tools distribution. Even after =
installing the proper
+ tooling, you cannot create a JBoss JMX connection yourself or =
through the Connection
+ Wizard. The first step is to create a JBoss Server. The full i=
nstructions for this can
+ be found in the AS Tools section, however, the short summary i=
s:
+
+
+ Open the JBoss Servers View or =
the Servers
+ View
+
+ =
+
+ Right-click in the view and select
+ New > Server
+
+
+ =
+
+ In the
+ JBoss Community
+ section, select a server version
+
+ =
+
+ If a runtime has not yet been created, you'll b=
e prompted for the
+ server's home directory, JDK, and configuration
+
+ =
+
+ Finish the wizard and note that you have a new entry=
in both the
+ JBoss Server View and the MBean
+ Explorer
+
+ =
+
+ Start the server by right-clicking it and selecting =
+ Start
+
+
+ Note that once the server is started, the JMX connec=
tion can be
+ expanded
+
+
+ =
+ Now you can explore MBeans exposed by a JBoss instance.
+
+ =
+ Extension Task
+ This section will outline how to contribute your own Server =
type with some default
+ behavior.
+ =
+
+ Why we should do that?
+ =
+ You might be asking yourself why you'd need to exte=
nd this framework if JMX is
+ a standard. Perhaps you want a connection to be automatica=
lly created after some specific
+ action, or perhaps you want your connection wizard to do m=
ore than simply set a host and
+ port. JBoss, for example, requires setting some credential=
s on the client machine, but
+ using JBoss classes to do it. This requires that the conne=
ction have access to JBoss
+ jars.
+
+ =
+
+ Core Extensions
+ =
+ To create your own JMX Connection type, you must use the
+ org.jboss.tools.jmx.core.MBeanServerConnectionProvider ext=
ension point. This point takes
+ one child, a connectionProvider with a class that implemen=
ts
+ org.jboss.tools.jmx.core.IConnectionProvider.
+ =
+ An IConnectionProvider is responsible for creation and d=
eletion of IConnectionWrapper
+ objects. It must also keep a list of listeners that it is =
expected to inform when a
+ connection is added or removed from its list.
+ =
+ Each IConnectionWrapper is expected to handle running ar=
bitrary JMX runnables or getting
+ a "Root" object representing all JMX nodes. There are some=
utility methods the
+ IConnectionWrapper can make use of.
+
+ =
+
+ UI Extensions
+ There are two extension points currently approved for us=
e in the UI
+
+
+ org.jboss.tools.jmx.ui.providerUI - provide an i=
con, id, displayable name, and
+ wizardPage class for creation of new connections
+
+
+ org.jboss.tools.jmx.ui.attribute.controls - allo=
ws you to map class types to some
+ Control to present them in the MBean Editor
+ We hope, this guide helped you to get started wi=
th the JBoss JMX Tools. Besides, for additional information you are welcome=
on JBoss forum.
+
+
+
+ =
+
+
+ =
+ Connections Creation Task
+ =
+ The MBean Explorer supports several dif=
ferent types of connections. =
+ The tooling itself comes only with a default connection type, =
however other
+ adopters can provide additional connection types that may requ=
ire additional
+ or non-spec behavior. Connections can be in either the connect=
ed state or
+ the disconnected state. Some connection types (such as the def=
ault connection type)
+ allow you to control the current state. Other connection types=
may not.
+ =
+ Similarly, some connection types may be able to be created, =
and others may not. =
+ The default connection type, for example, can be created and d=
eleted by you
+ at will. The AS Tools connection type, which represents a JBos=
s server, does not
+ allow you this level of control. A JBoss JMX connection is cre=
ated when a JBoss server is created
+ in the server's view, and deleted when said server is deleted.=
The JMX connection for =
+ this server is in the connected state only when the server is =
started.
+ =
+ =
+ The Default Connection
+ =
+ There are two ways to connect to an application with re=
mote management enabled:
+ =
+ The first step is the same for both - to connect to a M=
Bean Server, click on the
+
+ New Connection icon =
+ =
+ =
+
+
+
+
+ =
+ in the MBean Explorer menu bar.
+ =
+ Then to follow the simple one you just need to specify h=
ost, port (and optionally user
+ name and password) and click
+ OK.
+ =
+ The default JMX URL is
+ service:jmx:rmi:///jndi/rmi://localhost:3000/jmx=
rmi.
+ =
+ In case you need to connect to an application which has =
not used the "standard" JMX URL
+ (e.g. Eclipse Equinox), you need chose more advance way, w=
here it's necessary to specify
+ explicitly a JMX URL in the Advanced tab of the JMX Connec=
tion window.
+ =
+
+ Note
+ Only JMX URL based on RMI are supported.
+
+
+
+
+
--===============0183471312990825582==--