Service Registry 3.1 Administration Guide

Starting the Admin Tool

To start the Admin Tool, you execute the admin-tool.jar file:


java java-options -jar ServiceRegistry-base/lib/admin-tool.jar [admin-tool-options]...

The java command is normally in the directory /usr/jdk/entsys-j2se/bin.

The ServiceRegistry-base location is /opt/SUNWsrvc-registry on Solaris OS and /opt/sun/srvc-registry on Linux and HP-UX systems.

You can safely ignore the warnings that appear when you start the tool.

To exit the Admin Tool, use the quit command.

Batch Mode

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.

Interactive Mode

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>

Admin Tool Command-line Options

The Admin Tool recognizes the command-line options that are listed in Synopsis and described in Options.

Synopsis

[-alias alias] [-command commands] [-debug] [-help] [-keypass keypass] [-localdir localdir] [-locale locale] [-registry url] [-root locator [-create]] [-sqlselect SQL-statement] [-verbose]

Options

-alias

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. This option is required if you will use the Admin Tool to publish data to the Registry.

-command

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.

-create

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.

-debug

Outputs extra information that is useful when debugging.

-help

Provides a list of these options.

-keypass

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. This option is required if you will use the Admin Tool to publish data to the Registry.

-localdir

The base directory in the local file system for commands that relate to files in the local file system.

-locale

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).

-registry

The URL of the ebXML registry to which to connect. The default is http://localhost:6480/soar/registry/soap.

-root

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.

-sqlselect

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.

-v | -verbose

Specifies the verbose output of status messages.


Note –

The output of the -help option lists two options that are not supported in this release: -class and -property.


Using the Admin Tool to Publish Content to the Registry

Some Admin Tool commands allow you to publish content to the Registry: cp and import, for example. In addition, the rm command allows you to delete content from the Registry. Before you can use these commands, you must perform some additional steps.

ProcedureTo Enable Yourself to Publish Content to the Registry

  1. Perform user registration as described in Creating a User Account in Service Registry 3.1 User’s Guide.

    Remember the location of the PKCS12 certificate you downloaded, as well as the user name and password you specified.

  2. Start the Admin Tool:


    java -jar ServiceRegistry-base/lib/admin-tool.jar
    
  3. Execute the keystoreMover command to export your PKCS12 certificate to a JKS keystore. See keystoreMover for details.

    Typically, you need to specify only the four options shown in the command example.

  4. Stop the Admin Tool:


    quit
    
  5. Start the Admin Tool again. This time, specify options as follows:


    java -Djaxr-ebxml.security.storetype=JKS \
    -Djaxr-ebxml.security.keystore=security/filename \
    -Djaxr-ebxml.security.storepass=ebxmlrr \
    -jar ServiceRegistry-base/lib/admin-tool.jar -alias alias -keypass password
    

    Here, filename is the name of your certificate file, which is normally keystore.jks. The location security/filename is relative to the directory $HOME/soar/3.0/jaxr-ebxml. The alias and password values are the ones you specified when you created a user account.

    To save typing, create a script to execute this command.