PreviousHomeNext Search

Implementing a JAXR Client

This section describes the basic steps to follow in order to implement a JAXR client that can perform queries and updates to a UDDI registry. A JAXR client is a client program that can access registries using the JAXR API.

This tutorial does not describe how to implement a JAXR provider. A JAXR provider provides an implementation of the JAXR specification that allows access to an existing registry provider, such as a UDDI or ebXML registry. The implementation of JAXR in the Sun ONE Application Server itself is an example of a JAXR provider.

This tutorial includes several client examples, which are described in Running the Client Examples. The examples are in the directory <INSTALL>/j2eetutorial/examples/jaxr, where <INSTALL> is the directory where you installed the tutorial.

Establishing a Connection

The first task a JAXR client must complete is to establish a connection to a registry.

Preliminaries: Getting Access to a Registry

Any user of a JAXR client may perform queries on a registry. In order to add data to the registry or to update registry data, however, a user must obtain permission from the registry to access it. To register with one of the public UDDI version 2 registries, go to one of the following Web sites and follow the instructions:

These UDDI version 2 registries are intended for testing purposes. When you register, you will obtain a user name and password. You will specify this user name and password for some of the JAXR client example programs.

You do not have to register with the Sun ONE Studio internal UDDI Server Registry in order to add or update data. You can use the default user name and password, testuser and testuser.

Note: The JAXR API has been tested with the Microsoft and IBM registries and with the Registry Server, but not with the SAP registry.

Creating or Looking Up a Connection Factory

A client creates a connection from a connection factory. A JAXR provider may supply one or more preconfigured connection factories that clients can obtain by looking them up using the Java Naming and Directory InterfaceTrademarked (JNDI) API.

At this release of the Sun ONE Application Server, JAXR does not supply preconfigured connection factories. Instead, a client creates an instance of the abstract class ConnectionFactory:

import javax.xml.registry.*;
ConnectionFactory connFactory = 

Creating a Connection

To create a connection, a client first creates a set of properties that specify the URL or URLs of the registry or registries being accessed. For example, the following code provides the URLs of the query service and publishing service for the IBM test registry. (There should be no line break in the strings.)

Properties props = new Properties();

With the Sun ONE Application Server implementation of JAXR, if the client is accessing a registry that is outside a firewall, it must also specify proxy host and port information for the network on which it is running. For queries it may need to specify only the HTTP proxy host and port; for updates it must specify the HTTPS proxy host and port.


The client then sets the properties for the connection factory and creates the connection:

Connection connection = connFactory.createConnection(); 

The makeConnection method in the sample programs shows the steps used to create a JAXR connection.

Setting Connection Properties

The implementation of JAXR in the Sun ONE Application Server allows you to set a number of properties on a JAXR connection. Some of these are standard properties defined in the JAXR specification. Other properties are specific to the implementation of JAXR in the Sun ONE Application Server. Table 11-1 and Table 11-2 list and describe these properties.

Table 11-1 Standard JAXR Connection Properties
Property Name and Description
Data Type
Default Value
Specifies the URL of the query manager service within the target registry provider
Specifies the URL of the life cycle manager service within the target registry provider (for registry updates)
Same as the specified queryManagerURL value
Specifies semantic equivalences of concepts as one or more tuples of the ID values of two equivalent concepts separated by a comma; the tuples are separated by vertical bars:
Provides a hint to the JAXR provider on the authentication method to be used for authenticating with the registry provider
None; UDDI_GET_AUTHTOKEN is the only supported value
The maximum number of rows to be returned by find operations. Specific to UDDI providers
The ID of a ClassificationScheme to be used as the default postal address scheme. See Specifying Postal Addresses  for an example

Table 11-2 Implementation-Specific JAXR Connection Properties
Property Name and Description
Data Type
Default Value
Specifies the HTTP proxy host to be used for accessing external registries
Specifies the HTTP proxy port to be used for accessing external registries; usually 8080
Specifies the HTTPS proxy host to be used for accessing external registries
Same as HTTP proxy host value
Specifies the HTTPS proxy port to be used for accessing external registries; usually 8080
Same as HTTP proxy port value
Specifies the user name for the proxy host for HTTP proxy authentication, if one is required
Specifies the password for the proxy host for HTTP proxy authentication, if one is required
Tells the JAXR implementation to look for registry objects in the cache first and then to look in the registry if not found
Boolean, passed in as String
Tells the JAXR implementation to use Apache SOAP rather than the Java API for XML Messaging; may be useful for debugging. You must install Apache SOAP (downloadable from the Apache web site, http://xml.apache.org/) in order to use this option
Boolean, passed in as String

You can set these properties as follows:

An additional system property specific to the implementation of JAXR in the Sun ONE Application Server is com.sun.xml.registry.userTaxonomyFilenames. For details on using this property, see Defining a Taxonomy.

Obtaining and Using a RegistryService Object

After creating the connection, the client uses the connection to obtain a RegistryService object and then the interface or interfaces it will use:

RegistryService rs = connection.getRegistryService();
BusinessQueryManager bqm = rs.getBusinessQueryManager();
BusinessLifeCycleManager blcm = 

Typically, a client obtains both a BusinessQueryManager object and a BusinessLifeCycleManager object from the RegistryService object. If it is using the registry for simple queries only, it may need to obtain only a BusinessQueryManager object.

Querying a Registry

The simplest way for a client to use a registry is to query it for information about the organizations that have submitted data to it. The BusinessQueryManager interface supports a number of find methods that allow clients to search for data using the JAXR information model. Many of these methods return a BulkResponse (a collection of objects) that meets a set of criteria specified in the method arguments. The most useful of these methods are:

The JAXRQuery program illustrates how to query a registry by organization name and display the data returned. The JAXRQueryByNAICSClassification and JAXRQueryByWSDLClassification programs illustrate how to query a registry using classifications. All JAXR providers support at least the following taxonomies for classifications:

The following sections describe how to perform some common queries.

Finding Organizations by Name

To search for organizations by name, you normally use a combination of find qualifiers (which affect sorting and pattern matching) and name patterns (which specify the strings to be searched). The findOrganizations method takes a collection of findQualifier objects as its first argument and a collection of namePattern objects as its second argument. The following fragment shows how to find all the organizations in the registry whose names begin with a specified string, qString, and to sort them in alphabetical order.

// Define find qualifiers and name patterns
Collection findQualifiers = new ArrayList();
Collection namePatterns = new ArrayList();

// Find using the name
BulkResponse response = 
        namePatterns, null, null, null, null);
Collection orgs = response.getCollection(); 

A client can use percent signs (%) to specify that the query string can occur anywhere within the organization name. For example, the following code fragment performs a case-sensitive search for organizations whose names contain qString:

Collection findQualifiers = new ArrayList();
Collection namePatterns = new ArrayList();
namePatterns.add("%" + qString + "%");

// Find orgs with name containing qString
BulkResponse response = 
    bqm.findOrganizations(findQualifiers, namePatterns, null,
        null, null, null);
Collection orgs = response.getCollection(); 

Finding Organizations by Classification

To find organizations by classification, you need to establish the classification within a particular classification scheme and then specify the classification as an argument to the findOrganizations method.

The following code fragment finds all organizations that correspond to a particular classification within the NAICS taxonomy. (You can find the NAICS codes at http://www.census.gov/epcd/naics/naicscod.txt.)

ClassificationScheme cScheme = 
Classification classification = 
        "Snack and Nonalcoholic Beverage Bars", "722213");
Collection classifications = new ArrayList();
// make JAXR request
BulkResponse response = bqm.findOrganizations(null,
    null, classifications, null, null, null);
Collection orgs = response.getCollection(); 

You can also use classifications to find organizations that offer services based on technical specifications that take the form of WSDL (Web Services Description Language) documents. In JAXR, a concept is used as a proxy to hold the information about a specification. The steps are a little more complicated than in the previous example, because the client must find the specification concepts first, then the organizations that use those concepts.

The following code fragment finds all the WSDL specification instances used within a given registry. You can see that the code is similar to the NAICS query code except that it ends with a call to findConcepts instead of findOrganizations.

String schemeName = "uddi-org:types";
ClassificationScheme uddiOrgTypes =
    bqm.findClassificationSchemeByName(null, schemeName);

 * Create a classification, specifying the scheme
 *  and the taxonomy name and value defined for WSDL
 *  documents by the UDDI specification.
Classification wsdlSpecClassification = 
    "wsdlSpec", "wsdlSpec");

Collection classifications = new ArrayList();

// Find concepts
BulkResponse br = bqm.findConcepts(null, null, 
    classifications, null, null); 

To narrow the search, you could use other arguments of the findConcepts method (search qualifiers, names, external identifiers, or external links).

The next step is to go through the concepts, find the WSDL documents they correspond to, and display the organizations that use each document:

// Display information about the concepts found
Collection specConcepts = br.getCollection();
Iterator iter = specConcepts.iterator();
if (!iter.hasNext()) {
    System.out.println("No WSDL specification concepts found");
} else {
    while (iter.hasNext()) {
    Concept concept = (Concept) iter.next();

    String name = getName(concept);

    Collection links = concept.getExternalLinks();
    System.out.println("\nSpecification Concept:\n\tName: " + 
        name + "\n\tKey: " + 
        concept.getKey().getId() + 
        "\n\tDescription: " + 
    if (links.size() > 0) {
        ExternalLink link = 
            (ExternalLink) links.iterator().next();
        System.out.println("\tURL of WSDL document: '" +
        link.getExternalURI() + "'");

    // Find organizations that use this concept
    Collection specConcepts1 = new ArrayList();
    br = bqm.findOrganizations(null, null, null, 
        specConcepts1, null, null);

    // Display information about organizations

If you find an organization that offers a service you wish to use, you can invoke the service using the JAX-RPC API.

Finding Services and ServiceBindings

After a client has located an organization, it can find that organization's services and the service bindings associated with those services.

Iterator orgIter = orgs.iterator();
while (orgIter.hasNext()) {
    Organization org = (Organization) orgIter.next();
    Collection services = org.getServices();
    Iterator svcIter = services.iterator();
    while (svcIter.hasNext()) {
        Service svc = (Service) svcIter.next();
        Collection serviceBindings = 
        Iterator sbIter = serviceBindings.iterator();
        while (sbIter.hasNext()) {
            ServiceBinding sb = 
                (ServiceBinding) sbIter.next();

Managing Registry Data

If a client has authorization to do so, it can submit data to a registry, modify it, and remove it. It uses the BusinessLifeCycleManager interface to perform these tasks.

Registries usually allow a client to modify or remove data only if the data is being modified or removed by the same user who first submitted the data.

Getting Authorization from the Registry

Before it can submit data, the client must send its user name and password to the registry in a set of credentials. The following code fragment shows how to do this.

String username = "myUserName";
String password = "myPassword";

// Get authorization from the registry
PasswordAuthentication passwdAuth =
    new PasswordAuthentication(username, 

Set creds = new HashSet();

Creating an Organization

The client creates the organization and populates it with data before saving it.

An Organization object is one of the more complex data items in the JAXR API. It normally includes the following:

For example, the following code fragment creates an organization and specifies its name, description, and primary contact. When a client creates an organization, it does not include a key; the registry returns the new key when it accepts the newly created organization. The blcm object in this code fragment is the BusinessLifeCycleManager object returned in Obtaining and Using a RegistryService Object. An InternationalString object is used for string values that may need to be localized.

// Create organization name and description
Organization org = 
    blcm.createOrganization("The Coffee Break");
InternationalString s =
    blcm.createInternationalString("Purveyor of " +
        "the finest coffees. Established 1914");

// Create primary contact, set name
User primaryContact = blcm.createUser();
PersonName pName = blcm.createPersonName("Jane Doe");

// Set primary contact phone number
TelephoneNumber tNum = blcm.createTelephoneNumber();
tNum.setNumber("(800) 555-1212");
Collection phoneNums = new ArrayList();

// Set primary contact email address
EmailAddress emailAddress = 
Collection emailAddresses = new ArrayList();

// Set primary contact for organization

Adding Classifications

Organizations commonly belong to one or more classifications based on one or more classification schemes (taxonomies). To establish a classification for an organization using a taxonomy, the client first locates the taxonomy it wants to use. It uses the BusinessQueryManager to find the taxonomy. The findClassificationSchemeByName method takes a set of FindQualifier objects as its first argument, but this argument can be null.

// Set classification scheme to NAICS
ClassificationScheme cScheme = 
    bqm.findClassificationSchemeByName(null, "ntis-gov:naics"); 

The client then creates a classification using the classification scheme and a concept (a taxonomy element) within the classification scheme. For example, the following code sets up a classification for the organization within the NAICS taxonomy. The second and third arguments of the createClassification method are the name and value of the concept.

// Create and add classification
Classification classification = 
        "Snack and Nonalcoholic Beverage Bars", "722213");  
Collection classifications = new ArrayList();

Services also use classifications, so you can use similar code to add a classification to a Service object.

Adding Services and Service Bindings to an Organization

Most organizations add themselves to a registry in order to offer services, so the JAXR API has facilities to add services and service bindings to an organization.

Like an Organization object, a Service object has a name and a description. Also like an Organization object, it has a unique key that is generated by the registry when the service is registered. It may also have classifications associated with it.

A service also commonly has service bindings, which provide information about how to access the service. A ServiceBinding object normally has a description, an access URI, and a specification link, which provides the linkage between a service binding and a technical specification that describes how to use the service using the service binding.

The following code fragment shows how to create a collection of services, add service bindings to a service, then add the services to the organization. It specifies an access URI but not a specification link. Because the access URI is not real and because JAXR by default checks for the validity of any published URI, the binding sets its validateURI property to false.

// Create services and service
Collection services = new ArrayList();
Service service = blcm.createService("My Service Name");
InternationalString is = 
  blcm.createInternationalString("My Service Description");

// Create service bindings
Collection serviceBindings = new ArrayList();
ServiceBinding binding = blcm.createServiceBinding();
is = blcm.createInternationalString("My Service Binding " +
// allow us to publish a bogus URL without an error

// Add service bindings to service

// Add service to services, then add services to organization

Saving an Organization

The primary method a client uses to add or modify organization data is the saveOrganizations method, which creates one or more new organizations in a registry if they did not exist previously. If one of the organizations exists but some of the data have changed, the saveOrganizations method updates and replaces the data.

After a client populates an organization with the information it wants to make public, it saves the organization. The registry returns the key in its response, and the client retrieves it.

// Add organization and submit to registry
// Retrieve key if successful
Collection orgs = new ArrayList();
BulkResponse response = blcm.saveOrganizations(orgs);
Collection exceptions = response.getException();
if (exceptions == null) {
    System.out.println("Organization saved");

    Collection keys = response.getCollection();
    Iterator keyIter = keys.iterator();
    if (keyIter.hasNext()) {
         javax.xml.registry.infomodel.Key orgKey = 
            (javax.xml.registry.infomodel.Key) keyIter.next();
        String id = orgKey.getId();
        System.out.println("Organization key is " + id);

Removing Data from the Registry

A registry allows you to remove from the registry any data that you have submitted to it. You use the key returned by the registry as an argument to one of the BusinessLifeCycleManager delete methods: deleteOrganizations, deleteServices, deleteServiceBindings, and others.

The JAXRDelete sample program deletes the organization created by the JAXRPublish program. It deletes the organization that corresponds to a specified key string and then displays the key again so that the user can confirm that it has deleted the correct one.

String id = key.getId();
System.out.println("Deleting organization with id " + id);
Collection keys = new ArrayList();
BulkResponse response = blcm.deleteOrganizations(keys);
Collection exceptions = response.getException();
if (exceptions == null) {
    System.out.println("Organization deleted");
    Collection retKeys = response.getCollection();
    Iterator keyIter = retKeys.iterator();
    javax.xml.registry.infomodel.Key orgKey = null;
    if (keyIter.hasNext()) {
        orgKey = 
            (javax.xml.registry.infomodel.Key) keyIter.next();
        id = orgKey.getId();
        System.out.println("Organization key was " + id);

A client can use a similar mechanism to delete services and service bindings.

Using Taxonomies in JAXR Clients

In the JAXR API, a taxonomy is represented by a ClassificationScheme object.

This section describes how to use the implementation of JAXR in the Sun ONE Application Server:

Defining a Taxonomy

The JAXR specification requires a JAXR provider to be able to add user-defined taxonomies for use by JAXR clients. The mechanisms clients use to add and administer these taxonomies are implementation-specific.

The implementation of JAXR in the Sun ONE Application Server uses a simple file-based approach to provide taxonomies to the JAXR client. These files are read at run time, when the JAXR provider starts up.

The taxonomy structure for the implementation of JAXR in the Sun ONE Application Server is defined by the JAXR Predefined Concepts DTD, which is declared both in the file jaxrconcepts.dtd and, in XML schema form, in the file jaxrconcepts.xsd. The file jaxrconcepts.xml contains the taxonomies for the implementation of JAXR in the Sun ONE Application Server. All these files are contained in the file <S1STUDIO_HOME>/jwsdp/common/lib/jaxr-ri.jar. The jaxr-ri.jar file also includes files that define the well-known taxonomies that the implementation of JAXR in the Sun ONE Application Server uses: naics.xml, iso3166.xml, and unspsc.xml.

The entries in the jaxrconcepts.xml file look like this:

<JAXRClassificationScheme id="schId" name="schName">
<JAXRConcept id="schId/conCode" name="conName" 
parent="parentId" code="conCode"></JAXRConcept>

The taxonomy structure is a containment-based structure. The element PredefinedConcepts is the root of the structure and must be present. The JAXRClassificationScheme element is the parent of the structure, and the JAXRConcept elements are children and grandchildren. A JAXRConcept element may have children, but it is not required to do so.

In all element definitions, attribute order and case are significant.

To add a user-defined taxonomy, follow these steps.

  1. Publish the JAXRClassificationScheme element for the taxonomy as a ClassificationScheme object in the registry that you will be accessing. For example, you can publish the ClassificationScheme object to the Sun ONE Studio internal UDDI Server Registry. In order to publish a ClassificationScheme object, you must set its name. You also give the scheme a classification within a known classification scheme such as uddi-org:types. In the following code fragment, the name is the first argument of the LifeCycleManager.createClassificationScheme method call.
  2. ClassificationScheme cScheme =
    "A Classification Scheme");
    ClassificationScheme uddiOrgTypes =
    if (uddiOrgTypes != null) {
    Classification classification =
    "postalAddress", "categorization" );
    ExternalLink externalLink =
    "My Scheme");
    Collection schemes = new ArrayList();
    BulkResponse br =

    The BulkResponse object returned by the saveClassificationSchemes method contains the key for the classification scheme, which you need to retrieve:

    if (br.getStatus() == JAXRResponse.STATUS_SUCCESS) {
    System.out.println("Saved ClassificationScheme");
    Collection schemeKeys = br.getCollection();
    Iterator keysIter = schemeKeys.iterator();
    while (keysIter.hasNext()) {
    javax.xml.registry.infomodel.Key key =
    System.out.println("The postalScheme key is " +
    System.out.println("Use this key as the scheme" +
    " uuid in the taxonomy file");

  3. In an XML file, define a taxonomy structure that is compliant with the JAXR Predefined Concepts DTD. Enter the ClassificationScheme element in your taxonomy XML file by specifying the returned key ID value as the id attribute and the name as the name attribute. For the code fragment above, for example, the opening tag for the JAXRClassificationScheme element looks something like this (all on one line):
  4. <JAXRClassificationScheme

    The ClassificationScheme id must be a UUID.

  5. Enter each JAXRConcept element in your taxonomy XML file by specifying the following four attributes, in this order:
    1. id is the JAXRClassificationScheme id value, followed by a / separator, followed by the code of the JAXRConcept element
    2. name is the name of the JAXRConcept element
    3. parent is the immediate parent id (either the ClassificationScheme id or that of the parent JAXRConcept)
    4. code is the JAXRConcept element code value
    5. The first JAXRConcept element in the naics.xml file looks like this (all on one line):

      name="Agriculture, Forestry, Fishing and Hunting"

  6. To add the user-defined taxonomy structure to the JAXR provider, specify the system property com.sun.xml.registry.userTaxonomyFilenames when you run your client program. You can use a <sysproperty> tag to set this property in a build.xml file for a client program. Or, in your program, you can set the property as follows. A vertical bar (|) is the file separator.
  7. System.setProperty

Specifying Postal Addresses

The JAXR specification defines a postal address as a structured interface with attributes for street, city, country, and so on. The UDDI specification, on the other hand, defines a postal address as a free-form collection of address lines, each of which may also be assigned a meaning. To map the JAXR PostalAddress format to a known UDDI address format, you specify the UDDI format as a ClassificationScheme object and then specify the semantic equivalences between the concepts in the UDDI format classification scheme and the comments in the JAXR PostalAddress classification scheme. The JAXR PostalAddress classification scheme is provided by the implementation of JAXR in the Sun ONE Application Server.

In the JAXR API, a PostalAddress object has the fields streetNumber, street, city, state, postalCode and country.

To specify the mapping between the JAXR postal address format and another format, you need to set two connection properties:

For example, suppose you want to use a scheme that has been published to the IBM registry and that has the UUID uuid:6eaf4b50-4196-11d6-9e2b-000629dc0a2b.

In the implementation of JAXR in the Sun ONE Application Server, you first use the system property com.sun.xml.registry.userTaxonomyFilenames to specify the concepts file where the scheme is described.

Next, you specify the postal address scheme using the id value from the JAXRClassificationScheme element (the UUID). Case does not matter:


Next, you specify the mapping from the id of each JAXRConcept element in the default JAXR postal address scheme to the id of its counterpart in the IBM scheme:

  "urn:uuid:PostalAddressAttributes/StreetNumber," +
000629dc0a2b/StreetAddressNumber|" +
  "urn:uuid:PostalAddressAttributes/Street," +
000629dc0a2b/StreetAddress|" +
  "urn:uuid:PostalAddressAttributes/City," +
  "urn:uuid:6eaf4b50-4196-11d6-9e2b-000629dc0a2b/City|" +
  "urn:uuid:PostalAddressAttributes/State," +
  "urn:uuid:6eaf4b50-4196-11d6-9e2b-000629dc0a2b/State|" +
  "urn:uuid:PostalAddressAttributes/PostalCode," +
  "urn:uuid:6eaf4b50-4196-11d6-9e2b-000629dc0a2b/ZipCode|" +
  "urn:uuid:PostalAddressAttributes/Country," +

After you create the connection using these properties, you can create a postal address and assign it to the primary contact of the organization before you publish the organization:

String streetNumber = "99";
String street = "Imaginary Ave. Suite 33";
String city = "Imaginary City";
String state = "NY";
String country = "USA";
String postalCode = "00000";
String type = "";
PostalAddress postAddr = 
  blcm.createPostalAddress(streetNumber, street, city, state,
    country, postalCode, type);
Collection postalAddresses = new ArrayList();

A JAXR query can then retrieve the postal address using PostalAddress methods, if the postal address scheme and semantic equivalences for the query are the same as those specified for the publication. To retrieve postal addresses when you do not know what postal address scheme was used to publish them, you can retrieve them as a collection of Slot objects. The JAXRQueryPostal.java sample program shows how to do this.

In general, you can create a user-defined postal address taxonomy for any postalAddress tModels that use the well-known categorization in the uddi-org:types taxonomy, which has the tModel UUID uuid:c1acf26d-9672-4404-9d70-39b756e62ab4 with a value of postalAddress. You can retrieve the tModel overviewDoc, which points to the technical detail for the specification of the scheme, where the taxonomy structure definition can be found. (The JAXR equivalent of an overviewDoc is an ExternalLink.)

PreviousHomeNext Search

All of the material in The J2EE Tutorial for the Sun ONE Platform is copyright-protected and may not be published in other works without express written permission from Sun Microsystems.