Tools Reference Guide

The tools provided with JOnAS are described in this chapter.

CheckEJB
Enterprise Bean checker

GenDD
Deployment descriptor generator

DumpDD
Disassembles a serialized deployment descriptor

GenIC
Container classes generator

AdmServer
Administration Server (described in the Administration Guide chapter)

CheckEJB

Synopsis

CheckEJB [options] <InputFileName>

Description

The CheckEJB utility checks the validity of the given Enterprise JavaBean(s) according to the rules described in the Enterprise JavaBeans specification.
The InputFileName is either the file name of a serialized deployment descriptor of a bean, or the file name of a ejb-jar file.

Options

-help

Gives the summary of the options.

-verbose

Displays additional information about command execution.

Example

CheckEJB eb.jar
checks the validity of the Enterprise JavaBeans included in the eb.jar file.
Errors messages are written to standard error.

Environment Variable

CLASSPATH
must include the paths of the directories where the Enterprise Bean's classes may be found.

GenDD

Synopsis

GenDD [options] <InputFileName>

Description

The GenDD utility generates a serialized deployment descriptor from the textual representation found in the InputFileName file.
The syntax of the description language of a deployment descriptor may be written to standard output via the -grammar option.
Some examples of textual representations may be written to standard output via the -example option.
The resulting serialized deployment descriptor is named InputFileName.ser. Unless you specify the -d option, the generator places the serialized deployment descriptor in the same directory as the InputFileName file.

Options

-d directory
Specifies where to place the generated file
-example exampleName
Writes to standard output sample EJB deployment descriptor templates.
if exampleName = SessionDDMin a simple deployment descriptor for a session bean is printed
if exampleName= SessionDDMax a complete deployment descriptor for a session bean is printed
if exampleName = EntityDDMin a simple deployment descriptor for a entity bean is printed.
if exampleName = EntityDDMax a complete deployment descriptor for a entity bean is printed

-f filename
Specifies the name of the generated file. By default InputFileName.ser.

-grammar
Writes to standard output the syntax of the deployment descriptor description language.

-help
Gives a summary of the options.

-verbose
Displays additional information about command execution.

Example

GenDD Op.txt
generates in the current directory a serialized deployment descriptor Op.ser

Environment Variables

CLASSPATH
must include the paths of the directories where the Enterprise Bean's classes may be found.

DumpDD

Synopsis

DumpDD [options] <InputFileName>

Description

The DumpDD utility disassembles a given serialized deployment descriptor in the InputFileName file to a textual representation.
The result of this command produces an InputFileName.txt file with the textual representation of the given deployment descriptor, and a InputFileName.properties with the description of the environment properties for the bean.
Unless you specify the -d option, the command places the generated files in the same directory as the InputFileName file.

Options

-d directory
Specifies where to place the generated files

-f filename
Specifies the name of the generated files.
By default, InputFileName.txt and InputFileName.properties.

-help
Gives a summary of the options.

-verbose
Displays additional information about command execution.

Example

DumpDD Op.ser
generates in the current directory a textual representation of the deployment descriptor in Op.txt and Op.properties.

GenIC

Synopsis

GenIC [Options] <InputFileName>

Description

The GenIC utility generates the container classes that implement from the given Enterprise JavaBean(s) for JOnAS.
The InputFileName is either the file name of a serialized deployment descriptor of a bean, or the file name of a ejb-jar file.
The GenIC utility :
- firstly, generates the sources of the container classes,
- secondly, compiles these classes by way of the java compiler, and
- lastly , generates stubs and skeletons for those remote objects by way of the rmi compiler.

Options

-d directory
Specifies the root directory of the class hierarchy.
You can use this option 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.

-keepgenerated
Do not delete intermediate generated files.

-javacopts options
Specifies the options to pass to the java compiler.

-rmiopts options
Specifies the options to pass to the rmi compiler.

-verbose
Displays additional information about command execution.

Example

GenIC -d . sb.jar
generates container classes of all the Entreprise JavaBeans included in the sb.jar file.
All the files of the sb.jar file are extracted to the current directory.
The container classes are saved in the root directory ./<package_dir>.

Environment

CLASSPATH
must include the paths of the directories where the Enterprise Bean's classes may be found.