1servertool(1) General Commands Manual servertool(1)
2
6 servertool - The Java(TM) IDL Server Tool
7 servertool provides a command-line interface for application program‐
9 mers to register, unregister, startup, and shutdown a persistent
10 server.
11
13 servertool -ORBInitialPort nameserverport options [ commands ]
14 If you did not enter a command when starting servertool, the com‐
17 mand-line tool displays with a servertool > prompt. Enter commands at
18 the servertool > prompt.
19 If you enter a command when starting servertool, the Java IDL Server
21 Tool starts, runs the command, and exits.
22 The -ORBInitialPort nameserverport option is required. The value for
24 nameserverport must specify the port on which orbd is running and lis‐
25 tening for incoming requests. When using Solaris software, you must
26 become root to start a process on a port under 1024. For this reason,
27 we recommend that you use a port number greater than or equal to 1024
28 for the nameserverport.
29
31 The servertool provides the command-line interface for the application
32 programmers to register, unregister, startup, and shutdown a persistent
33 server. Other commands are provided to obtain various statistical
34 information about the server.
35
37 -ORBInitialHost nameserverhost
38 Specifies the host machine on which the name server is running and
39 listening for incoming requests. The nameserverhost defaults to
40 localhost if this option is not specified. If orbd and servertool
41 are running on different machines, you must specify the name or IP
42 address of the host on which orbd is running.
43 -Joption
45 Pass option to the Java virtual machine, where option is one of the
46 options described on the reference page for the java a pplication
47 launcher @
48 http://java.sun.com/javase/6/docs/technotes/tools/solaris/java.html.
49 For example, -J-Xms48m sets the startup memory to 48 megabytes. It
50 is a common convention for -J to pass options to the underlying vir‐
51 tual machine.
52
54 register -server <server class name>
55 -classpath <classpath to server> [ -applicationName <applica‐
56 tion name> -args <args to server>
57 -vmargs <flags to be passed to Java VM> ] Register a new persistent
58 server with the Object Request Broker Daemon (ORBD). If the server
59 is not already registered, it is registered and activated. This com‐
60 mand causes an install method to be invoked in the main class of the
61 server identified by the -server option. The install method must be
62 public static void install(org.omg.CORBA.ORB). The install method is
63 optional and enables the developer to provide their own server
64 installation behavior (for example, creating database schema).
65 unregister
67 -serverid <server id > | -applicationName <application name> Unreg‐
68 ister a server from the ORBD by using either its server id or its
69 application name. This command causes an uninstall method to be
70 invoked in the main class of the server identified by the -server
71 option. The uninstall method must be public static void unin‐
72 stall(org.omg.CORBA.ORB). The uninstall method is optional and
73 enables the developer to provide their own server uninstall behavior
74 (for example, undoing the behavior of the install method).
75 getserverid
77 -applicationName <application name> Return the server id that corre‐
78 sponds with an application.
79 list
81 List information about all persistent servers registered with the
82 ORBD.
83 listappnames
85 List the application names for all servers currently registered with
86 the ORBD.
87 listactive
89 List information about all persistent servers that have been
90 launched by the ORBD and are currently running.
91 locate -serverid <server id > |
93 -applicationName <application name> [-endpointType <endpointType> ]
94 Locate the endpoints (ports) of a specific type for all ORBs created
95 by a registered server. If a server is not already running, it is
96 activated. If an endpoint type is not specified, then the
97 plain/non-protected endpoint associated with each ORB in a server is
98 returned.
99 locateperorb
101 -serverid <server id > | -applicationName <application name>
102 [-orbid <ORB name> ] Locate all the endpoints (ports) registered by
103 a specific ORB of registered server. If a server is not already run‐
104 ning, then it is activated. If an orbid is not specified, the
105 default value of "" is assigned to the orbid. If any ORBs are cre‐
106 ated with an orbid of empty string, all ports registered by it are
107 returned.
108 orblist -serverid <server id > |
110 -applicationName <application name> Lists the ORBId of the ORBs
111 defined on a server. An ORBId is the string name for the ORB created
112 by the server. If the server is not already running, it is acti‐
113 vated.
114 shutdown -serverid <server id > |
116 -applicationName <application name> Shutdown an active server that
117 is registered with ORBD. During execution of this command, the shut‐
118 down() method defined in the class specified by either the -serverid
119 or -applicationName parameter is also invoked to shutdown the server
120 process appropriately.
121 startup -serverid <server id > |
123 -applicationName <application name> Startup or activate a server
124 that is registered with ORBD. If the server is not running, this
125 command launches the server. If the server is already running, an
126 error message is returned to the user.
127 help
129 List all the commands available to the server through the server
130 tool.
131 quit
133 Exit the server tool.
134
136 orbd
137 05 Aug 2006 servertool(1)