Start a JOnAS server.

The process can be run in the foreground, in the background, or in a new window. If the background option is chosen (default option), control is given back to the caller only when the server is ready.

The gui and tui options allow to interact with the OSGi framework.

The name of the management domain to which the server belongs is given by the domain.name propery, or by the server name if this property is not defined.

Stop a running or a standby JOnAS server by stopping in a first time all services and then the JVM.

The name of the management domain to which the server belongs is given by the domain.name propery, or by the server name if this property is not defined.

Administer a JOnAS server.

The connection to the server is established through JMX. The default JMX service URL is build from the information contained in the local $JONAS_BASE/conf/carol.properties file. You can customize the JMX service URL by specifying the server name, the registry URL and the protocol name.

Set the username and the password if the connection to the remote JOnAS server requires an authentication.

Used without any administration option, this command will prompt the user for an administration command (interactive mode). Each administration command exists in a non-interactive mode, to be used in shell or bat scripts for example.

Options can be divided in two categories, the connection options and the administration options.

Print the current version of the JOnAS server.

Check that the JOnAS server is well installed. Below the result of the jonas check command :

Checking jonas.properties file...
- jonas.services : registry,jmx,jtm,db,security,resource,ejb2,ejb3,jaxws,web,ear,depmonitor

Checking JORAM configuration...

Checking port availability...

The JOnAS environment seems correct.

The command is a wrapper of the jonas command enabling to control a local cluster previously built with the newjc command.

The names and paths of the cluster instances are built from a set of variables (JCL_NUMBER_OF_NODES, JCL_BASE_PREFIX, JCL_NODE_NAME_PREFIX, ...). The list of variable in an example is given below.

JCL_NUMBER_OF_NODES=2

JCL_CLUSTER_DAEMON_DIR=/home/jonas/njc51/cd
JCL_BASE_PREFIX=/home/jonas/njc51/jb

JCL_NODE_NAME_PREFIX=node
JCL_DOMAIN_NAME=sampleCluster2Domain

JCL_DB_DIR=/home/jonas/njc51/db
JCL_DB_NAME=db

JCL_MASTER_DIR=/home/jonas/njc51/master
JCL_MASTER_NAME=master

export JCL_MASTER_NAME JCL_MASTER_DIR JCL_DB_NAME JCL_DB_DIR JCL_DOMAIN_NAME JCL_NODE_NAME_PREFIX
export JCL_NUMBER_OF_NODES JCL_CLUSTER_DAEMON_DIR JCL_BASE_PREFIX

The control commands (status/start/stop/...) are applied for all the instances by default. A particular instance or a subset of instances can be specified with the -n argument.

Example for starting node1 and node2:

$JONAS_ROOT/bin/jcl.sh -n 1,2 start

Example for getting the status for node1, node2, node3 and node4:

$JONAS_ROOT/bin/jcl.sh -n 1-4 status

Launch the JORAM server with the existent configuration.

The JORAM server configuration files are listed below:

The JmsServer command is typically run in the background:

The joram_raconfig tool aims to facilitate consistent updates (accross multiple files) for the host and port parameters of a given JORAM server ID.

JORAM relies on several configuration files: a3servers.xml, joramAdmin.xml and ra.xml. With joram_raconfig, these configuration files are updated all together and thus the consistency is ensured.

Modified files:

Resource adapters files are looked up in the following places:

>$ joram_raconfig -h localhost -p 16012 -s 0
Target JORAM Resource Adapter: /home/ ... /joram/joram_ra_for_jonas/5.2.1a/joram_ra_for_jonas-5.2.1a.rar

The newjb utility builds a new JONAS_BASE directory that allows the conformance tests to be launched. At the start, the user must choose:

The tool generates the configuration automatically.

The $JONAS_BASE variable must be set before launching the tool; it specifies the path to the new directory that will be built.

The $HOME/jb.config/lib directory must be created before launching the tool. It can contain some specific user configuration (see below).

The tool relies on JOnAS 's ant tasks ($JONAS_ROOT/templates/newjb/build-jb.xml) and thus builds a configuration compatible with the JOnAS version. First, a JONAS_BASE with default values is built, and then the configuration files are modified with the values defined in the centralized configuration file of newjb (see below).

A default configuration file is provided in $JONAS_ROOT/templates/newjb/build-jb.properties. It contains the variable parameters used by the tool, such as port number and database properties.

A user configuration can be set in the $HOME/jb.config/conf/jonas-newjb.properties file. If this file is present, the parameters it contains will override the default parameters.

By default, only the HSQL database can be configured with this tool. For other databases, the specific drivers must be stored in the $HOME/jb.config/lib directory before the run and the properties must be set in the $HOME/jb.config/conf/jonas-newjb.properties file.

The default script ($JONAS_ROOT/build-jb.xml) and its configuration ($JONAS_ROOT/templates/newjb/build-jb.properties) can be used as an example for creating a configuration tool corresponding to user's specific requirements.

The newjc utility builds all the configurations (ie JONAS_BASE) of the JOnAS instances for the cluster (including also a JOnAS master to manage the domain, a JOnAS db with an embedded HSQLDB server, and a cluster daemon). It also creates the configuration files needed for mod_jk.

At command start, the user must choose:

The tool generates the configuration automatically but you can customize some of the characteristics of the cluster by modifying the following files, in JONAS_ROOT/conf/newjc, before executing the command:

If the -auto option is used, the $JONAS_BASE variable must be set before launching the tool; it specifies the prefix of the paths to the new directories that will be built and that will contain the JONAS_BASE of the cluster members.

You can add some specific user configuration in the $HOME/jc.config/lib. If the directory doesn't exits, it will be created during the execution of the command.

A user configuration can be set in the $HOME/jc.config/conf/jonas-newjc.properties file. If this file is present, the parameters it contains will override the default parameters defined in JONAS_ROOT/conf/newjc/build-jc.properties.

newjc creates tomcat_jk.conf and workers.properties files under <cluster-directory>/conf/jk. The #Web section of build-jc.properties defines configuration parameters set by newjc in these files. The file tomcat_jk.conf contains apache directives supported in httpd.conf or apache2.conf. They are isolated in a separate file for modularity, then they must be included manually in httpd.conf or apache2.conf. Refer to workers HowTo documentation on the Tomcat site.

newjc generates by default four JOnAS instances (four JOnAS bases) in directories jb1, jb2, jb3 and jb4 under the cluster directory. Each JOnAS instance has its own configuration files into the conf directory (as any other JOnAS base). It also generates configurations for cluster daemon (cd directory), for master node (master directory), and for db node (db directory).

By default, jb1 and jb2 are JOnAS web container instances and jb3 and jb4 are JOnAS EJB container instances.

newjc generates a script called jcl4sc (jcl4sc.bat) for controlling the cluster examples provided with JOnAS named, sampleCluster2 and sampleCluster3. The command takes in argument the parameter status, start, stop, halt or kill.

The pertinent files for the configuration of the cluster are described below:

To make apache aware of this new file, edit <prefix>/conf/httpd.conf.

Copy and paste the following line after the Dynamic Shared Object (DSO) Support section.

Include conf/jk/tomcat_jk.conf 

Move the jk directory created by newjc under the APACHE structure:

bash> mv <cluster-directory>/conf/jk $APACHE_HOME/conf

Restart apache so that apache can load the jk_module:

bash> apachectl stop && apachectl start

The RAConfig utility provides the capability to create a JOnAS specific resource adapter configuration file (jonas-ra.xml) from a ra.xml file, or update a resource adapter file.

With this command it is possible to :

The InputFileName is the file name of a the resource adapter.

The OutputFileName is the file name of an output resource adapter. This parameter is used with the -p (required) or -u (optional) options.