annotate src/bsd/doc/man/servertool.1 @ 6581:cea72c2bf071

7197491: update copyright year to match last edit in jdk8 jdk repository Reviewed-by: chegar, ksrini
author alanb
date Fri, 02 Nov 2012 15:50:11 +0000
parents d45bc4307996
children
rev   line source
alanb@6581 1 ." Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
michaelm@5177 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
michaelm@5177 3 ."
michaelm@5177 4 ." This code is free software; you can redistribute it and/or modify it
michaelm@5177 5 ." under the terms of the GNU General Public License version 2 only, as
michaelm@5177 6 ." published by the Free Software Foundation.
michaelm@5177 7 ."
michaelm@5177 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
michaelm@5177 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
michaelm@5177 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
michaelm@5177 11 ." version 2 for more details (a copy is included in the LICENSE file that
michaelm@5177 12 ." accompanied this code).
michaelm@5177 13 ."
michaelm@5177 14 ." You should have received a copy of the GNU General Public License version
michaelm@5177 15 ." 2 along with this work; if not, write to the Free Software Foundation,
michaelm@5177 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
michaelm@5177 17 ."
michaelm@5177 18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
michaelm@5177 19 ." or visit www.oracle.com if you need additional information or have any
michaelm@5177 20 ." questions.
michaelm@5177 21 ."
michaelm@5177 22 .TH servertool 1 "10 May 2011"
michaelm@5177 23
michaelm@5177 24 .LP
michaelm@5177 25 .SH "Name"
michaelm@5177 26 servertool \- The Java(TM) IDL Server Tool
michaelm@5177 27 .LP
michaelm@5177 28 \f3servertool\fP provides a command\-line interface for application programmers to register, unregister, startup, and shutdown a persistent server.
michaelm@5177 29 .SH "SYNOPSIS"
michaelm@5177 30 .LP
michaelm@5177 31 .nf
michaelm@5177 32 \f3
michaelm@5177 33 .fl
michaelm@5177 34 servertool \-ORBInitialPort \fP\f4nameserverport\fP\f3 \fP\f3options\fP\f3 [ \fP\f3commands\fP\f3 ]
michaelm@5177 35 .fl
michaelm@5177 36 \fP
michaelm@5177 37 .fi
michaelm@5177 38
michaelm@5177 39 .LP
michaelm@5177 40 .LP
michaelm@5177 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.
michaelm@5177 42 .LP
michaelm@5177 43 .LP
michaelm@5177 44 If you enter a command when starting \f2servertool\fP, the Java IDL Server Tool starts, runs the command, and exits.
michaelm@5177 45 .LP
michaelm@5177 46 .LP
michaelm@5177 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.
michaelm@5177 48 .LP
michaelm@5177 49 .SH "DESCRIPTION"
michaelm@5177 50 .LP
michaelm@5177 51 .LP
michaelm@5177 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.
michaelm@5177 53 .LP
michaelm@5177 54 .SH "OPTIONS"
michaelm@5177 55 .LP
michaelm@5177 56 .RS 3
michaelm@5177 57 .TP 3
michaelm@5177 58 \-ORBInitialHost nameserverhost
michaelm@5177 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.
michaelm@5177 60 .TP 3
michaelm@5177 61 \-Joption
michaelm@5177 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.
michaelm@5177 63 .RE
michaelm@5177 64
michaelm@5177 65 .LP
michaelm@5177 66 .SH "COMMANDS"
michaelm@5177 67 .LP
michaelm@5177 68 .RS 3
michaelm@5177 69 .TP 3
michaelm@5177 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> \ ]
michaelm@5177 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).
michaelm@5177 72 .TP 3
michaelm@5177 73 unregister \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name>
michaelm@5177 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).
michaelm@5177 75 .TP 3
michaelm@5177 76 getserverid \-applicationName\ <application\ name>
michaelm@5177 77 Return the server id that corresponds with an application.
michaelm@5177 78 .TP 3
michaelm@5177 79 list
michaelm@5177 80 List information about all persistent servers registered with the ORBD.
michaelm@5177 81 .TP 3
michaelm@5177 82 listappnames
michaelm@5177 83 List the application names for all servers currently registered with the ORBD.
michaelm@5177 84 .TP 3
michaelm@5177 85 listactive
michaelm@5177 86 List information about all persistent servers that have been launched by the ORBD and are currently running.
michaelm@5177 87 .TP 3
michaelm@5177 88 locate \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-endpointType\ <endpointType>\ ]
michaelm@5177 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.
michaelm@5177 90 .TP 3
michaelm@5177 91 locateperorb \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name> [\-orbid\ <ORB\ name>\ ]
michaelm@5177 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.
michaelm@5177 93 .TP 3
michaelm@5177 94 orblist \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name>
michaelm@5177 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.
michaelm@5177 96 .TP 3
michaelm@5177 97 shutdown \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name>
michaelm@5177 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.
michaelm@5177 99 .TP 3
michaelm@5177 100 startup \-serverid\ <server\ id\ >\ | \-applicationName\ <application\ name>
michaelm@5177 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.
michaelm@5177 102 .TP 3
michaelm@5177 103 help
michaelm@5177 104 List all the commands available to the server through the server tool.
michaelm@5177 105 .TP 3
michaelm@5177 106 quit
michaelm@5177 107 Exit the server tool.
michaelm@5177 108 .RE
michaelm@5177 109
michaelm@5177 110 .LP
michaelm@5177 111 .SH "SEE ALSO"
michaelm@5177 112 .LP
michaelm@5177 113 orbd(1)