UDDI Utility Tools at a command prompt

We can start UDDI Utility Tools at a command prompt. In some situations, there are prerequisites before running the command.

Ensure that we are using the correct level of Java code by setting the PATH statement to include the Java code supplied with WebSphere Application Server. For example, from the command line, type:(Windows)

set PATH=app_server_root\java\bin;%PATH%

(UNIX) (ZOS)

export PATH=app_server_root/java/bin:$PATH

(UNIX) For DB2 on the UNIX or Linux operating systems, before we use the command to start UDDI Utility Tools, run the db2profile script. The db2profile script is in the DB2 instance home directory under sqllib. To invoke the script, type the following. Notice that a single space character follows the period (.).

. /$DB2_HOME/db2profile

The DB2 user must have a db2profile at $HOME/sqllib/db2profile.

Using one of the following approaches to start UDDI Utility Tools:

• Enter the following command and use a specified properties file that sets up class path and other parameters:

  java - jar UDDIUtilityTools.jar {function} [options]
  

  Before we run UDDIUtilityTools.jar from the command line, ensure that you edit the UDDIUtilityTools.properties file. If we save this properties file in a different directory from the UDDIUtilityTools.jar file, specify the location of the properties file as part of the command line arguments.

• Enter the following command, where CommandLineProcessor is the class that processes command line arguments for UDDI Utility Tools, sets up the configuration and invokes the appropriate function:

  java CommandLineProcessor
  

Usage of UDDIUtilityTools.jar:

java -jar UDDIUtilityTools.jar {function} [options]

Functions:

  -promote <entity source>   Promote entities between registries
  -export <entity source>    Extract entities from a registry to XML
  -delete <entity source>    Delete entities from a registry
  -import                    Create entities from XML to a registry

where <entity source> is one of:
  -tmodel|-business|-service|-binding <key> Specify a single entity type and key
  -keysFile | -f <filename>  Specify a file containing entity types and keys

Options:

  -properties <filename>     Path to a configuration file
  -overwrite | -o            Overwrite an entity if it already exists
  -log | -v                  Output verbose messages
  -definitionFile <filename> Path to a UDDI entity definition file
  -importReferenced          Import entities referenced by source entities

The following command-line options override property settings in the configuration file:

• overwrite
• log
• definitionFile
• importReferenced

Examples

The following examples use the Windows operating systems file system.

java -jar UDDIUtilityTools.jar -promote -keysFile (Dist) C:/uddikeys.txt

Export a single business to the entity definition file specified in a properties file in the current directory.

java -jar UDDIUtilityTools.jar -export 
-business 28B8B928-2B2E-4EC9-A647-1E40651E4752

Export a single business to the entity definition file specified in a properties file in the current directory and use a keys file to specify the entities to export.

java -jar UDDIUtilityTools.jar -export -keysFile (Dist) C:/myKeyFiles/keyFile01.txt

Export a single business to the entity definition file specified in a properties file in the current directory and use a keys file to specify the entities to export. Also, display verbose output on the command line.

java -jar UDDIUtilityTools.jar -export -keysFile (Dist) C:/myKeyFiles/keyFile02.txt -v

Import the contents of the default entity definition file specified in a UDDIUtilityTools.properties file in the current directory.

java -jar UDDIUtilityTools.jar -import

Import the contents of the default entity definition file specified in a UDDIUtilityTools.properties file in the current directory and import referenced tModel entities into the target registry.

java -jar UDDIUtilityTools.jar -import -importReferenced

Import the entities from an entity definition file at the specified location.(Dist) Note the use of forward slashes even though this is an example on a Windows operating systems file system.

java -jar UDDIUtilityTools.jar -import -definitionFile (Dist) C:/myEDFs/entities01.xml

Import the entities from the default entity definition file including referenced tModel entities. The overwrite options specifies any entities, excluding referenced tModel entities that are found in the target registry, are overwritten.

java -jar UDDIUtilityTools.jar -import -overwrite -importReferenced

Promote a single service from a source to a target registry using the properties file at a specified location.

java -jar UDDIUtilityTools.jar -promote 
-service 67961D67-330F-4F14-8210-E74A58E710F3 
-properties (Dist) C:/UUT/myUUTProps.properties

Promote a set of entities specified in a keys file.

java -jar UDDIUtilityTools.jar -promote -keysFile (Dist) C:/myKeyFiles/keyFile03.txt

Promote a set of entities specified in a keys file and overwrite existing entities in the target registry.

java -jar UDDIUtilityTools.jar -promote -keysFile (Dist) C:/myKeyFiles/keyFile04.txt 
-overwrite

Promote a set of entities specified in a keys file, including referenced tModel entities.

java -jar UDDIUtilityTools.jar -promote -keysFile (Dist) C:/myKeyFiles/keyFile05.txt 
-importReferenced

Promote a set of entities that is specified in a keys file, but also create an entity definition file containing the promoted entities.

java -jar UDDIUtilityTools.jar -promote -keysFile (Dist) C:/myKeyFiles/keyFile06.txt 
-definitionFile (Dist) C:/myEDFs/entities02.xml

Logically delete a single tModel entity. We cannot physically delete tModel entities.

java -jar UDDIUtilityTools.jar -delete 
-tModel UUID:1E2B9D1E-E53D-4D36-9D46-6CCC176C466A

Delete all the entities specified in the keys file. Except for tModel entities, all other entities are physically deleted from the target registry.

java -jar UDDIUtilityTools.jar -delete -keysFile (Dist) C:/myKeyFiles/keyFile04.txt

A keys file example

The following example shows the keys to export, promote, or delete from the target registry:

#
# Keys of entities to be exported, promoted from source registry or deleted 
# from target registry
#
# Note: keys must be comma separated and on SAME line
# Note: property names are case sensitive. ('tmodels=' are ignored)

businesses=97C77097-AC6C-4CA0-A6C4-452F7045C470, 
4975E949-581F-4FCA-AD5F-E08280E05F9F
services=BB3864BB-1578-4833-8179-14391F14791F
bindings=
tModels=273F1727-7BFF-4FB5-A1FD-BA5C45BAFD9C

If the importReferenced property is set to true, the list of tModel entities in the referencedTModels section is imported to the target registry. If the referencedTModel is new, minimal entities are created. If the referencedTModel already exists, it is never overwritten, regardless of the overwrite property value. This approach prevents commonly referenced tModel entities, such as categorization tModel entities, from being updated unnecessarily.

To update a referencedTModel, we must manually move the referencedTModel definition to the tModel entities section in the entity definition file and set overwrite to true.

Use the UDDI registry

UDDI Utility Tools prerequisites

UDDI Utility Tools configuration file

UDDI entity definition file

UDDI Utility Tools through the API

Save UDDI Version 3 entities with a supplied key

UDDI Utility Tools limitations and resolutions