From jbosstools-commits at lists.jboss.org Thu May 27 05:31:25 2010 Content-Type: multipart/mixed; boundary="===============2963928807082918555==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r22365 - trunk/jmx/docs/reference/en-US. Date: Thu, 27 May 2010 05:31:25 -0400 Message-ID: <201005270931.o4R9VPGw022729@svn01.web.mwc.hst.phx2.redhat.com> --===============2963928807082918555== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2010-05-27 05:31:25 -0400 (Thu, 27 May 2010) New Revision: 22365 Modified: trunk/jmx/docs/reference/en-US/master_output.xml Log:

https://jira.jboss.org/browse/TOOLSDOC-81 -Generated master_output.xml f= ile.

Modified: trunk/jmx/docs/reference/en-US/master_output.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-US/master_output.xml 2010-05-27 09:15:38 UT= C (rev 22364) +++ trunk/jmx/docs/reference/en-US/master_output.xml 2010-05-27 09:31:25 UT= C (rev 22365) @@ -2,15 +2,15 @@ - - - - - - - = - = +[ + + + + + + + = + = @@ -48,7 +48,7 @@ JBoss by Red Hat - Version: 1.1.0.GA + Version: 1.1.1.GA @@ -60,19 +60,47 @@ = = = - + = Introduction JBoss Tools' JMX project is= a fork of eclipse-jmx= , a project by Jeff Mesnil. It was forked with permission. + = +
+ <diffmk:wrapper diffmk:change=3D"added"= >What is JMX?</diffmk:wrapper> + +The Java Management Extensions (JMX) technology is a standard part of the = Java Platform, Standard Edition (Java SE platform). The JMX technology was = added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 r= elease. + + +The JMX technology provides a simple, standard way of managing resources s= uch as applications, devices, and services. Because the JMX technology is d= ynamic, you can use it to monitor and manage resources as they are created,= installed and implemented. You can also use the JMX technology to monitor = and manage the Java Virtual Machine (Java VM). + + +The JMX specification defines the architecture, design patterns, APIs, and= services in the Java programming language for management and monitoring of= applications and networks. + + +Using the JMX technology, a given resource is instrumented by one or more = Java objects known as Managed Beans, or MBeans. These MBeans are registered= in a core-managed object server, known as an MBean server. The MBean serve= r acts as a management agent and can run on most devices that have been ena= bled for the Java programming language. = + + = + +The specifications define JMX agents that you use to manage any resources = that have been correctly configured for management. A JMX agent consists of= an MBean server, in which MBeans are registered, and a set of services for= handling the MBeans. In this way, JMX agents directly control resources an= d make them available to remote management applications. + + +The way in which resources are instrumented is completely independent from= the management infrastructure. Resources can therefore be rendered managea= ble regardless of how their management applications are implemented. + + +The JMX technology defines standard connectors (known as JMX connectors) t= hat enable you to access JMX agents from remote management applications. JM= X connectors using different protocols provide the same management interfac= e. Consequently, a management application can manage resources transparentl= y, regardless of the communication protocol used. JMX agents can also be us= ed by systems or applications that are not compliant with the JMX specifica= tion, as long as those systems or applications support JMX agents. = + +Read m= ore about JMX. +
+ =
What is JMX Tools? - JMX Tools allows to setup = multiple JMX connections and provides view - for exploring the JMX tree and execute operations directly from Eclips= e. + JBoss JMX Tools allow to setup multiple JMX connections and provide view + for exploring the JMX tree and execute operations directly from Eclips= e. = - This chapter covers the basics of working with JMX plugin, which is - used to manage Java applications through JMX and its RMI Connector. + This chapter covers the basics of working with JMX plugin, = which is + used to manage Java applications (with Managed Beans) through JMX and = its RMI Connector. =
JMX Tools @@ -85,10 +113,10 @@
=
Key Features of JMX Tools - For a start, we propose you to look through the table of main fe= atures of JMX Tools: + For a start, we propos= e you to look through the table of main features of JBoss JMX Tools: = - Key Functionality for JMX Tools + <diffmk:wrapper diffmk:change=3D"changed">Key Functionality f= or JBoss JMX Tools</diffmk:wrapper> = @@ -129,14 +157,14 @@ Requirements and Installation
Requirements - Requirements to use JMX Tools are the following: + Requirements to use JBoss JMX Tools are = the following: = - JMX Tools is develope= d on Eclipse 3.4.x milestones + JBoss JMX Tools is developed on Eclip= se 3.4.x milestones - JMX Tools requires th= at Eclipse is run on a JDK 1.5.0 or above + JBoss JMX Tools requires that Eclipse= is run on a JDK 1.5.0 or above (due to dependencies on JMX packages which were introduced in Ja= va 1.5.0) @@ -146,23 +174,22 @@ Here, we are going to explain how to install the JMX plugin into Eclipse. = - JMX Tools is one module o= f the JBoss Tools - project. JMX Tools has no dep= endency on any other part of JBoss - Tools, and can be downloaded standalone. Even though th= e JMX - Tools have no dependencies, other plugins, such as AS Tools, - do depend on the JMX Tooling and even extend it. + JBoss JMX Tools is one module of the JBoss Tools + project. JBoss JMX Tools has no dependency= on any other part of JBoss + Tools, and ca= n be downloaded as a standalone Eclipse plugin. Even though the JMX + Tools have no= dependencies on other plugins, such as AS Tools, + = JBoss JMX Tools do depend on the JMX Tooli= ng and even extend it. = - You can find the JBoss Tools plugins over at the download pages. The only - package you'll need to get is the JMX Tooling, however the AS - Tools would give you a more full experience when using = JMX with JBoss Servers. - You can find further download and installation instructions on the J= Boss Wiki in the InstallingJBossTools + You can find the JBoss JBoss Tools plugin= s over at the down= load pages. The only + package you'll need to get is the JBoss JMX Tooling, however the AS + Tools would g= ive you a wider experience and more options when using JMX with JBoss Serve= rs. + You can find further download and installation instructions on the J= Boss Wiki in the InstallingJBossTools section.
- = - = - + = + JMX Tools Tasks This chapter will give you answers on most popular questions ask= ed by JMX @@ -170,12 +197,12 @@
Quick Start = - To start using the JMX Tools, it's necessary to open - MBean Explorer. Go to <= emphasis>Window > Show View > Other and then select + 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 clic= k OK. = - The MBean Explorer li= sts all of the domains, mbeans, attributes, and operations inside a - connection. When you double-click on a MBean in the = MBean Explorer, it opens = a multi-page + The MBean Explorer lists all the domains, mbeans, att= ributes, and operations inside a + connection. When you double-click a MBean in the MBean Explorer, it opens a multi-page editor to manage the MBean. The MB= ean Editor is composed of these pages: = @@ -194,6 +221,102 @@ =
+ = +
+ <diffmk:wrapper diffmk:change=3D"ad= ded">Managing Application</diffmk:wrapper> + + + +As i= t's been said earlier in the guide the JMX technology allows to monitor and= manage Java applications. In this section we will show you how to get conn= ected to = +a sample Java application and run the sa= yHello() method remotely from inside of the MBea= n Explorer. + + +http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip + +Save the bundle of JMX API s= ample classes, jmx_examples.zip, to your working directory +Unzip the bundle of sample classes. +Compile the example Java classes from within = where you unpacked the files directory. + + = + + +Start the M= ain app= lication, specifying the properties that expose Main for remote management:= + + = + = +If e= verything was done correctly you will see the "Waiting for incoming request= s..." message on the screen. = + + = + + Now launch the Eclipse IDE, in Eclipse open= the <= diffmk:wrapper diffmk:change=3D"added">MBean Explorer. Go to Window > Show View > O= ther and then select + MBean Explorer and click OK) + + Click the + New Connection icon = + = + = + + + + + = + in the MBean Explore= r menu + bar. + + = + In the Create JMX Connection dialog, hit Next and then= click the Advanced tab. + = + = + In the JMX= URL in= put field enter the following URL: + = + = + = +
+ <diffmk:wrapper diffmk:change=3D"added"= >JMX Connection</diffmk:wrapper> + + + <= /imagedata> + + +
+
+ = + Press Fin= ish to = esteblish the connection with the application. + + = + Now expand the connection you have just crea= ted, then open the com.example package and click= sayHello() method. + Onc= e the sayHello() method is clicked the MBean Editor is activated. + = + + = + In the MB= ean Editor go to the Operation Details section and hi= t the sayHello() button. You= will get the "Operation inoked successfully" message. = + = +
+ <diffmk:wrapper diffmk:change=3D"added"= >Ivoking Method via JMX</diffmk:wrapper> + + + + + +
+
+ = + The final step is to make sure the applica= tion worked as it was expected. Open the terminal where you launched the ap= plication in step 3. Now you see the "hello, world" message on the screen. = = + +
+ + + +
Tomcat Managing = @@ -205,42 +328,42 @@ property com.sun.management.jmxremote.s= sl 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. + More information to = manage Tomcat can be found in Tomcat management documentation. + Instructions to mana= ge remotely Tomcat are available in = Tomcat'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: + In= this section we will show you how to connect to an Equinox server via JBos= s JMX tools. First off, you need to make for example a simple servlet and r= un it on a server. This guide is not intended to teach you how to build app= lication and run them on the server, you can read for example this = tutorial = to get a better idea of how to build server-based applications with Eclipse= Equinox. + Once you have run an appl= ication on the server you can connect to it using JBoss JMX tools. = - + Go to Window > Open Perspecti= ve > Other - and select the JMX= perspective + and select the JMX perspective. = - + = Switch to the MBean Expl= orer by going to Window > Show View >= Other - and selecting the MBean Explorer + and = selecting the MBean Explorer. = - Click on the + Click the= New Connection<= /emphasis> icon = = = @@ -249,24 +372,34 @@ = - in the MBean Explorer menu - bar + in the MBean Explorer menu + bar. = Select the Advanced tab and set the JMX URL to - service:jmx:rmi:///jnd= i/rmi://:8118/jmxserver + service:jmx:rmi:///jndi/rmi://:8118/jmxserver. + = +
+ <diffmk:wrapper diffmk:change=3D"added"= >Using JMX Tools to Access Equinox Server</diffmk:wrapper> + + + = + + +
+
-
+ = You now have access to the MBeans exposed by Equinox.
= = -
- Managing JBoss Instances +
+ <diffmk:wrapper diffmk:change=3D"changed">Managing JBoss AS= </diffmk:wrapper> = Managing JBoss instances is not supported with the JMX Tools alone. You must also download and install the AS Tools portion of @@ -274,46 +407,92 @@ 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 Servers view + Open the Servers view. = Right-click in the view and select New > Server - + . = In the - JBoss Community - section, select a server version + JBoss Enterprise Middleware + or in = + JB= oss Community + sect= ion, select a server version. = - If a runtime has not yet been created, you'll be pro= mpted for the - server's home directory, JDK, and configuration + If a runti= me has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration. = Finish the wizard and note that you have a new entry= in both the - Servers view an= d the MBean - Explorer + Servers view and the MBean + Explorer. = Start the server by right-clicking it and selecting = - Start + Start. - Note that once the server is started, the JMX connec= tion can be - expanded + Note that = once the server is started, the JMX connection can be + expanded. - + = Now you can explore MBeans exposed by a JBoss instance.
+ = +
+ <diffmk:wrapper diffmk:change=3D"ad= ded">Managing JBoss AS Remotely</diffmk:wrapper> + = + JBoss JMX Tool allow you to easily get access and mangane JBoss AS ser= ver remotely. = + In order to get connected to the instance of JBoss AS remotely you need = to run the server or make sure the server is lauched. = + + + + Go to + Window > Open Perspective > Oth= er + and se= lect the JMX perspective. + = + + Switch to the MBean Explorer<= /diffmk:wrapper> by goin= g to + Window > Show View > Other + and se= lecting the MBean Explorer. + + = + + Click the + New Connection icon = + = + = + + + + + = + in the MBean Explore= r menu + bar. + + = + + Select the + Advanced tab and set the JMX URL = to: = + = + = + = Please, note that in this example we connected to the local host. = + + +
= Extension Task This section will outline how to contribute your own Server = type with some default @@ -358,9 +537,8 @@ 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 welcom= e on = - JBoss forum. + 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.
@@ -385,12 +563,12 @@ this server is in the connected state only when the server is = started. = = -
The Default Connection +
<diffmk:wrapper diffmk:change=3D"changed">Establis= hing Connection</diffmk:wrapper> = 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 - + The first ste= p is the same for both - to connect to a MBean Server, click the + New Connection<= /emphasis> icon = = = @@ -404,14 +582,16 @@ Then to follow the simple one you just need to specify h= ost, port (and optionally user name and password) and click OK.<= /para> + On the Advanced tab you can set the sever name (it will be displayed in MBean Explorer), a url to the remote server. + For example, to connect to JBoss AS you need to set the JMX URL to = + + = + If it is required you c= an enter user name and password for the server connection. = + + = = - The default JMX URL is - service:jmx:rmi:///jndi/rmi://= localhost:3000/jmxrmi. - = - 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. @@ -422,7 +602,7 @@ = = = - + References = @@ -548,16 +728,16 @@ -
- <diffmk:wrapper diffmk:change= =3D"added">Visual Page Editor</diffmk:wrapper> = - - - +
+ Visual Page Editor = + + + - - + + The Visual Page Editor, showing both the source an= d a visual preview simultaneously. - +
@@ -593,7 +773,7 @@ = = - + Summary In conclusion, with this document you could easily start with JX= M Tools. --===============2963928807082918555==--