Home > Articles > Mobile Application Development & Programming > HTML5 & Web Standards

UDDI Inquiry with Java

  • Print
  • + Share This
Like this article? We recommend

The Inquiry Process

For an application to discover a particular service with minimal manual intervention, a structure must be in place that supports the path to the desired service. The classification and service interaction specifications provide just that structure. Business entities and services are classified within this framework (see Figure 2) and the inquiry process navigates this structure.

Figure 2Figure 2 Inquiry structure in the UDDI registry.

The process of finding a service depends on the information available about the type or class of services to be discovered. The UDDI specification provides several APIs to discover various resources in the registry. This article focuses on the following types of queries:

  • Find service interface (tModel)

  • Find service

  • Find business entity

Usually, many details are published along with the main resource (whether a service, business entity, or a tModel). Quite a few of these details are searchable:

  • Name

  • Category key

  • Unique identifier key

  • Applicable tModel

  • Parent resource

A service consumer application can be designed to search on any number or combination of these types of details. However, the UDDI registry is designed for use in an ecosystem paradigm. Following is the typical scenario for which a service consumer application is designed:

  1. Find all the relevant service interaction specifications.

  2. Choose one that seems to meet your needs.

  3. Find all the services that comply with that particular service interaction specification.

  4. Choose the service that's most suitable.

  5. Find the responsible business entities for the discovered services.

A service consumer may have an existing relationship with a service provider and want to search for all of its services. In this case, the inquiry process may simply include searching for all services provided by that business entity.

Let's consider an example. American Corporation, Inc. (ACI) is a company with a sizable workforce. Having recently decided to offer 401(k) plans to its employees, ACI researches the pension fund industry and comes to the conclusion that FITSO compliancy is an important criteria in selection; therefore, ACI has determined that it will work only with FITSO-compliant 401(k) service providers. The next three sections explain ACI's electronic inquiry process as supported by the UDDI registry.

Discovering a Service Interaction Specification

Figure 3 depicts a typical inquiry sequence for a service consumer. At the beginning of the inquiry process, the consumer usually knows only that the desired services abide by a certain interaction specification. In this example, ACI is looking for services that comply with the specification TM401k that FITSO published to the UDDI registry; this specification provides guidance on what features FITSO-compliant 401(k) service providers should include.

Figure 3Figure 3 Ecosystem-based inquiry.

Remember that calls made to the inquiry URL are not secured because no authentication is required (especially in the case of the UBR used in these examples). The main configuration is simply denoting the inquiry URL with which the service consumer wants to communicate.

In UDDI4J, the class find_tModel is the starting point to find a tModel. find_tModel provides several methods to construct registry queries to search tModels. Queries can be designed to handle a broad-based search of interaction specifications and classification schemes, or a more refined search using more information about the interaction specification. In our example, the broader case simply uses a wildcard search to find particular characters in the name of the specification tModels published in the registry; the more refined search will be based on category.

Broad-Based Search

A broad-based search is not always sufficient. One of the goals of XML-based registries is to assist in the electronic decision-making process. Simply doing a wildcard search would require a manual selection after finding the interaction specifications. Given no other guidance, a manual decision process would be the only option. Entities such as consortiums and governing bodies should provide more details as to how to reach the exact interaction specification. Ideally, they would provide the following details:

  • Interaction specification name

  • Classification scheme and details

Refined Search

FITSO provides detailed interaction information in their specification. Using these guidelines, ACI can refine its search to locate interaction specifications with a specific name and classification type: The TM401k specification was published within the general_keyword taxonomy, with the keyword 401k. (Behind the scenes, a CategoryBag structure is constructed to store the additional information and prepare the appropriate inquiry XML to run on the UDDI registry.)

Using this additional information, the inquiry can be refined. Assume that the search parameters are stored in a file as follows:

#A partial name string to be used during search.
#Note that % is used as a wildcard
TMSearchName=%401%k%


# Taxonomy to classify.
# uddi-org:general_keywords
CategoryTModelKey=uuid:A035A07C-F362-44dd-8F95-E2B134BF43B4
ClassificationName=KEYWORD
ClassificationValue=401(k)

The search can then be conducted as follows:

//Find a taxonomy with specific keywords
Properties TMp = new Properties();
TMp.load(new java.io.FileInputStream(args[0]));

//Prepare the search parameters
String searchName = TMp.getProperty("TMSearchName");

//Add category bag conditionally. Other parameters can be added
// conditionally in a similar manner.
CategoryBag cb = null;
if(TMp.getProperty("CategoryTModelKey") != null);
{
  cb = new CategoryBag();
     cb.setKeyedReferenceVector(createCategoryVector(TMp));
}

TModelList tl = proxy.find_tModel(searchName, cb, null, null, 5);
Vector tminfv = tl.getTModelInfos().getTModelInfoVector();

Using the found tModel data, the following code segment uses the unique identifier and the class TModelInfos to display the description and overview documents associated with each tModel:

for(int i=0; i< tminfv.size(); i++)
{
  TModelInfo tmi = (TModelInfo) tminfv.elementAt(i);
  System.out.println("tModel Name: " + tmi.getNameString());
  System.out.println("tModel Key: " + tmi.getTModelKey());

  TModelDetail tmd = proxy.get_tModelDetail(tmi.getTModelKey());
  Vector tmv = tmd.getTModelVector();

  //Get Description and overviewDoc for the tModel
  if(tmv.size()>0)
  {
    TModel tm = (TModel) tmv.elementAt(0);
    System.out.println("Default Description: " +
        tm.getDefaultDescriptionString());
    System.out.println("Overview URL: " +
        tm.getOverviewDoc().getOverviewURLString());
  }

Discovering a Service

After obtaining the appropriate tModel key for the service interface specification, ACI can find the services that comply with that specific tModel. For the sake of explanation, we'll call this the compliance tModel. In this example, the FITSO TM401(k) tModel is the compliance tModel.

Discovering a service is very similar to the process for discovering a tModel (or even a business). Constructing the search query is fairly similar to constructing the query for finding a tModel. Using the service name and the compliance tModel key, ACI can locate one or more of the services that comply with the FITSO tModel:

# A partial name string to be used during search.
# Note that % is used as a wildcard
ServiceSearchName=%401%k%

# Compliance tModel Key
ComplianceTModelKey=<Enter the key for your registered tModel>

And the code segment that accomplishes the search:

Properties Svcp = new Properties();
Svcp.load(new java.io.FileInputStream(args[0]));

TModelBag tmb = new TModelBag();
tmb.setTModelKeyVector(createTModelVector(Svcp));

Vector names = new Vector();
names.add(new Name(Svcp.getProperty("ServiceSearchName")));

ServiceList sl = proxy.find_service(null, names, null, tmb, null, 5);
Vector sinfv = sl.getServiceInfos().getServiceInfoVector();

TIP

I haven't constructed a query based on the CategoryBag structure as I did for tModels, but a similar approach is used. Queries based on categories would be useful if we were searching for a genre of services rather than a set of services that complied with a specific service interaction specification.

The results of the query return the service name as well as the service identification keys. These keys are useful because they provide direct access to the service for future use.

for(int i=0; i< sinfv.size(); i++)
{
  ServiceInfo si = (ServiceInfo) sinfv.elementAt(i);
  System.out.println("Service Name: " + si.getNameString());
  System.out.println("Service Key: " + si.getServiceKey());

  BusinessDetail bd =
    proxy.get_businessDetail(si.getBusinessKey());
  BusinessEntity be = (BusinessEntity)
    bd.getBusinessEntityVector().elementAt(0);
  System.out.println("Business Name: "+ be.getDefaultNameString());

}

Discovering a Business Entity

At this point, we've traversed a complete discovery pattern, where we discovered a tModel based on certain keywords, discovered a set of services that complied with the specific tModel, and obtained more information about the business entity that owned the service.

Another discovery pattern is also possible when a potential service user is aware of existing entities that might serve as business partners. In this situation, discovery would happen in reverse order: The business entity would be discovered first, followed by the services it offers.

Consider finding a business that satisfies the following search properties:

# NAICS (1997)
TModelKey=uuid:C0B9FE13-179F-413D-8A5B-5004DB8E5BB2
ClassificationName=Pension fund, third party administrative services
ClassificationValue=524292

For discovering a business entity, the find_business method of the UDDIProxy class acts as the central point where the search criteria are provided. In this example, it includes a taxonomy under which the business entity is classified:

//Select a business in a specific taxonomy
Properties fbp = new Properties();
fbp.load(new java.io.FileInputStream(args[0]));
CategoryBag cb = new CategoryBag();
cb.setKeyedReferenceVector(createCategoryVector(fbp));

//Search the business on the registry
BusinessList bl = proxy.find_business(null, null, null,
  cb,null,null,5);

The class BusinessList gets detailed information about the chosen business entity:

//Print contact information for the found businesses
Vector biv = bl.getBusinessInfos().getBusinessInfoVector();
for (int i = 0; i < biv.size(); i++)
{
  BusinessInfo bi = (BusinessInfo)biv.elementAt(i);
  String key = bi.getBusinessKey();
  Vector bdv =
    proxy.get_businessDetail(key).getBusinessEntityVector();

  // Print name for each business

  System.out.println("Company: " + bi.getNameString());
  if(bdv.size()>0)
  {
    BusinessEntity be = (BusinessEntity) bdv.elementAt(0);
    Vector cv = be.getContacts().getContactVector();
    if(cv.size()>0)
    {
      Contact primeContact = (Contact)cv.elementAt(0);
      System.out.println("Primary contact: "
        primeContact.getPersonName().getText());
      Vector phv = primeContact.getPhoneVector();
      if(phv.size()>0)
      {
        Phone ph = (Phone) phv.elementAt(0);
        System.out.println("Phone: " + ph.getText());
      }
    }
  }
}

Search Qualifiers

The default behavior for inquiry APIs—including those for finding businesses, services, and tModels—executes queries with a ANDed set of search criteria. However, this behavior can be modified using the optional element findQualifier. The UDDI V2 specification supports six built-in findQualifier values, which can be enhanced to support an even wider range of search qualifiers as needed for specialized environments. This is especially useful in a private registry deployment, where specialized searches might be desired.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020