Java Platform, Standard Edition Tools Reference
Contents Previous Next
servertool
Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server.
If you did not enter a command when starting servertool
, the command-line tool displays with a servertool >
prompt. Enter commands at the servertool >
prompt.
If you enter a command when starting servertool
, the Java IDL Server Tool starts, runs the command, and exits.
The -ORBInitialPort nameserverport
option is required. The value for nameserverport
must specify the port on which orbd
is running and listening for incoming requests.
Description
The servertool
command provides the command-line interface for developers to register, unregister, start up, and shut down a persistent server. Command-line commands let you obtain various statistical information about the server. See Commands.
Options
- -ORBInitialHost nameserverhost
-
This options is required. It specifies the host machine on which the name server runs and listens for incoming requests. The
nameserverhost
value must specify the port on which theorb
is running and listening for requests. The value defaults tolocalhost
when this option is not specified. Iforbd
andservertool
are running on different machines, then you must specify the name or IP address of the host on whichorbd
is running. - -Joption
-
Passes
option
to the Java Virtual Machine, whereoption
is one of the options described on the reference page for the Java application launcher. For example,-J-Xms48m
sets the startup memory to 48 MB. Seejava
(1).
Commands
You can start the servertool
command with or without a command-line command.
If you did not specify a command when you started
servertool
, then the command-line tool displays theservertool
prompt where you can enter commands:servertool >
.If you specify a command when you start
servertool
, then the Java IDL Server Tool starts, executes the command, and exits.
- register -server server-class-name -classpath classpath-to-server [ -applicationName application-name -args args-to-server -vmargs flags-for-JVM ]
-
Registers a new persistent server with the Object Request Broker Daemon (ORBD). If the server is not already registered, then it is registered and activated. This command causes an installation method to be called in the
main
class of the server identified by the-server
option. The installation method must bepublic static void install(org.omg.CORBA.ORB)
. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema. - unregister -serverid server-id | -applicationName application-name
-
Unregisters a server from the ORBD with either its server ID or its application name. This command causes an uninstallation method to be called in the
main
class of the server identified by the-server
option. Theuninstall
method must bepublic static void uninstall(org.omg.CORBA.ORB)
. Theuninstall
method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of theinstall
method. - getserverid -applicationName application-name
-
Returns the server ID that corresponds to the
application-name
value. - list
-
Lists information about all persistent servers registered with the ORBD.
- listappnames
-
Lists the application names for all servers currently registered with the ORBD.
- listactive
-
Lists information about all persistent servers that were started by the ORBD and are currently running.
- locate -serverid server-id | -applicationName application-name [ -endpointType endpointType ]
-
Locates the endpoints (ports) of a specific type for all ORBs created by a registered server. If a server is not already running, then it is activated. If an
endpointType
value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned. - locateperorb -serverid server-id | -applicationName application-name [ -orbid ORB-name ]
-
Locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of registered server. If a server is not already running, then it is activated. If an
orbid
is not specified, then the default value of""
is assigned to theorbid
. If any ORBs are created with anorbid
of empty string, then all ports registered by it are returned. - orblist -serverid server-id | -applicationName application-name
-
Lists the
ORBId
of the ORBs defined on a server. AnORBId
is the string name for the ORB created by the server. If the server is not already running, then it is activated. - shutdown -serverid server-id | -applicationName application-name
-
Shut down an active server that is registered with ORBD. During execution of this command, the
shutdown
method defined in the class specified by either the-serverid
or-applicationName
parameter is also called to shut down the server process. - startup -serverid server-id | -applicationName application-name
-
Starts up or activate a server that is registered with ORBD. If the server is not running, then this command starts the server. If the server is already running, then an error message is displayed.
- help
-
Lists all the commands available to the server through the
servertool
command. - quit
-
Exits the
servertool
command.