The target audience of this guide is the JOnAS server administrator.
JOnAS provides two tools to perform some administration tasks on a
running JOnAS Server.
These tools allow to administrate several JOnAS Servers.
Each JOnAS Server is identified by a name which is the value of the
JOnAS property jonas.name
(default name is jonas
).
The provided administration tools are:
jonas admin
, which is a command line
tool, andJadmin
, which is a graphical tool based on the JMX technology.jonas admin is described in the JOnAS Commands chapter.
Server-side component model and middleware services are about to become a major stake today. That is why an application server such as JOnAS has to provide management and monitoring features.
This chapter provides information for installing, configuring and using the Jadmin administration console.
Jadmin is an administration tool developed with the Java Servlet technology, so it is accessible with a web browser.
Since JOnAS 2.5.3 JOnAS can use either Tomcat or Jetty Servlet container in the same JVM as JOnAS. You only have to launch JOnAS with theweb
service.
Jadmin.properties
configuration
file is provided in the $JONAS_ROOT/conf/
directory. The value of the Jadmin.ConnectorFactory.class
property must be consistent with the chosen JMX implementation:
org.objectweb.jonas.jmx.vjadmin.ManagementReprImpl
if using SUN RIorg.objectweb.jonas.jmx.vjadmin.Mx4jManagementReprImpl
if using MX4JSince the tool consists of servlets, you have to install a Servlet server. In the following, it will be considered that you use Tomcat (4.1.x) or Jetty. Tomcat installation and configuration are documented in the Tomcat user's guide. You may find a quick installation guide for Tomcat with JOnAS in the Use Tomcat with JOnAS HowTo document.
The steps for installing Jadmin in Tomcat are described below:
tomcat-users.xml
file in the $CATALINA_BASE/conf/
directory for Tomcat 4.1.x:
<tomcat-users> <user name="jadmin" password="jonas" roles="jadmin,tomcat" /> ... </tomcat-users>Of course, you can set another password.
For using Jadmin with Jetty:
web
service for jetty is to use the jetty configuration file found under JONAS_ROOT/conf
directory and to launch the jadmin.war
file found under JONAS_ROOT/webapps
so no extra manipulation is needed.JONAS_ROOT/config/jettyRealm.properties
file is used and it is correctly set for using Jadmin. If you want to set another password you must modify this file.Be sure you have set web
in the jonas.services
property
in the jonas.properties
file. Depending on the Servlet container you want to use, you must set CATALINA_HOME
(for Tomcat4.1.x) or JETTY_HOME
environment variable. We noticed that when running the Servlet container on top of Unix, the DISPLAY
environment variable must be set in order to use the JOnAS server monitoring feature of Jadmin.
Once you have launched JOnAS, Jadmin is accessible at this URL:
http://<hostname>:<portnumber>/jadmin/
on your
favorite web browser.
<hostname> is the name of the host where the Servlet container is running and <portnumber> is the http port number (default is 8080).
The first page you see after clicking on the entering page is the following:
The registry URL corresponding to your JOnAS configuration is displayed in the "Registry URL" text area. Note that if you have several JOnAS servers running and using different registries, you have the possibility to set the registry URL in order to manage the corresponding servers.
If you have several JOnAS servers running on the same registry, they will appear
in this page, and you will be able to choose which one you intend to manage (check button).
The management information appearing in the different Jadmin pages will be related
to the selected JOnAS server. For example in the figure above, two JOnAS servers are
running, one is named jonas
, the other one is named jonas_srv2
,
and the first one is selected. The name of a JOnAS server is specified in its
jonas.properties
configuration file, in the property jonas.name
.
You may stop a JOnAS server using the provided link, if the jadmin.war containing the
Jadmin application components was not loaded in that server. That's the reason why,
in order to really stop the server, you
should click a second time on the stop link after the alert message was printed.
The following of this section explains the general principles of the graphical user interface of Jadmin.
The interface is divided in thumb indexes: one index for the server monitoring, one index for each service, one for the logging system management, and a last one for the
MBeans.
Note that you can go back to
the Jadmin Home Page from any other page, allowing thus to change the registry, to change the
managed server or to stop a server.
Since most of the management operations are not idempotent, the user should not use the browser reload button, but the Refresh link in the top banner.
Some thumb indexes are organized as tree structures. For example:
The JOnAS administration interface consists of JMX attributes and operations. Attributes could be readable and/or writable. When an attribute is writable, it is displayed in a TEXT INPUT element and there are two buttons beside it (the reset button reset the text input with its initial value, the submit button sends the new value to the server).
In some cases, JMX attributes allow to modify a set of configuration properties. For example,
suppose you need to configure a Mail Factory resource loaded by the Mail Service.
The configuration properties used to create the javax.mail.Session
object are
presented in a TEXTAREA element as shown in the picture below. If you need to define a new
property, add a string containing the name of the property followed by '=' and then, by the
property value, ending with ';'.
Sometimes, writables attributes are presented with a check box or a radio box, it depends on the attribute type (if it is a boolean for example).
Operations are presented as boldface characters links. When an operation needs a parameter, it is presented with an input text area and a button.
The All MBeans index thumb displays the exhaustive list of all MBeans.
One management operation is especially important, it is the possibilility to load stand alone J2EE components (jar or war packages) or J2EE applications (ear packages) from the Jadmin console. These functions are provided by the Container Service, Web Service and Ear Service respectively. For instance, in order to load one of the provided example samples (sb, eb, etc.), click on the Container Service index, and use the "ejb-jar deployment descriptor or jar file" text input area:
In the text area, you should put
jadmin.war
located in $JONAS_ROOT/webapps
.
For example in order to change the background color of the Jadmin panels you must:
jadmin.war
#set ($cell_color = '"#C0C0C0"')
$JONAS_ROOT/webapps
.