Chapter 12: Using jagtool and jagant

gen_stubsandskels

Description

Generates stubs and skeletons for a package or a component.

Syntax

Local mode support: Yes.

Command line:

gen_stubsandskels 
[ connect-args | local-args ]
[-javastubs true|false]
[-cppstubs true|false] 
[-javastubtype CORBA|EJB|Jaguar1.1] 
[-javastubjarname filename]
[-javastubcodebase path] 
[-cppstudcodebase path]
[-compilejavastubs true|false] 
[-generatedependentclasses true|false]
[-skels true|false] 
[-javaskelcodebase path] 
[-cppskelcodebase path]
[-compilejavaskels true|false]
[-pseudostubsandskels true|false]
[-jdkversion 1.1|1.2] 
[-verbose true|false] 
entity

Ant build file:

<jag_gen_stubsandskels
[ javastubs="true|false" ]
[ cppstubs="true|false" ]
[ javastubtype="CORBA|EJB|Jaguar1.1" ]
[ javastubjarname="filename" ]
[ javastubcodebase="path" ]
[ cppstudcodebase="path" ]
[ compilejavastubs="true|false" ]
[ generatedependentclasses=”true|false” ]
[ skels="true|false" ]
[ javaskelcodebase="path" ]
[ cppskelcodebase="path" ]
[ compilejavaskels="true|false" ]
[ pseudostubsandskels=“true|false”]
[ jdkversion="1.1|1.2" ]
[ verbose="true|false" ]
entity=”entity" />

Option	Description	Default	Required
connect-args \| local-args	Arguments to specify a connection to the server or to run in local mode. See “Local versus connected mode”.	-	Yes
`javastubs`	Indicates whether to generate Java stubs.	true	No
`cppstubs`	Indicates whether to generate C++ stubs.	true	No
`javastubstype`	The type of Java stubs used. Options are: CORBA EJB Jaguar1.1	CORBA	No
`javastubjarname`	If this flag is used, the generated Java stubs are placed in a JAR file with the specified file name on the server host. The full path for the file name must be specified.	-	No
`javastubcodebase`	The code base for Java stubs, on the server host.	$JAGUAR/html/classes	No
`cppstubcodebase`	The code base for C++ stubs, on the server host.	$JAGUAR/include	No
`compilejavastubs`	Indicates whether to compile Java stubs.	true	No
`generatedependent-classes`	For EJB components that have been deployed in an EJB-JAR file, specifies whether to include additional Java classes that are referenced by the bean’s client interfaces but that are not included in the EJB-JAR file or from packages that start with java., javax. or com.sybase.ejb.	true	No
`skels`	Indicates whether to generate skeletons.	true	No
`javaskelcodebase`	The code base for Java skeletons, on the server host.	$JAGUAR/java/classes	No
`cppskelcodebase`	The code base for C++ skeletons, on the server host.	$JAGUAR/cpplib	No
`compilejavaskels`	Indicates whether to compile Java skeletons.	true	No
`pseudostubsandskels`	Indicates whether to generate direct-access stubs and skeletons for C++ and Java/CORBA pseudocomponents. Use this option if the target components run as EAServer pseudocomponents.	false	No
`jdkversion`	Indicates the JDK version to use for compiling Java skeletons. Options are: 1.1 – JDK 1.1 1.2 – JDK 1.2 or later	1.2	No
`verbose`	Indicates whether to generate verbose output.	false	No
entity	The name of the entity for which stubs are generated, in the form EntityType:EntityName, where EntityType is either “Package” or “Component.”	-	Yes

Returns

Return value	Indicates
0	The command ran successfully; the result is true/success.
1	The command ran successfully; the result is false/failure.
2	The command did not run successfully; an exception was thrown.

Examples

Example 1

This example generates skeletons and EJB stubs for Package:SVU. The stubs and skeletons are automatically compiled.

Command line:

jagtool gen_stubsandskels -javastubtype EJB Package:SVU

Ant build file:

<jag_gen_stubsandskels="EJB" entity="Package:SVU" />