Chapter 13 Using jagtool and jagant

Working with jagtool

Before using jagtool, make sure that:

The JAGUAR environment variable is set.
Windows NT %JAGUAR%\bin is added to your path.
UNIX $JAGUAR/bin is added to your path.

Use the following scripts to run jagtool:

Windows NT %JAGUAR%\bin\jagtool.bat
UNIX $JAGUAR/bin/jagtool

jagtool syntax

The syntax for jagtool is:

jagtool [connection-arguments] [command]

Where:

connection-arguments specify optional parameters required to connect to the server, including:

Flag	To specify
`-h` or `-host`	Server host name, default the value of JAGUAR_HOST_NAME
`-n` or `-port`	Server IIOP port number, default 9000
`-u` or `-user`	User name, default "jagadmin"
`-p` or `-password`	Password, default "" (no password)
`-l` or `-logfile`	Log file name, default "System.out"

command is a jagtool command described in "jagtool commands".

For example, to connect to the server running on eclipse at port 9005, using account jagadmin with password secret enter:

jagtool -h eclipse -n 9005 -p secret

You can omit the -u flag because jagadmin is the default user name.

Entity identifiers

Many jagtool commands take one or more entity identifiers as arguments. An entity identifier is a string of the form EntityType:EntityName that uniquely identifies an entity in the repository.

Table 13-1 provides examples of entity identifiers for each entity type.

Table 13-1: Example entity identifiers
Entity Identifier	Specifies
`Agent:agent1`	Agent named agent1.
`Application:estore`	Application named estore.
`ApplicationClient:estore/PetStoreClient`	Application client PetstoreClient in application estore.
`Component:SVU/SVULogin`	Component named SVULogin that is installed in the SVU package. The package name is included because EAServer components always reside in packages.
`ConnCache:JavaCache`	Connection cache named JavaCache.
`Connector:BlackBoxLocalTx`	J2EE connector named BlackBoxLocalTx.
`DatabaseType:Sybase_ASA`	Database type definition named Sybase_ASA.
`EntityCollection:MyEntityCollection`	The entity collection named MyEntityCollection.
`Filter:WebTier/MyFilter`	The servlet filter MyFilter installed in the Web application WebTier.
`Listener:Jaguar/iiops1`	The network listener iiops1 installed in the server named Jaguar. When specifying a listener name, use the server name and the listener name as displayed in Jaguar Manager.
`ManagedConnectionFactory:BlackBoxLocalTx/EASDemo`	The managed connection factory EASDemo in the J2EE connector named BlackBoxLocalTx.
`Method:SVU/SVULogin/isLogin`	The isLogin method of component SVULogin in package SVU.
`Package:SVU`	The package named SVU.
`Role:MyRole`	The role named MyRole.
`Security:sample1`	The security entity named sample1.
`Server:Jaguar`	The server named Jaguar.
`Servlet:StandAloneServlet`	The servlet named StandaloneServlet. This syntax is valid only for servlets that are not installed in a Web application.
`Servlet:MyWebApp/MyServlet`	The servlet named MyServlet in Web application named MyWebApp. You must use this syntax for servlets that are installed in a Web application.
`WebApplication:WebTier`	The Web application named Web tier.

Not all jagtool commands support every type of entity in the repository. For example, the refresh command is not supported for the Listener entity type.

When a command specifies an invalid entity type, an appropriate error message is displayed.