JOnAS header

JOnAS 4.8 EE Commands Reference Guide


Table of Contents

I. jonas command
jonas start — comand allowing to start a JOnAS server
jonas stop — comand allowing to stop a JOnAS server
jonas admin — command allowing to administer a JOnAS server
II. jclient command
jclient — start a heavy java client
III. GenIC command
GenIC — generates the container classes for E JBs
IV. JMS commands
JmsServer — Launches the JORAM Server with its default options.
joram_raconfig — Changes to the parameters (host, port, server id) in the JORAM configuration files.
V. RAConfig command
RAConfig — generates a JOnAS specific resource adapter configuration file or a resource adapter file
VI. newjb command
newjb — builds a new JONAS_BASE directory

jonas command


This command provides the capability to start, stop, or administrate JOnAS servers.

The following two scripts can be reviewed and possibly modified for assistance with problems or for obtaining additional information:

  • jonas for UNIX systems

  • jonas.bat for WINDOWS systems

There are five different sub-commands, that depend on the first mandatory argument: start, stop, admin, check, version

Table of Contents

jonas start — comand allowing to start a JOnAS server
jonas stop — comand allowing to stop a JOnAS server
jonas admin — command allowing to administer a JOnAS server

Name

jonas start — comand allowing to start a JOnAS server

Synopsis

jonas start [-fg | -bg | -win] [-n name] [-Ddomain.name=domain] [-target server]

Description

Start a new 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 server's name is by default jonas. A different name can be given with the -n option.

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

The name of the server has to be unique in the domain.

The -target option allows to start another server or cluster (group of servers) in the domain.

This action is to be executed in the environment of a running master server who's name is given by the -n option. In order to start a target server or cluster, the following conditions have to be met:

  • the target must belong to the domain (has to be defined in the domain's map)

  • a cluster daemon has to be running on the target's host and it has to be aware of the target (see cluster daemon configuration)


Name

jonas stop — comand allowing to stop a JOnAS server

Synopsis

jonas stop [-n name] [-target server]

Description

Stop a running JOnAS server. Use the -n option if the server to stop was given a name other than the default name.

The server's name is by default jonas. A different name can be given with the -n option.

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

The name of the server has to be unique in the domain.

The -target option allows to start another server or cluster (group of servers) in the domain. This action is to be executed in the environment of a running master server who's name is given by the -n option. In order to start a target server or cluster, the following conditions have to be met:

  • the target must belong to the domain (has to be defined in the domain's map)

  • a cluster daemon has to be running on the target's host and it has to be aware of the target (see cluster daemon configuration)


Name

jonas admin — command allowing to administer a JOnAS server

Synopsis

jonas admin [-n name] [admin_options] [-target server]

Description

Administrate a JOnAS server. Use the -n option if the server was given a name other than the default name. Used without any other option, this command will prompt the user for an administrative command (interactive mode). Each administrative command exists in a non-interactive mode, for use in shell scripts or bat scripts, for example.

When using the -target option, the administrative commands are applied to another server or to a cluster (group of servers) running in the domain. This supposes that the command is executed in the master server's environment. The master server's name is specified with the -n option.

Admin options

[? ]: Prints a help with all possible options.

[-a filename ]: Deploys a new application described by filename on the current JOnAS server, or on another target in the domain, if the current server is a master. The current server is identified by the default name or by the -n option.

The application can be one of the following:

  • a standard ejb-jar file. This will lead to the creation of a new EJB container in the JOnAS server. If the file name has a relative path, this path is relative to where the server has been launched or relative to the $JONAS_BASE/ejbjars directory.

  • a standard .war file containing a WEB module. If the file name has a relative path, this path is relative to where the server has been launched or relative to the $JONAS_BASE/webapps directory.

  • a standard .ear file containing a complete J2EE application. If the file name has a relative path, this path is relative to where the server has been launched or relative to the $JONAS_BASE/apps directory.

  • a standard .rar file containing a RAR module. If the file name has a relative path, this path is relative to where the server has been launched or relative to the $JONAS_BASE/rars directory.

-r filename : Dynamically undeploys a previously deployed application from the current server or from the specified target if the current server is a master.

-gc : Runs the garbage collector in the current JOnAS server.

-passivate : Passivates all entity bean instances. This affects only instances outside transaction.

-e : Lists the properties of the current JOnAS server.

-j : Lists the registered JNDI names, as seen by the current JOnAS server.

-l : Lists the beans currently loaded by the current JOnAS server.

-sync : Synchronizes the entity bean instances on the current JOnAS server. Note that this affects only the instances that are not involved in a transaction.

-debug topic : Sets the topic level to DEBUG.

-tt timeout : Changes the default timeout for transactions. timeout is in seconds.

-ping [-timeout seconds] : Waits until the JOnAS server is available.

Each jonas admin option has its equivalent in the interactive mode. To enter interactive mode and access the following list of subcommands, type jonas admin [-n name] without any other argument. To exit from interactive mode, use the exit command.

interactive commandoptions
addbeans-a filename
env-e
gc-gc
help-?
jndinames-j
listbeans-l
removebeans-r filename
sync-sync
trace-debug topic
ttimeout-tt timeout
quitexit interactive mode

Examples

jonas check

jonas start -n jonas1

jonas admin -n jonas1 -a bean1.jar

jonas stop -n jonas1

jclient command


Table of Contents

jclient — start a heavy java client

Name

jclient — start a heavy java client

Synopsis

jclient [options] java-class [args]

Description

The jclient command allows the user to easily start a "heavy" java client that will be able to reach beans in remote JOnAS servers and start distributed transactions.

It is not the J2EE compliant way to run a java client which is to use to package the java client in a J2EE container client (refer to Client Packaging).

Options

-cp classpath

Add an additional classpath before running the java program.

-security

Set a security manager using the policy file in $JONAS_BASE/conf/java.policy. (Used for automatic stubs downloading)

GenIC command


Table of Contents

GenIC — generates the container classes for E JBs

Name

GenIC — generates the container classes for E JBs

Synopsis

GenIC [ Options ] <InputFileName>

Description

The GenIC utility generates the container classes for JOnAS from the given Enterprise Java Beans.

The InputFileName is either the file name of an ejb-jar file or the file name of an XML deployment descriptor of beans.

The GenIC utility does the following :

  1. generates the sources of the container classes for all the beans defined in the deployment descriptor,

  2. compiles these classes via the java compiler,

  3. generates stubs and skeletons for those remote objects via the rmi compiler, and

  4. if the InputFile is an ejb-jar file, adds the generated classes in this ejb-jar file.

Options

-d directory

Specifies the root directory of the class hierarchy.

This option can be used to specify a destination directory for the generated files.

If the -d option is not used, the package hierarchy of the target class is ignored and the generated files are placed in the current directory.

If the InputFile is an ejb-jar file, the generated classes are added to the ejb-jar file, unless the -noaddinjar option is set.

-invokecmd

Invokes directly the java class corresponding to the java compiler.

This is useful on Windows in the event of a CreateProcess Exception (this occurs when the command line is too long).

In this case tools.jar must be visible in the CLASSPATH

-javac options

Specifies the java compiler name to use (javac by default).

-javacopts options

Specifies the options to pass to the java compiler.

-keepgenerated

Do not immediately delete generated files.

-noaddinjar

If the InputFile is an ejb-jar file, do not add the generated classes to the ejb-jar file.

-nocompil

Do not compile the generated source files via the java and rmi compilers.

-novalidation

Remove xml validation during parsing.

-protocols

Comma-separated list of protocols (jrmp,iiop,cmi) for which stubs should be generated. Default is jrmp

-rmiopts options

Specifies the options to pass to the rmi compiler.

-verbose

Displays additional information about command execution.

-nofastrmic

Disable the use of fastrmic for stubs/ties generation.

Example

GenIC -d ../../classes sb.xml

generates container classes of all the Enterprise JavaBeans defined in the sb.xml file. Classes are generated in the ../../classes directory adhering to the classes hierarchy.

GenIC sb.jar

generates container classes for all the Enterprise JavaBeans defined in the sb.jar file and adds the generated classes to this ejb-jar file.

Environment

If InputFile is an XML deployment descriptor, the classpath must include the paths of the directories in which the Enterprise Bean's classes can be found, as well as the path of the directory specified by the -d option.

If InputFile is an ejb-jar file, the classpath must include the path of the directory specified by the -d option.

JMS commands


Table of Contents

JmsServer — Launches the JORAM Server with its default options.
joram_raconfig — Changes to the parameters (host, port, server id) in the JORAM configuration files.

Name

JmsServer — Launches the JORAM Server with its default options.

Synopsis

JmsServer

Description

Launches the JORAM Server with its default options.

The JORAM server configuration file is $JONAS_BASE/conf/a3servers.xml

Example

The JmsServer command is typically run in the background:

JmsServer &

on Unix,

start JmsServer

on Windows


Name

joram_raconfig — Changes to the parameters (host, port, server id) in the JORAM configuration files.

Synopsis

joram_raconfig [[-p <port>] [-h <host>] [-s <serverid>]]

Description

The joram_raconfig tool aims to facilitate changes to the parameters (host, port, server id) in the JORAM configuration files.

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

Files modified:

  • $JONAS_BASE/conf/a3servers.xml

  • $JONAS_BASE/conf/joramAdmin.xml

  • $JONAS_BASE/rars/autoload/joram_for_jonas_ra.rar in which the file META_INF/ra.xml is updated.

Options

-p port

port : listening port of the JORAM server

-h host

host : IP address of the JORAM server

-s serverid

serverid : server id of the JORAM server

RAConfig command


Table of Contents

RAConfig — generates a JOnAS specific resource adapter configuration file or a resource adapter file

Name

RAConfig — generates a JOnAS specific resource adapter configuration file or a resource adapter file

Synopsis

RAConfig [ Options ] <InputFileName> [<OutputFileName>]

Description

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

With this command it is possible to :

  • extract a JOnAS -specific resource adapter configuration file (jonas-ra.xml) from an ra.xml file (See option -path)

  • create a new JOnAS -specific resource adapter configuration file (jonas-ra.xml) from an ra.xml file (See option -new)

  • create a resource adapater file (.rar file) from a dataSource.properties file (See option -p)

  • update a resource adapter file with a jonas-ra.xml ((See option -u)

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.

Options

-? or -HELP options

Gives a summary of the options.

-p or -Property database_properties_file_name

Specifies the name of the <database>.properties file to process. The result of this processing will be a jonas-ra.xml file that will update the /META-INF/jonas-ra.xml file in the output rar.

-DM,-DS,-PC,-XA

These options are related to the option -p above.

They specify the rarlink value to configure respectively DriverManager, DataSource,PooledConnection and XAConnection If -DM is used, then the conversion will be a direct reflection of the values specified in the -p <database>.properties file. If any of the other values are specified, then the jonas-ra.xml created will reflect options from the -p <database>.properties file and the user must edit the file based on information from the database provider for the specified type of datasource. Each database provider may have different config properties that need to be set and will be included in the database provider's documentation.

-PATH output directory

Specifies the directory name to place the extracted jonas-ra.xml file.

-NEW

Don't extract jonas-ra.xml but create a new one. The default value is the System attribute of java.io.tmpdir.

-Update inputname

Specifies the name of the XML file to process. This file will update the /META-INF/jonas-ra.xml file in the rar. If this argument is used, it is the only argument executed.

-Rarlink rarlink

Specifies the jndi name of an rar file with which to link. This option can be used when this rar file will inherit all attributes associated with the specified jndi name. If this option is specified in the jonas-ra.xml file, it is the only file needed in the rar, and the ra.xml file will be processed from the rarlink file.

-SecurityFile security_file_to_process

Specifies the security property file to process and add security information to jonas-ra.xml. This will map the specified principal name to the user on the EIS system. The specified file must be in the following form: principal = user::password . When used in conjunction with the -ENcrypt option, then the resulting information will be encrypted in jonas-ra.xml.

-ENcrypt

Used with -SecurityFile to encrypt the specified passwords.

-Jndiname jndiname

This option is deprecated with 1.5 Resource Adapter.

For 1.0 Resource Adapter, this specifies the JNDI name of the connection factory. This name corresponds to the name of the <jndi-name> element of the <jonas-resource> element in the JOnAS -specific deployment descriptor. This name is used by the resource service for registering in JNDI the connection factory corresponding to this resource adapter.

-NoValidation

Turn off the xml dtd/schema validation.

Examples

RAConfig -dm -p MySQL1 $JONAS_ROOT/rars/autoload/JOnAS_jdbcDM MySQL_dm

Generates a MySQL_dm.rar file linked to JOnAS_jdbcDM.rar the jonas-ra.xml file inserted is created with values coming from the ra.xml file of the JOnAS_jdbcDM.rar and values from the MySQL1.properties file

This rar file can then be deployed and will replace the configured MySQL1 datasource.

RAConfig -path . XX.rar

Extract the jonas-ra.xml of XX.rar in the working directory

RAConfig -u jonas-ra.xml MyRA.rar

Updates/inserts the jonas-ra.xml file into the MyRA.rar file.

newjb command


Table of Contents

newjb — builds a new JONAS_BASE directory

Name

newjb — builds a new JONAS_BASE directory

Synopsis

newjb

Description

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 protocol among jrmp,iiop,cmi

  • the database

  • the web container among tomcat, jetty

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/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/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/build-jb.properties) can be used as an example for creating a configuration tool corresponding to a user's specific requirements.

Log-in Register
Copyright �� ObjectWeb 2006
Java, and all Java-based trademarks, JMX and all JMX based trademarks, are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. Bull is independent of Sun Microsystems, Inc..