Package org.apache.sis.console

Class AboutCommand

java.lang.Object

org.apache.sis.console.CommandRunner

org.apache.sis.console.AboutCommand

final class AboutCommand
extends CommandRunner

The "about" subcommand. By default this sub-command prints all information except the About.LIBRARIES section, because the latter is considered too verbose. Available options are:

• --brief: prints only Apache SIS version number.
• --verbose: prints all information including the libraries.

About SIS installation on a remote machine

This sub-command can provide information about SIS installation on a remote machine, provided that remote access has been enabled at the Java Virtual Machine startup time. See org.apache.sis.console package javadoc for more information.

Since:

0.3

Version:

0.8

Field Summary

Fields inherited from class org.apache.sis.console.CommandRunner

colors, commandName, debug, encoding, err, files, instance, locale, options, out, outputBuffer, TEST, timezone

Constructor Summary

Constructors

Constructor	Description
AboutCommand(int commandIndex, String... arguments)	Creates the "about" sub-command.

Method Summary

Modifier and Type	Method	Description
int	run()	Prints the information to the output stream.
(package private) static String	toRemoteURL(String host)	Creates a "service:jmx:rmi:///jndi/rmi://host:port/jmxrmi" URL for the given host name.

Methods inherited from class org.apache.sis.console.CommandRunner

canNotOpen, error, hasContradictoryOptions, hasUnexpectedFileCount, help, useStandardInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AboutCommand

AboutCommand(int commandIndex,
 String... arguments)
      throws InvalidOptionException

Creates the "about" sub-command.

Parameters:

commandIndex - index of the arguments element containing the "about" command name, or -1 if none.

arguments - the command-line arguments provided by the user.

Throws:

InvalidOptionException - if an illegal option has been provided, or the option has an illegal value.

Method Details

run

public int run()
        throws Exception

Prints the information to the output stream.

Specified by:

run in class CommandRunner

Returns:

0 on success, or an exit code if the command failed for a reason other than an uncaught Java exception.

Throws:

Exception - if an error occurred while executing the sub-command.

toRemoteURL

static String toRemoteURL(String host)

Creates a "service:jmx:rmi:///jndi/rmi://host:port/jmxrmi" URL for the given host name. The host name can optionally be followed by a port number.