servertool(1)

✨ NAME ✨

servertool — bestie, this is your cute lil' easy-to-use interface that lets developers register, unregister, start up, and shut down a persistent server. Yes, all of that, from one lil command line. Iconic. 💅

This one lives in the Java IDL and RMI-IIOP Tools family, manual section 1, iykyk. 🦋

🌸 SYNOPSIS 🌸

servertool -ORBInitialPort nameserverport [ options ] [ commands ]

• options — the command-line options. Go peek at OPTIONS below, babes. ✨
• commands — the command-line commands. Go peek at COMMANDS below. 💖

🎀 DESCRIPTION 🎀

So the servertool command hands you the command-line interface that developers use to register, unregister, start up, and shut down a persistent server. And because that wasn't enough slay, the command-line commands also let you pull various statistical information about the server. Head to COMMANDS for the whole menu. 👑

💅 OPTIONS 💅

• -ORBInitialHost nameserverhost — okay so this one is required, no skipping it (the page says "This options is required," and yes we all noticed the typo, we're moving on 🫶). It tells you the host machine where the name server runs and listens for incoming requests. The nameserverhost value has to specify the port on which the orb is running and listening for requests. When this option isn't specified, the value defaults to localhost. And listen: if orbd and servertool are running on different machines, then you must specify the name or IP address of the host where orbd is running. No shortcuts. 🚫

Note: on Oracle Solaris, you have to become a root user to start a process on a port below 1024. Oracle recommends using a port number above or equal to 1024 for the nameserverport value. Protect your peace (and your ports). 💀

• -Joption — passes option to the Java Virtual Machine, where option is one of the options described on the reference page for the Java application launcher. For example, -J-Xms48m sets the startup memory to 48 MB. See java(1). ✨

👑 COMMANDS 👑

You can start the servertool command with or without a command-line command. Two moods:

• If you did not specify a command when you started servertool, then the command-line tool displays the servertool prompt where you can enter commands: servertool >. 🫧
• If you do specify a command when you start servertool, then the Java IDL Server Tool starts, executes the command, and exits. Main character energy: arrives, does the thing, leaves. 💨

• 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 isn't already registered, then it gets registered and activated. This command makes an installation method get called in the main class of the server identified by the -server option. That installation method must be public static void install(org.omg.CORBA.ORB). It's optional, and it's there so developers can provide their own server installation behavior — like creating a database schema. Fancy. 🎀
• unregister -serverid server-id | -applicationName application-name — unregisters a server from the ORBD using either its server ID or its application name. This command makes an uninstallation method get called in the main class of the server identified by the -server option. That uninstall method must be public static void uninstall(org.omg.CORBA.ORB). It's optional too, and it lets developers provide their own server uninstallation behavior — like undoing whatever the install method did. It's giving ✨balance✨.
• getserverid -applicationName application-name — returns the server ID that corresponds to the application-name value. It's the "who dis" of commands. 🙈
• list — lists information about all persistent servers registered with the ORBD. The full roster. 📋
• listappnames — lists the application names for all servers currently registered with the ORBD. Name-drop them all, bestie. 💖
• listactive — lists information about all persistent servers that were started by the ORBD and are currently running. Only the ones still up and thriving. 🔥
• 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 isn't already running, then it gets activated. If no endpointType value is specified, then you get back the plain/non-protected endpoint associated with each ORB in a server. Default behavior, no cap. ✨
• locateperorb -serverid server-id | -applicationName application-name [ -orbid ORB-name ] — locates all the endpoints (ports) registered by a specific Object Request Broker (ORB) of a registered server. If the server isn't already running, then it gets activated. If an orbid isn't specified, then the default value of "" is assigned to the orbid. And if any ORBs were created with an orbid of empty string, then all ports registered by it are returned. Sneaky but valid. 🦋
• orblist -serverid server-id | -applicationName application-name — 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 isn't already running, then it gets activated. Name tag moment. 🏷️
• shutdown -serverid server-id | -applicationName application-name — shuts down an active server that's registered with ORBD. During execution of this command, the shutdown method defined in the class specified by either the -serverid or -applicationName parameter is also called to shut down the server process. Going to bed, respectfully. 😴
• startup -serverid server-id | -applicationName application-name — starts up or activates a server that's registered with ORBD. If the server isn't running, then this command starts it. If the server is already running, then an error message is displayed. No double-starting, bestie, it's not that kind of party. 🚫
• help — lists all the commands available to the server through the servertool command. Your safety net. 🫶
• quit — exits the servertool command. Byeeee. 👋

🌈 SEE ALSO 🌈

• orbd(1) — the whole other half of this duo, go say hi. 💜

okay that's literally the whole page, no skips, no crumbs left behind ✨ This was the JDK 8 version, dated 21 November 2013 — shoutout to that era, it ate and left no notes. Stay slaying, server bestie 💖🌸💅