To start the Admin Tool, you execute the admin-tool.jar file:
java -jar ServiceRegistry-base/lib/admin-tool.jar [options]... |
The ServiceRegistry-base location is /opt/SUNWsoar in the Solaris operating environment and /opt/sun/SUNWsoar on Linux systems.
Ignore the warnings that appear when you start the tool; they are not significant.
To exit the Admin Tool, use the quit command.
To perform commands restricted to administrators, you need to specify the type, location, and password of your certificate file (that is, your keystore) on the command line as follows (all on one line):
java -Djaxr-ebxml.security.storetype=PKCS12 \ -Djaxr-ebxml.security.keystore=security/filename.p12 \ -Djaxr-ebxml.security.storepass=password -jar admin-tool.jar |
Here, filename is the root name of your certificate file (by default, generated-key), and password is the password you specified to protect this file when you created your certificate. The location security/filename.p12 is relative to the directory $HOME/soar/3.0/jaxr-ebxml.
To save typing, create a script to execute this command.
To run the Admin Tool in batch mode, specify the -command option on the command line when you start the Admin Tool.
For example, the following command executes the ls command:
java -jar ServiceRegistry-base/lib/admin-tool.jar -command "ls *.html" |
The Admin Tool echoes your commands and the tool’s responses to the screen and then exits after your commands have been executed.
Make sure that you properly escape any characters that are significant to your shell.
To run the Admin Tool in interactive mode, start the Admin Tool shell by specifying any options other than -command (or no options) on the command line:
java -jar ServiceRegistry-base/lib/admin-tool.jar |
The Admin Tool displays the following prompt and waits for your input:
admin> |
The Admin Tool recognizes the command-line options that are listed in Synopsis and described in Options.
The alias to use when accessing the user’s certificate in the keystore. Specify the alias that you used when you registered as a user.
The Admin Tool command sequence to run instead of getting commands from the interactive shell. Use a semicolon (;) to separate multiple commands. You do not have to include a quit command in commands. If you need to use a semicolon that is not a command separator, precede the semicolon by a backslash:
\; |
The shell in which you run the Admin Tool might require you to escape the backslash with a second backslash:
\\; |
If any command contains spaces, enclose the entire command sequence in single or double quotes so that the tool will treat the sequence as one command-line parameter instead of several. If your shell also interprets a semicolon as separating shell commands, you always have to put sequences of multiple Admin Tool commands in quotation marks.
If necessary, create the RegistryPackage specified by the -root option as well as any parent RegistryPackage objects as needed. This option is valid only if the user who is running the Admin Tool is authorized to create objects.
Outputs extra information that is useful when debugging.
Provides a list of these options.
The password to use when accessing a user’s certificate in the keystore. Specify the password that you used when you registered as a user.
The base directory in the local file system for commands that relate to files in the local file system.
The locale (for example, en or fr) to use for selecting the resource bundle to use for error and status messages. The default is determined by the Java Virtual Machine (JVM).
The URL of the ebXML registry to which to connect. The default is http://localhost:6060/soar/registry/soap.
The locator (for example, /registry/userData) of the RegistryPackage to use as the base for those commands that treat the repository as a tree of RegistryPackage objects that each contain other RegistryObject and RegistryPackage objects. The default is the RegistryPackage that is defined for all users’ data: /registry/userData.
Execute SQL_statement to select registry objects. The statement should be a complete SQL statement that starts with select. The SQL statement must be enclosed in quotation marks, but it does not have to be terminated by a semicolon. If you specify this option and then use the select command with no argument, the command will execute SQL_statement until you use the select command with an argument other than SQL_statement.
Specifies the verbose output of status messages.
The output of the -help option lists two options that are not supported in this release: -class and -property.