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
39 and listening for incoming requests. The nameserverhost defaults
40 to localhost if this option is not specified. If orbd and server‐
41 tool are running on different machines, you must specify the name
42 or IP address of the host on which orbd is running.
43 -Joption
45 Pass option to the Java virtual machine, where option is one of
46 the options described on the reference page for java(1). For
47 example, -J-Xms48m sets the startup memory to 48 megabytes. It is
48 a common convention for -J to pass options to the underlying vir‐
49 tual machine.
50
53 register -server <server class name> -classpath <class‐
54 path to server> [ -applicationName <application name>
55 -args <args to server> -vmargs <flags to be passed to Java VM> ]
56 Register a new persistent server with the Object Request Broker
57 Daemon (ORBD). If the server is not already registered, it is
58 registered and activated. This command causes an install method
59 to be invoked in the main class of the server identified by the
60 -server option. The install method must be public static void
61 install(org.omg.CORBA.ORB). The install method is optional and
62 enables the developer to provide their own server installation
63 behavior (for example, creating database schema).
64 unregister -serverid <server id > | -applicationName <applica‐
66 tion name>
67 Unregister a server from the ORBD by using either its server id
68 or its application name. This command causes an uninstall method
69 to be invoked in the main class of the server identified by the
70 -server option. The uninstall method must be public static void
71 uninstall(org.omg.CORBA.ORB). The uninstall method is optional
72 and enables the developer to provide their own server uninstall
73 behavior (for example, undoing the behavior of the install
74 method).
75 getserverid -applicationName <application name>
77 Return the server id that corresponds with an application.
78 list
80 List information about all persistent servers registered with the
81 ORBD.
82 listappnames
84 List the application names for all servers currently registered
85 with the ORBD.
86 listactive
88 List information about all persistent servers that have been
89 launched by the ORBD and are currently running.
90 locate -serverid <server id > | -applicationName <application name>
92 [-endpointType <endpointType> ]
93 Locate the endpoints (ports) of a specific type for all ORBs cre‐
94 ated by a registered server. If a server is not already running,
95 it is activated. If an endpoint type is not specified, then the
96 plain/non-protected endpoint associated with each ORB in a server
97 is returned.
98 locateperorb -serverid <server id > | -applicationName <applica‐
100 tion name> [-orbid <ORB name> ]
101 Locate all the endpoints (ports) registered by a specific ORB of
102 registered server. If a server is not already running, then it is
103 activated. If an orbid is not specified, the default value of ""
104 is assigned to the orbid. If any ORBs are created with an orbid
105 of empty string, all ports registered by it are returned.
106 orblist -serverid <server id > | -applicationName <application name>
108 Lists the ORBId of the ORBs defined on a server. An ORBId is the
109 string name for the ORB created by the server. If the server is
110 not already running, it is activated.
111 shutdown -serverid <server id > | -applicationName <applica‐
113 tion name>
114 Shutdown an active server that is registered with ORBD. During
115 execution of this command, the shutdown() method defined in the
116 class specified by either the -serverid or -applicationName
117 parameter is also invoked to shutdown the server process appro‐
118 priately.
119 startup -serverid <server id > | -applicationName <application name>
121 Startup or activate a server that is registered with ORBD. If the
122 server is not running, this command launches the server. If the
123 server is already running, an error message is returned to the
124 user.
125 help
127 List all the commands available to the server through the server
128 tool.
129 quit
131 Exit the server tool.
132
135 orbd(1)
136 16 Mar 2012 servertool(1)