Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
This code is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 only, as
published by the Free Software Foundation.
This code is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
version 2 for more details (a copy is included in the LICENSE file that
accompanied this code).
You should have received a copy of the GNU General Public License version
2 along with this work; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
or visit www.oracle.com if you need additional information or have any
questions.
Arch: generic
Software: JDK 8
Date: 21 November 2013
SectDesc: Java IDL and RMI-IIOP Tools
Title: servertool.1
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
servertool -ORBInitialPort nameserverport [ options ] [ commands ]
options The command-line options. See Options.
commands The command-line commands. See Commands.
-ORBInitialHost nameserverhost
This options is required. It specifies the host machine on which the name server runs and listens for incoming requests. The \f3nameserverhost value must specify the port on which the \f3orb is running and listening for requests. The value defaults to \f3localhost when this option is not specified. If \f3orbd and \f3servertool are running on different machines, then you must specify the name or IP address of the host on which \f3orbd is running. Note: 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 value.
-Joption
Passes \f3option to the Java Virtual Machine, where \f3option is one of the options described on the reference page for the Java application launcher. For example, \f3-J-Xms48m sets the startup memory to 48 MB. See java(1).
0.2i If you did not specify a command when you started \f3servertool, then the command-line tool displays the \f3servertool prompt where you can enter commands: \f3servertool >.
0.2i If you specify a command when you start \f3servertool, 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 \f3main class of the server identified by the \f3-server option. The installation method must be \f3public 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 \f3main class of the server identified by the \f3-server option. The \f3uninstall method must be \f3public static void uninstall(org.omg.CORBA.ORB). The \f3uninstall method is optional and lets developers provide their own server uninstallation behavior, such as undoing the behavior of the \f3install method.
getserverid -applicationName application-name Returns the server ID that corresponds to the \f3application-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 \f3endpointType 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 \f3orbid is not specified, then the default value of \f3"" is assigned to the \f3orbid. If any ORBs are created with an \f3orbid of empty string, then all ports registered by it are returned.
orblist -serverid server-id | -applicationName application-name Lists the \f3ORBId of the ORBs defined on a server. An \f3ORBId 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 \f3shutdown method defined in the class specified by either the \f3-serverid or \f3-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 \f3servertool command.
quit Exits the \f3servertool command.
0.2i orbd(1)
'pl 8.5i 'bp