1 ." Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved. |
1 '\" t |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 .\" Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. |
3 ." |
3 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
5 ." under the terms of the GNU General Public License version 2 only, as |
5 .\" |
6 ." published by the Free Software Foundation. |
6 .\" This code is free software; you can redistribute it and/or modify it |
7 ." |
7 .\" under the terms of the GNU General Public License version 2 only, as |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
8 .\" published by the Free Software Foundation. |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
9 .\" |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
10 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ." accompanied this code). |
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ." |
13 .\" version 2 for more details (a copy is included in the LICENSE file that |
14 ." You should have received a copy of the GNU General Public License version |
14 .\" accompanied this code). |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
15 .\" |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
16 .\" You should have received a copy of the GNU General Public License version |
17 ." |
17 .\" 2 along with this work; if not, write to the Free Software Foundation, |
18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
19 ." or visit www.oracle.com if you need additional information or have any |
19 .\" |
20 ." questions. |
20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
21 ." |
21 .\" or visit www.oracle.com if you need additional information or have any |
22 .TH servertool 1 "10 May 2011" |
22 .\" questions. |
|
23 .\" |
|
24 .\" Arch: generic |
|
25 .\" Software: JDK 8 |
|
26 .\" Date: 21 November 2013 |
|
27 .\" SectDesc: Java IDL and RMI-IIOP Tools |
|
28 .\" Title: servertool.1 |
|
29 .\" |
|
30 .if n .pl 99999 |
|
31 .TH servertool 1 "21 November 2013" "JDK 8" "Java IDL and RMI-IIOP Tools" |
|
32 .\" ----------------------------------------------------------------- |
|
33 .\" * Define some portability stuff |
|
34 .\" ----------------------------------------------------------------- |
|
35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
36 .\" http://bugs.debian.org/507673 |
|
37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
39 .ie \n(.g .ds Aq \(aq |
|
40 .el .ds Aq ' |
|
41 .\" ----------------------------------------------------------------- |
|
42 .\" * set default formatting |
|
43 .\" ----------------------------------------------------------------- |
|
44 .\" disable hyphenation |
|
45 .nh |
|
46 .\" disable justification (adjust text to left margin only) |
|
47 .ad l |
|
48 .\" ----------------------------------------------------------------- |
|
49 .\" * MAIN CONTENT STARTS HERE * |
|
50 .\" ----------------------------------------------------------------- |
23 |
51 |
24 .LP |
52 .SH NAME |
25 .SH "Name" |
53 servertool \- Provides an easy-to-use interface for developers to register, unregister, start up, and shut down a persistent server\&. |
26 servertool \- The Java(TM) IDL Server Tool |
54 .SH SYNOPSIS |
27 .LP |
55 .sp |
28 \f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server. |
56 .nf |
29 .SH "SYNOPSIS" |
|
30 .LP |
|
31 .nf |
|
32 \f3 |
|
33 .fl |
|
34 servertool \-ORBInitialPort \fP\f4nameserverport\fP\f3 \fP\f3options\fP\f3 [ \fP\f3commands\fP\f3 ] |
|
35 .fl |
|
36 \fP |
|
37 .fi |
|
38 |
57 |
39 .LP |
58 \fBservertool\fR \-ORBInitialPort \fInameserverport\fR [ \fIoptions\fR ] [ \fIcommands \fR] |
40 .LP |
59 .fi |
41 If you did not enter a command when starting \f2servertool\fP, the command\-line tool displays with a \f2servertool >\fP prompt. Enter commands at the \f2servertool >\fP prompt. |
60 .sp |
42 .LP |
61 .TP |
43 .LP |
62 \fIoptions\fR |
44 If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool starts, runs the command, and exits. |
63 The command-line options\&. See Options\&. |
45 .LP |
64 .TP |
46 .LP |
65 commands |
47 The \f2\-ORBInitialPort\fP \f2nameserverport\fP option is \f3required\fP. The value for \f2nameserverport\fP must specify the port on which \f2orbd\fP is running and listening for incoming requests. When using Solaris software, you must become root to start a process on a port under 1024. For this reason, we recommend that you use a port number greater than or equal to 1024 for the \f2nameserverport\fP. |
66 The command-line commands\&. See Commands\&. |
48 .LP |
67 .SH DESCRIPTION |
49 .SH "DESCRIPTION" |
68 The \f3servertool\fR 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\&. |
50 .LP |
69 .SH OPTIONS |
51 .LP |
70 .TP |
52 The \f2servertool\fP provides the command\-line interface for the application programmers to register, unregister, startup, and shutdown a persistent server. Other commands are provided to obtain various statistical information about the server. |
71 -ORBInitialHost \fInameserverhost\fR |
53 .LP |
72 .br |
54 .SH "OPTIONS" |
73 This options is required\&. It specifies the host machine on which the name server runs and listens for incoming requests\&. The \f3nameserverhost\fR value must specify the port on which the \f3orb\fR is running and listening for requests\&. The value defaults to \f3localhost\fR when this option is not specified\&. If \f3orbd\fR and \f3servertool\fR are running on different machines, then you must specify the name or IP address of the host on which \f3orbd\fR is running\&. |
55 .LP |
74 |
56 .RS 3 |
75 \fINote:\fR On Oracle Solaris, you must become a root user to start a process on a port below 1024\&. Oracle recommends that you use a port number above or equal to 1024 for the \f3nameserverport\fR value\&. |
57 .TP 3 |
76 .TP |
58 \-ORBInitialHost nameserverhost |
77 -J\fIoption\fR |
59 Specifies the host machine on which the name server is running and listening for incoming requests. The \f2nameserverhost\fP defaults to \f2localhost\fP if this option is not specified. If \f2orbd\fP and \f2servertool\fP are running on different machines, you must specify the name or IP address of the host on which \f2orbd\fP is running. |
78 .br |
60 .TP 3 |
79 Passes \f3option\fR to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&. |
61 \-Joption |
80 .SH COMMANDS |
62 Pass \f2option\fP to the Java virtual machine, where \f2option\fP is one of the options described on the reference page for java(1). For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying virtual machine. |
81 You can start the \f3servertool\fR command with or without a command-line command\&. |
|
82 .TP 0.2i |
|
83 \(bu |
|
84 If you did not specify a command when you started \f3servertool\fR, then the command-line tool displays the \f3servertool\fR prompt where you can enter commands: \f3servertool >\fR\&. |
|
85 .TP 0.2i |
|
86 \(bu |
|
87 If you specify a command when you start \f3servertool\fR, then the Java IDL Server Tool starts, executes the command, and exits\&. |
|
88 .TP |
|
89 .ll 180 |
|
90 register -server \fIserver-class-name\fR -classpath \fIclasspath-to-server\fR [ -applicationName \fIapplication-name\fR -args \fIargs-to-server\fR -vmargs \fIflags-for-JVM\fR ] |
|
91 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 \f3main\fR class of the server identified by the \f3-server\fR option\&. The installation method must be \f3public static void install(org\&.omg\&.CORBA\&.ORB)\fR\&. The install method is optional and lets developers provide their own server installation behavior, such as creating a database schema\&. |
|
92 .TP |
|
93 .ll 180 |
|
94 unregister -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR |
|
95 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 \f3main\fR class of the server identified by the \f3-server\fR option\&. The \f3uninstall\fR method must be \f3public static void uninstall(org\&.omg\&.CORBA\&.ORB)\fR\&. The \f3uninstall\fR method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install\fR method\&. |
|
96 .TP |
|
97 getserverid -applicationName \fIapplication-name\fR |
|
98 Returns the server ID that corresponds to the \f3application-name\fR value\&. |
|
99 .TP |
|
100 list |
|
101 Lists information about all persistent servers registered with the ORBD\&. |
|
102 .TP |
|
103 listappnames |
|
104 Lists the application names for all servers currently registered with the ORBD\&. |
|
105 .TP |
|
106 listactive |
|
107 Lists information about all persistent servers that were started by the ORBD and are currently running\&. |
|
108 .TP |
|
109 .ll 180 |
|
110 locate -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -endpointType \fIendpointType\fR ] |
|
111 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 \f3endpointType\fR value is not specified, then the plain/non-protected endpoint associated with each ORB in a server is returned\&. |
|
112 .TP |
|
113 .ll 180 |
|
114 locateperorb -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR [ -orbid \fIORB-name\fR ] |
|
115 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 \f3orbid\fR is not specified, then the default value of \f3""\fR is assigned to the \f3orbid\fR\&. If any ORBs are created with an \f3orbid\fR of empty string, then all ports registered by it are returned\&. |
|
116 .TP |
|
117 orblist -serverid \fIserver-id\fR | -applicationName \fIapplication-name\fR |
|
118 Lists the \f3ORBId\fR of the ORBs defined on a server\&. An \f3ORBId\fR is the string name for the ORB created by the server\&. If the server is not already running, then it is activated\&. |
|
119 .TP |
|
120 shutdown -serverid \fIserver-id\fR | -applicationName application-name |
|
121 Shut down an active server that is registered with ORBD\&. During execution of this command, the \f3shutdown\fR method defined in the class specified by either the \f3-serverid\fR or \f3-applicationName\fR parameter is also called to shut down the server process\&. |
|
122 .TP |
|
123 startup -serverid \fIserver-id\fR | -applicationName application-name |
|
124 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\&. |
|
125 .TP |
|
126 help |
|
127 Lists all the commands available to the server through the \f3servertool\fR command\&. |
|
128 .TP |
|
129 quit |
|
130 Exits the \f3servertool\fR command\&. |
|
131 .SH SEE\ ALSO |
|
132 .TP 0.2i |
|
133 \(bu |
|
134 orbd(1) |
63 .RE |
135 .RE |
64 |
136 .br |
65 .LP |
137 'pl 8.5i |
66 .SH "COMMANDS" |
138 'bp |
67 .LP |
|
68 .RS 3 |
|
69 .TP 3 |
|
70 register \-server\ <server\ class\ name> \ \-classpath\ <classpath\ to\ server> [\ \-applicationName\ <application\ name> \-args\ <args\ to\ server> \-vmargs\ <flags\ to\ be\ passed\ to\ Java\ VM> \ ] |
|
71 Register a new persistent server with the Object Request Broker Daemon (ORBD). If the server is not already registered, it is registered and activated. This command causes an install method to be invoked in the main class of the server identified by the \f2\-server\fP option. The install method must be \f2public static void install(org.omg.CORBA.ORB)\fP. The install method is optional and enables the developer to provide their own server installation behavior (for example, creating database schema). |
|
72 .TP 3 |
|
73 unregister \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> |
|
74 Unregister a server from the ORBD by using either its server id or its application name. This command causes an uninstall method to be invoked in the main class of the server identified by the \f2\-server\fP option. The uninstall method must be \f2public static void uninstall(org.omg.CORBA.ORB)\fP. The uninstall method is optional and enables the developer to provide their own server uninstall behavior (for example, undoing the behavior of the install method). |
|
75 .TP 3 |
|
76 getserverid \-applicationName\ <application\ name> |
|
77 Return the server id that corresponds with an application. |
|
78 .TP 3 |
|
79 list |
|
80 List information about all persistent servers registered with the ORBD. |
|
81 .TP 3 |
|
82 listappnames |
|
83 List the application names for all servers currently registered with the ORBD. |
|
84 .TP 3 |
|
85 listactive |
|
86 List information about all persistent servers that have been launched by the ORBD and are currently running. |
|
87 .TP 3 |
|
88 locate \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-endpointType\ <endpointType>\ ] |
|
89 Locate the endpoints (ports) of a specific type for all ORBs created by a registered server. If a server is not already running, it is activated. If an endpoint type is not specified, then the plain/non\-protected endpoint associated with each ORB in a server is returned. |
|
90 .TP 3 |
|
91 locateperorb \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-orbid\ <ORB\ name>\ ] |
|
92 Locate all the endpoints (ports) registered by a specific ORB of registered server. If a server is not already running, then it is activated. If an \f2orbid\fP is not specified, the default value of "" is assigned to the \f2orbid\fP. If any ORBs are created with an \f2orbid\fP of empty string, all ports registered by it are returned. |
|
93 .TP 3 |
|
94 orblist \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> |
|
95 Lists the ORBId of the ORBs defined on a server. An ORBId is the string name for the ORB created by the server. If the server is not already running, it is activated. |
|
96 .TP 3 |
|
97 shutdown \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> |
|
98 Shutdown an active server that is registered with ORBD. During execution of this command, the \f2shutdown()\fP method defined in the class specified by either the \f2\-serverid\fP or \f2\-applicationName\fP parameter is also invoked to shutdown the server process appropriately. |
|
99 .TP 3 |
|
100 startup \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> |
|
101 Startup or activate a server that is registered with ORBD. If the server is not running, this command launches the server. If the server is already running, an error message is returned to the user. |
|
102 .TP 3 |
|
103 help |
|
104 List all the commands available to the server through the server tool. |
|
105 .TP 3 |
|
106 quit |
|
107 Exit the server tool. |
|
108 .RE |
|
109 |
|
110 .LP |
|
111 .SH "SEE ALSO" |
|
112 .LP |
|
113 orbd(1) |
|