test

Service Registry 3.1 Administration Guide

Chapter 2 Using the Administration Tool

This chapter describes how to use the Administration Tool (“the Admin Tool”) for the Service Registry.

This chapter contains the following sections:

About the Admin Tool

The Service Registry Administration Tool provides a simple command-line interface for common administration tasks, such as adding associations to the Registry and removing objects from the Registry.

The tool can operate in either of two modes:

Several commands, such as ls and rm, mimic both the name and the behavior of well-known UNIX® commands that operate on files and folders. Other commands have no corresponding UNIX equivalent.

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.

Admin Tool Features

This section describes the following features of the Admin Tool:

Permissions

When you use the Admin Tool, you can perform only those actions that are allowed for the user whose key alias and password you specified when you started the tool. Only a user with the role of administrator can perform commands that make changes to objects that the user does not own. See Creating an Administrator for details.

Displaying Exceptions

The Admin Tool enables you to avoid viewing long stack traces when a command fails.

When a command fails, the Admin Tool prints the first line of the stack trace and the following message:


An error occurred when executing the function.  Use the show exception 
command to view messages.

If you need more information, execute the show exception command next to see the full stack trace.

The show exception command always displays the stack trace of the immediately preceding command.

Identifying Registry Objects

The primary way to identify registry objects is by name. However, you normally identify RegistryPackage objects by the path from the registry root to the RegistryPackage. For example, /registry/userData is the path to the userData RegistryPackage.

Some matches for names support wildcards. Use a question mark (?) to match a single character. Use an asterisk (*) to match zero or more characters.

Some commands (for example, cd and chown) support identifying objects by their Uniform Resource Name (URN), which must include a leading urn:. For example, urn:uuid:2702f889-3ced-4d49-82d1-e4cd846cb9e4 is a valid URN.

The chown and cp commands also support the use of %number to refer to a User listed by a previous users command.

For some commands, you can enter names that contain spaces by enclosing the entire name in double quotes or by preceding each space in the name by a backslash.

The select command supports the use of SQL wildcards: the percent sign (%) to match multiple characters, and the underscore (_) to match a single character.

The Effect of Locale on Specifying Names

A RegistryObject (or a RegistryPackage) can have multiple names, each of which is associated with a different locale.

The paths and object names that you specify are evaluated with respect to the current locale only. When you attempt to select by name a registry object that has multiple names, the Registry attempts to match the name that you provide against only one alternative for the registry object’s name (the choice whose locale most closely matches the current locale), not against all the multiple names for the registry object.

For example, suppose the current RegistryPackage has a member object that has two names, each associated with a different locale: red in the en (English) locale and rouge in the fr (French) locale. When the current locale is en, the command ls rouge does not display that member object, but when the locale is fr (or one of its variants), it does.

Case Sensitivity

Command names and literal parameters that are recognized by the Admin Tool are not case sensitive. For example, ls, Ls, and LS are equivalent.

Options to which you provide the value are passed literally to the code that uses the option.

Using Admin Tool Commands

The following sections describe the available commands.

For each command, the synopsis and the descriptions of the options and operands observe the following typographical conventions:

Anything else is literal text that you must include when running the command.

add association

Adds an Association object to the Registry.

Synopsis

add association -type association-type sourceURN targetURN

Description

The add association command adds an Association object of the specified type to the Registry.

You can use any of the following types:

Options

-type

The type of the Association object.

Operands

sourceURN

The URN of the source object.

targetURN

The URN of the target object.

Example

The following command (all on one line) creates a RelatedTo relationship between the objects with the two specified URNs.


admin> add association -type RelatedTo 
urn:uuid:ab80d8f7-3bea-4467-ad26-d04a40045446 
urn:uuid:7a54bbca-2131-4a49-8ecc-e7b4ac86c4fd

add user

Adds a user to the Registry.

Synopsis

add user [-edit] [-load pathname] [-firstname string] [-lastname string] [-middleName string] -alias string -keypass string [-post1.type string] [-post1.city string] [-post1.country string] [-post1.postalcode string] [-post1.stateOrProvince string] [-post1.street string] [-post2.streetNumber string] [-post2.type string] [-post2.city string] [-post2.country string] [-post2.postalcode string] [-post2.stateOrProvince string] [-post2.street string] [-post2.streetNumber string] [-post3.type string] [-post3.city string] [-post3.country string] [-post3.postalcode string] [-post3.stateOrProvince string] [-post3.street string] [-post3.streetNumber string] [-telephone1.type string] [-telephone1.areaCode string] [-telephone1.countryCode string] [-telephone1.extension string] [-telephone1.number string] [-telephone1.URL string] [-telephone2.type string] [-telephone2.areaCode string] [-telephone2.countryCode string] [-telephone2.extension string] [-telephone2.number string] [-telephone2.URL string] [-telephone3.type string] [-telephone3.areaCode string] [-telephone3.countryCode string] [-telephone3.extension string] [-telephone3.number string] [-telephone3.URL string] [-email1.type string] [-email1.address string] [-email2.type string] [-email12address string] [-email3.type string] [-email3.address string]

Description

The add user command adds a User object. A User object normally contains at least one PostalAddress, TelephoneNumber, and EmailAddress object.

Specify the information about the user either on the command line itself or by using the -load option to specify a Java property file with the information. The information options and the -load option are evaluated in the order in which they appear on the command line. For example, you can specify some properties on the command line, load others from a property file, and then override information in the property file with subsequent command-line options.

You can specify up to three addresses, telephone numbers, and email addresses for a new user. If you need more, you can add them later using the Web Console or JAXR.

When you specify an address, telephone number, or email address, you must provide a value for its type: for example, -emailType OfficeEmail.

You can use shorthand options (such as -fn) on the command line for some of the common information that is required for every user. However, you must use the longer form when you provide the information in a property file. For example, you can specify the user’s first email address on the command line using either -email1.address, -emailAddress, or -email. However, when you specify the first email address in a property file, you must use email1.address=. Because there is only one option for the user’s second email address, you must use -email2.address on the command line and email2.address= in a property file.

If you specify the -edit option, the Admin Tool launches an editor so that you can edit the new user’s information. See the option description for details.

The command creates a certificate keystore for the new user in your home directory, in the file $HOME/soar/3.0/jaxr-ebxml/security/keystore.jks. If you are running the tool as root, the home directory is either / or /root.

Note –

The property files that you load with -load or edit with -edit use the IS0-8859-1 charset, as do all Java property files. See the documentation for java.util.Properties.load(InputStream) for details on how to represent characters not in ISO-8859-1 in property files.

Options

-edit

Causes the Admin Tool to launch an editor so that you can edit the new user’s information. The tool launches the editor after evaluating the other command-line parameters. Therefore, editing starts with the result of evaluating any information that was specified on the command line or in a property file. The editing program must terminate without error before the command can continue. The Admin Tool launches the editor specified by the set editor command (see set); by default, this is the vi editor.

Note –

At this release, -edit works with emacsclient and the NetBeansTM command bin/runide.sh --open (but not very well), and has not been shown to work with vi.

-load

Specifies a Java property file whose contents specify properties for the user. The property names are the same as the long forms of the add user command options (for example, lastName and post1.type).

-fn | -firstName

Specifies the first name of a user.

-ln | -lastName

Specifies the last name (surname) of a user. The last name, which is required, must be specified either on the command line or in a property file.

-mn | -middleName

Specifies the middle name of a user.

-alias

The alias to use when accessing the user’s certificate in the keystore. This option is required. The alias must be at least three characters long.

-keypass

The password to use when accessing a user’s certificate in the keystore. This option is required. The password must be at least six characters long.

-postalType | -post1.type

The type of the first PostalAddress. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).

-city | -post1.city

The city of the first PostalAddress.

-country | -post1.country

The country of the first PostalAddress.

-postalCode | -postcode | -zip | -post1.postalcode

The postal code of the first PostalAddress.

-stateOrProvince | -state | -province | -post1.stateOrProvince

The state or province of the first PostalAddress.

-street | -post1.street

The street name of the first PostalAddress.

-streetNumber | -number | --post1.streetNumber

The street number of the first PostalAddress.

-post2.type

The type of the second PostalAddress. If a second PostalAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).

-post2.city

The city of the second PostalAddress.

-post2.country

The country of the second PostalAddress.

-post2.postalcode

The postal code of the second PostalAddress.

-post2.stateOrProvince

The state or province of the second PostalAddress.

-post2.street

The street name of the second PostalAddress.

-post2.streetNumber

The street number of the second PostalAddress.

-post3.type

The type of the third PostalAddress. If a third PostalAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).

-post3.city

The city of the third PostalAddress.

-post3.country

The country of the third PostalAddress.

-post3.postalcode

The postal code of the third PostalAddress.

-post3.stateOrProvince

The state or province of the third PostalAddress.

-post3.street

The street name of the third PostalAddress.

-post3.streetNumber

The street number of the third PostalAddress.

-phoneType | -telephone1.type

The type of the first TelephoneNumber. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.

-areaCode | -telephone1.areaCode

The area code of the first TelephoneNumber.

-countryCode | -telephone1.countryCode

The country code of the first TelephoneNumber.

-extension | -telephone1.extension

The extension of the first TelephoneNumber.

-number | -telephone1.number

The telephone number suffix, not including the country or area code, of the first TelephoneNumber. The number, which is required, must be specified either on the command line or in a property file.

-URL | -telephone1.URL

The URL of the first TelephoneNumber (the URL that can dial this number electronically).

-telephone2.type

The type of the second TelephoneNumber. If a second TelephoneNumber is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.

-telephone2.areaCode

The area code of the second TelephoneNumber.

-telephone2.countryCode

The country code of the second TelephoneNumber.

-telephone2.extension

The extension of the second TelephoneNumber.

-telephone2.number

The telephone number suffix, not including the country or area code, of the second TelephoneNumber. If a second TelephoneNumber is specified, the number, which is required, must be specified either on the command line or in a property file.

-telephone2.URL

The URL of the second TelephoneNumber (the URL that can dial this number electronically).

-telephone3.type

The type of the third TelephoneNumber. If a third TelephoneNumber is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.

-telephone3.areaCode

The area code of the third TelephoneNumber.

-telephone3.countryCode

The country code of the third TelephoneNumber.

-telephone3.extension

The extension of the third TelephoneNumber.

-telephone3.number

The telephone number suffix, not including the country or area code, of the third TelephoneNumber. If a third TelephoneNumber is specified, the number,which is required, must be specified either on the command line or in a property file.

-telephone3.URL

The URL of the third TelephoneNumber (the URL that can dial this number electronically).

-emailType | -email1.type

The type of the first EmailAddress. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.

-emailAddress | -email | -email1.address

The first email address. The first email address is required.

-email2.type

The type of the second EmailAddress. If a second EmailAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.

-email2.address

The second email address.

-email3.type

The type of the third EmailAddress. If a third EmailAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.

-email3.address

The third email address.

Examples

The following command loads the User properties from the file JaneSmith.properties in the user’s home directory.


admin> add user -load ~/JaneSmith.properties

The following command (all on one line) specifies the minimum properties that are required to create a User object.


admin> add user -ln Smith -postaltype Office -country US 
-phonetype Office -number 333-3333 -emailtype OfficeEmail 
-emailaddress JaneSmith@JaneSmith.com -alias 123 -keypass 123456

cd

Changes the RegistryPackage location.

Synopsis

cd {locator | URN}

Description

The cd command changes directory (metaphorically) to the RegistryPackage at the specified path or with the specified URN.

The command changes to a specified URN when multiple RegistryPackage objects exist with the same path (for the current locale).

Operands

locator

The path of names of registry objects from the root of the repository to an object in the repository, with each name preceded by a forward slash (/).

For example, the locator for the userData RegistryPackage that is a member of the registry RegistryPackage (which is not itself a member of any RegistryPackage) is /registry/userData. The locator for the folder1 RegistryPackage that is a member of the userData RegistryPackage is /registry/userData/folder1.

URN

The URN of the RegistryPackage, which must be a URN starting with urn:.

Examples

The following command changes the directory to the RegistryPackage with the URN urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017.


admin> cd urn:uuid:92d3fd01-a929-4eba-a5b4-a3f036733017

The following command changes the directory to the location /registry/userData/myData.


admin> cd /registry/userData/myData

chown

Changes the owner of a RegistryObject.

Synopsis

chown {URN | %index}

Description

The chown command changes the ownership of the objects selected with a preceding select command to the user specified either by the URN or by the reference to the user’s URN that was listed by a preceding users command.

Only a user with the role of administrator can execute this command successfully.

Operands

URN

The User object specified by the URN.

%index

A numerical reference to a URN for a User object listed in a preceding users command.

Examples

The following command changes the ownership of the selected objects to the user specified by the URN urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079.


admin> chown urn:uuid:26aa17e6-d669-4775-bfe8-a3a484d3e079

The following command changes the ownership of the selected objects to the user with the number 2 in a preceding users command.


admin> chown %2

See Also

cp

Copies files and folders into the Registry.

Synopsis

cp [-owner {URN | %index}] [-exclude pattern]… [-include pattern]… pattern…

Description

The cp command copies folders and files into the Registry as RegistryPackage and ExtrinsicObject objects, respectively.

The local directory on the local file system from which to copy files and folders defaults to the current directory from which you started the Admin Tool. You can use the -localdir option to change the local directory when you start the Admin Tool. You can use the lcd command to change the local directory after the Admin Tool has started. You can get the absolute path of the current local directory by using the show localdir command.

The command is recursive. That is, if you specify a directory, the command copies all the files and folders under the directory.

Options

-owner

Sets the owner of the copied registry objects to the user specified by the URN or %index argument. See the description of the chown command for a description of these arguments. You must have the role of administrator to specify an owner other than yourself.

-exclude

Copies all files except those whose names contain the specified pattern, where pattern is a pattern comprising literal characters and the special characters asterisk (*) (representing zero or more characters) and question mark (?) (representing one and only one character).

You can specify this option more than once.

-include

Copies all files whose names contain the specified pattern, where pattern is a pattern comprising literal characters and the special characters asterisk (*) (representing zero or more characters) and question mark (?) (representing one and only one character).

You can specify this option more than once.

Operands

pattern

The files or folders to be copied, specified by a pattern comprising literal characters and the special characters asterisk (*) (representing zero or more characters) and question mark (?) (representing one and only one character). You can specify more than one pattern.

Examples

The following command copies the directory mydir to the Registry, to be owned by the user with the number 4 in a preceding users command.


admin> cp -owner %4 mydir

The following command copies the directory mydir to the Registry, excluding files and directories that end with the string .z or .c.


admin> cp mydir -exclude \\.z -exclude \\.c

See Also

echo

Echoes a string.

Synopsis

echo string

Description

The echo command echoes the specified string to the output. This command is most useful when you specify it in the -command option when you run the Admin Tool in batch mode.

Operand

string

A sequence of characters.

Example

The following command prints the date and the result of the ls command into a log file.


java -jar admin-tool.jar -command "echo ”date”; ls" > admin.log

help

Displays information about commands.

Synopsis

help [command_name]

Description

The help command displays information about the available commands or a specified command.

For commands with subcommands, such as add and show, the help command displays information about the subcommands.

If you do not specify an argument, the help command displays usage information for all commands.

Operand

command_name

The name of an Admin Tool command.

Examples

The following command displays usage information for all commands.


admin> help

The following command displays usage information for the lcd command.


admin> help lcd

The following command displays usage information for the add subcommands.


admin> help add

import

Imports an XML file that defines registry objects.

Synopsis

import [ {-a | --attach} pathname, mimeType, id]… submitObjectsRequest

Description

The import command adds one or more new objects or repository items to the Registry by submitting an XML file that conforms to the SubmitObjectsRequest protocol as described in the ebXML Registry Services and Protocols Version 3.0 specification.

The XML file and any attachments provided form the content of a SOAP message sent to the Registry and handled there. This operation is thus very low-level and is provided for those most familiar with the ebXML specifications.

Option

-a | --attach

Attaches a file as the repository item for an extrinsic object. The pathname is the path name of the file to be added. The mimeType specifies the MIME type of the file. The id is the unique identifier of the extrinsic object for which this is the repository item (??). You can specify this option more than once.

Operand

submitObjectsRequest

An XML file that contains definitions of registry objects.

Examples

The following command imports a group of objects defined in the file MyRequest.xml:


admin> import MyRequest.xml

The following command (all on one line) imports an extrinsic object and its repository item, an image file:


admin> import --attach chicken.jpg, image/jpeg, urn:bird:poultry:chicken 
ChickenRequest.xml

keystoreMover

Exports one or more keys from one keystore format to another.

Synopsis

keystoreMover [-sourceKeystoreType {JKS | PKCS12}] -sourceKeystorePath pathname -sourceKeystorePassword password [-sourceAlias alias [-sourceKeyPassword password]] [-destinationKeystoreType {JKS | PKCS12}] -destinationKeystorePath pathname -destinationKeystorePassword password [-destinationAlias newAlias ] [-destinationKeyPassword password]

Description

The developer interface to the Registry requires the use of a JKS keystore, while the Web Console requires a PKCS12 or DER certificate that you can import into a web browser.

If you created a user account using a registry-generated PKCS12 certificate and you wish to use the Admin Tool to publish content to the Registry, use the keystoreMovercommand to export the certificate to a JKS keystore. You can also use this command in order to run developer applications against the Registry.

If you created a user with the add user command and you want that user to be able to use the Web Console, you can use this command to export the JKS keystore created by add user to the PKCS12 format.

See Creating a User Account in Service Registry 3.1 User’s Guide for details on using the Web Console to create a user account. See Using the Admin Tool to Publish Content to the Registry for information on using the keystoreMover in conjunction with the Admin Tool. See add user for information on using the add user command.

See Service Registry 3.1 Developer’s Guide for information on developing applications for the Registry.

Options

-sourceKeystoreType

Specifies the type of the keystore to be exported. Argument must be either PKCS12 or JKS. The default is PKCS12.

-sourceKeystorePath

Specifies the path name of the file that contains the source keystore. This option is required. Normally, this is the path name of the certificate file created when you created a user.

-sourceKeystorePassword

Specifies the password for the source keystore. Normally, this is the password you specified when you created a user. This option is required.

-sourceAlias

Specifies the alias to be exported. If you do not specify this option, the command exports all aliases in the keystore. The keystore downloaded from the Web Console contains only one alias.

-sourceKeyPassword

Specifies the password specific to the alias (as opposed to the keystore password). If you do not specify this option, the password is the same as the keystore password (this is the usual case).

-destinationKeystoreType

Specifies the type of the destination keystore. Argument may be either JKS or PKCS12. The default is JKS.

-destinationKeystorePath

Specifies the path name of the file that will contain the destination keystore. This option is required. Normally, this argument is HOME/soar/3.0/jaxr-ebxml/security/keystore.jks, where HOME is the user's home directory.

-destinationKeystorePassword

Specifies the password for the destination keystore. This argument is required. The default value of this property is ebxmlrr.

-destinationAlias

Specifies the new alias name, if you want to rename the alias. If you do not specify this option, the new alias has the same name as the alias of the source certificate.

-destinationKeyPassword

Specifies the password specific to the alias (as opposed to the keystore password). If you do not specify this option, the password is the same as the keystore password (this is the usual case).

Note –

All passwords must be at least 6 characters in length.

Example

The following command exports the certificate in generated-key.p12 in a user's home directory to a JKS keystore in soar/3.0/jaxr-ebxml/security/keystore.jks, also in the user's home directory. The source keystore password is the one provided when the user registered with the Registry. The destination keystore password is the default value of ebxmlrr. Specify the command all on one line.


admin> keystoreMover -sourceKeystorePath /home/myname/generated-key.p12 
-sourceKeystorePassword mypass -destinationKeystorePath 
/home/myname/soar/3.0/jaxr-ebxml/security/keystore.jks 
-destinationKeystorePassword ebxmlrr

lcd

Changes the current directory on the local file system.

Synopsis

lcd [pathname]

Description

The lcd command changes the current local directory on the local file system.

If you do not specify an argument, the lcd command changes the current directory to your default home directory.

Operand

pathname

A directory name, which can be absolute or relative.

Examples

The following command changes the current local directory to the /usr/share directory.


admin> lcd /usr/share

The following command changes the current local directory to your default home directory on the local file system.


admin> lcd

ls

Lists the objects in the current RegistryPackage.

Synopsis

ls [ {pattern | URN}…]

Description

With no arguments, the ls command lists the objects in the current RegistryPackage. When a pattern or URN is provided, the command lists the objects in the current RegistryPackage whose names (in the current locale) or unique identifiers match pattern or URN.

Operands

pattern

A pattern comprising literal characters and the special characters asterisk (*) (representing zero or more characters) and question mark (?) (representing one and only one character). You can specify more than one pattern.

URN

A URN starting with urn:, for example, urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd. You can specify more than one URN. The URN must be the unique identifier of the object, not the logical identifier.

Examples

The following command lists all the objects in the current RegistryPackage.


admin> ls

The following command lists all the objects whose name matches the pattern urn:bird:poultry:chicken or whose ID is urn:bird:poultry:chicken.


admin> ls urn:bird:poultry:chicken

The following command lists all the objects whose name matches the pattern *bird*. (It would also list the objects whose ID is *bird*, if *bird* were a valid ID.)


admin> ls *bird*

The following command lists all the objects whose name matches the pattern *bird* or whose name matches the pattern urn:bird:poultry:chicken or whose ID is urn:bird:poultry:chicken.


admin> ls *bird* urn:bird:poultry:chicken

pwd

Displays the path to the current RegistryPackage.

Synopsis

pwd

Description

The pwd command displays the path (or paths) to the current RegistryPackage using the best-matching names for the current locale. The command also displays the locale for the path.

Example


admin> pwd
(en_US) /registry/userData

quit

Exits the Admin Tool.

Synopsis

quit

Description

The quit command exits the Admin Tool.

Example


admin> quit

rm

Removes objects from a RegistryPackage.

Synopsis

rm [-d] [-r] {pattern | URN}…

Description

The rm command removes the member objects of the current RegistryPackage whose names (in the current locale) match the patterns specified by a pattern or URN.

When a matching RegistryObject is a member of multiple RegistryPackage objects, this command removes only the association between the current RegistryPackage and the object. The object is removed from the Registry only when the removal of the association leaves the object with no association with any other RegistryObject, including other containing RegistryPackage objects.

When a matching member object is itself a RegistryPackage that contains other objects, neither the object nor the association between the current RegistryPackage and the member RegistryPackage is removed unless either the -r or the -d option is specified.

When both the -d and -r options are specified, the -d option is applied recursively, so all objects that would be selected by -r (and their associations) are removed whether or not they have other associations.

Options

-d

Removes the association between the current RegistryPackage and the specified RegistryPackage. Removes the specified RegistryPackage only if its only remaining associations are to its member objects. Member objects of the now-removed RegistryPackage that are not anchored by being the target of other HasMember associations are now accessible as members of the root of the Registry.

-r

Removes the specified RegistryPackage object and all its descendant objects (except when an object has other associations).

Operands

pattern

A pattern comprising literal characters and the special characters asterisk (*) (representing zero or more characters) and question mark (?) (representing one and only one character). You can specify more than one pattern.

URN

A URN starting with urn:, for example, urn:uuid:4a6741e7-4be1-4cfb-960a-e5520356c4fd. You can specify more than one URN.

Examples

The following command removes all RegistryPackage objects that contain the string "stat" and all their descendants.


admin> rm -r *stat*

select

Executes an SQL select statement.

Synopsis

select [SQL]

Description

The select command selects and lists the objects that are specified by evaluating the entire command as an SQL query. If no argument is specified, the command lists any objects selected by a preceding select command or by the -sqlselect option.

Operand

SQL

An SQL select statement (without the leading select because that is already present as the name of the command).

Examples

The following command lists all ClassificationScheme objects in the Registry:


admin> select s.* from ClassificationScheme s

set

Sets a property value.

Synopsis

set property value

Description

The set command sets the value of a property of the Admin Tool shell.

The tool supports the following properties and values.

set debug {true | on | yes | false | off | no}

Enables or disables output of debugging messages.

set editor string

Sets the command to use when the Admin Tool launches an interactive editor. The default value is /bin/vi on UNIX and Linux systems.

set verbose {true | on | yes | false | off | no}

Enables or disables output of more verbose messages when executing commands.

Operands

property

One of the following properties: debug, editor, verbose.

value

A supported value of the specified property. See the Description section for details.

Examples

The following command sets the editor to /usr/bin/vi instead of the default /bin/vi.


admin> set editor /usr/bin/vi

The following command turns on debugging.


admin> set debug true

The following command turns off verbose output.


admin> set verbose off

show

Displays a property value.

Synopsis

show [property]

Description

The show command displays the value of a property of the Admin Tool shell.

If no argument is specified, the command displays the values of all properties.

The command supports the following properties:

debug

Whether or not debugging output is enabled.

editor

The editor to use when the Admin Tool launches an interactive editor.

exception

The exception stack trace, if any, from the immediately preceding executed command.

localdir

The current directory on the local file system. Use the lcd command to set this property. See lcd for details.

locale

The current locale.

verbose

Whether or not verbose output is enabled.

Operands

property

The property whose current value is to be displayed. The properties exception and locale can be displayed, but you cannot use the set command to set them.

Example

The following command displays the exceptions from the previous command.


admin> show exception

users

Lists the current User objects.

Synopsis

users

Description

The users command lists the User objects currently in the Registry.

The output has the following format:


%index: URN lastname, firstname middlename

In the output, the index is a numeric value that you can use, including the percent sign (%), to refer to a user when you run the chown or cp command. The lastname, firstname, and middlename are the last, first, and middle names of the user.

Example

The following command displays the current users:


admin> users
%0:  urn:freebxml:registry:predefinedusers:registryoperator  Operator, Registry 
%1:  urn:freebxml:registry:predefinedusers:registryguest  Guest, Registry 
%2:  urn:freebxml:registry:predefinedusers:farrukh  Najmi, Farrukh Salahudin
%3:  urn:freebxml:registry:predefinedusers:nikola  Stojanovic, Nikola 
%4:  urn:uuid:799cc524-b7cd-4e51-8b34-d93b79ac52de  User, Test 
%5:  urn:uuid:85428d8e-1bd5-473b-a8c8-b9d595f82728  Parker, Miles

See Also