Service Registry 3.1 Developer's Guide

Preface

The Service Registry 3.1 Developer's Guide describes how to use the JavaTM API for XML Registries (JAXR) to query Service Registry (“the Registry”) and to publish content to it.

Service Registry is an ebXML Registry: a federated registry and repository that manages all types of electronic content described by standard and extensible metadata. It provides federated, secure information management of Service Oriented Architecture (SOA) and other content and metadata. It supports the ebXML Registry 3.0 and UDDI 3.0 registry protocols.

Who Should Use This Book

The Developer's Guide is intended for applications programmers who plan to develop JAXR clients that search the Registry and that publish content to the Registry.

This guide assumes you are familiar with the following:

Before You Read This Book

You should be familiar with the basic concepts of these specifications:

As you develop code, you can use the Web Console provided with the Service Registry software to verify that your code is working correctly. Read the Service Registry 3.1 User’s Guide to familiarize yourself with the Web Console.

Service Registry is a component of Sun Java Enterprise System (“Java ES”), a software infrastructure that supports enterprise applications distributed across a network or Internet environment. You should be familiar with the Java ES* documentation at http://docs.sun.com/coll/1286.2.

How This Book Is Organized

The contents of this book are as follows:

Chapter 1, Overview of JAXR provides a brief overview of JAXR.

Chapter 2, Setting Up a JAXR Client describes the first steps to follow to implement a JAXR client that can perform queries and updates to the Service Registry.

Chapter 3, Querying a Registry describes the interfaces and methods JAXR provides for querying a registry.

Chapter 4, Publishing Objects to the Registry describes how to publish objects to the Registry.

Chapter 5, Managing Objects in the Registry describes how to perform operations on objects in the registry, such as deleting objects and changing their state.

Chapter 6, Developing Client Programs for the UDDI Interface describes how to develop Java client programs that enable you to use UDDI queries to search the Registry.

Chapter 7, Troubleshooting describes solutions to some problems that you can encounter when using JAXR with Service Registry.

Appendix A, Canonical Constants lists constants that you can use to search for objects by their unique identifiers.

Service Registry Documentation Set

The Service Registry documentation set is available at http://docs.sun.com/app/docs/coll/1314.2. To learn about Service Registry, refer to the books listed in the following table.

Table P–1 Service Registry Documentation

Document Title 

Contents 

Service Registry 3.1 Release Notes

Contains the latest information about Service Registry, including known problems. 

Service Registry 3.1 Administration Guide

Describes how to configure Service Registry after installation and how to use the administration tool provided with the Registry. It also describes how to perform other administrative tasks. 

Service Registry 3.1 User’s Guide

Describes how to use the Service Registry Web Console to search Service Registry and to publish data to it. 

Service Registry 3.1 Developer’s Guide

Describes how to use the Java API for XML Registries (JAXR) to search Service Registry and to publish data to it. 

Related Books

When you install Service Registry, it is deployed to the Sun Java System Application Server. For information about administering Application Server, refer to Sun Java System Application Server Enterprise Edition 8.2 Administration Guide.

The Java ES documentation set describes deployment planning and system installation. The URL for system documentation is http://docs.sun.com/coll/1286.2. For an introduction to Java ES, refer to the books in the order in which they are listed in the following table.

Table P–2 Java Enterprise System Documentation

Document Title 

Contents 

Sun Java Enterprise System 5 Release Notes for UNIX

Sun Java Enterprise System 5 Release Notes for Microsoft Windows

Contains the latest information about Java ES, including known problems. In addition, components have their own release notes listed in the Release Notes Collection (http://docs.sun.com/coll/1315.2).

Sun Java Enterprise System 5 Technical Overview

Introduces the technical and conceptual foundations of Java ES. Describes components, the architecture, processes, and features. 

Sun Java Enterprise System Deployment Planning Guide

Provides an introduction to planning and designing enterprise deployment solutions based on Java ES. Presents basic concepts and principles of deployment planning and design, discusses the solution life cycle, and provides high-level examples and strategies to use when planning solutions based on Java ES. 

Sun Java Enterprise System 5 Installation Planning Guide

Helps you develop the implementation specifications for the hardware, operating system, and network aspects of your Java ES deployment. Describes issues such as component dependencies to address in your installation and configuration plan. 

Sun Java Enterprise System 5 Installation Guide for UNIX

Sun Java Enterprise System 5 Installation Guide for Microsoft Windows

Guides you through the process of installing Java ES. Also shows how to configure components after installation, and verify that they function properly. 

Sun Java Enterprise System 5 Installation Reference for UNIX

Gives additional information about configuration parameters, provides worksheets to use in your configuration planning, and lists reference material such as default directories and port numbers on the Solaris Operating System and Linux operating environment. 

Sun Java Enterprise System 5 Upgrade Guide for UNIX

Sun Java Enterprise System 5 Upgrade Guide for Microsoft Windows

Provides instructions for upgrading to Java ES 5 from previously installed versions. 

Sun Java Enterprise System 5 Monitoring Guide

Gives instructions for setting up the Monitoring Framework for each product component and using the Monitoring Console to view real-time data and create monitoring rules. 

Sun Java Enterprise System Glossary

Defines terms that are used in Java ES documentation.

The URL for all documentation about Java ES and its components is http://docs.sun.com/prod/entsys.5.

Default Paths and File Names

The following table describes the default paths and file names that are used in this book.

Table P–3 Default Paths and File Names

Placeholder 

Description 

Default Value 

ServiceRegistry-base

Represents the base installation directory for Service Registry. 

Solaris OS: /opt/SUNWsrvc-registry

Linux and HP-UX systems: /opt/sun/srvc-registry

RegistryDomain-base

Represents the directory where the Application Server domain for Service Registry is located and where the Service Registry database is located. 

Solaris OS: /var/opt/SUNWsrvc-registry

Linux and HP-UX systems: /var/opt/sun/srvc-registry

Ant-base

Represents the directory where the Java ES version of the Ant tool is located. 

Solaris OS: /usr/sfw/bin

Linux and HP-UX systems: /opt/sun/share/bin

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–4 Typographic Conventions

Typeface 

Meaning 

Example 

AaBbCc123

The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.

AaBbCc123

What you type, contrasted with onscreen computer output 

machine_name% su

Password:

AaBbCc123

A placeholder to be replaced with a real name or value 

The command to remove a file is rm filename.

AaBbCc123

Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online) 

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Shell Prompts in Command Examples

The following table shows default system prompts and superuser prompts.

Table P–5 Shell Prompts

Shell 

Prompt 

C shell on UNIX and Linux systems 

machine_name%

C shell superuser on UNIX and Linux systems 

machine_name#

Bourne shell and Korn shell on UNIX and Linux systems 

$

Bourne shell and Korn shell superuser on UNIX and Linux systems 

#

Microsoft Windows command line 

C:\

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–6 Symbol Conventions

Symbol 

Description 

Example 

Meaning 

[ ]

Contains optional arguments and command options. 

ls [-l]

The -l option is not required.

{ | }

Contains a set of choices for a required command option. 

-d {y|n}

The -d option requires that you use either the y argument or the n argument.

${ }

Indicates a variable reference. 

${com.sun.javaRoot}

References the value of the com.sun.javaRoot variable.

Joins simultaneous multiple keystrokes. 

Control-A 

Press the Control key while you press the A key. 

Joins consecutive multiple keystrokes. 

Ctrl+A+N 

Press the Control key, release it, and then press the subsequent keys. 

-> 

Indicates menu item selection in a graphical user interface. 

File -> New -> Templates 

From the File menu, choose New. From the New submenu, choose Templates. 

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.comSM web site, you can use a search engine by typing the following syntax in the search field:


search-term site:docs.sun.com

For example, to search for “broker,” type the following:


broker site:docs.sun.com

To include other Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.


Note –

Sun is not responsible for the availability of third-party web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.


Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the book's title page or in the document's URL. For example, the part number of this book is 819-4638.