UDDIProxy (UDDI4J API)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.uddi4j.client
Class UDDIProxy

java.lang.Object
  org.uddi4j.client.UDDIProxy

public class UDDIProxy
extends java.lang.Object

Represents a UDDI server and the actions that can be invoked against it.

The API is described in the UDDI API specification available from http://www.uddi.org . The UDDI API specification is required to understand and utilize this API. This class attempts to closely pattern the API document.

Author:: David Melgar (dmelgar@us.ibm.com), Ravi Trivedi (ravi_trivedi@hp.com), Vivek Chopra (vivek@soaprpc.com), Ozzy (ozzy@hursley.ibm.com)

Field Summary
`protected java.net.URL`	`inquiryURL`
`protected java.net.URL`	`publishURL`

Constructor Summary
`UDDIProxy()` Default constructor.
`UDDIProxy(java.util.Properties p)` Construct a UDDIProxy object
`UDDIProxy(java.net.URL inquiryURL, java.net.URL publishURL)` Construct a UDDIProxy object.

Method Summary
`DispositionReport`	`add_publisherAssertions(java.lang.String authInfo, PublisherAssertion publisherAssertion)` The add_publisherAssertions message is used to add relationship assertions to the existing set of assertions.
`DispositionReport`	`add_publisherAssertions(java.lang.String authInfo, java.util.Vector publisherAssertion)` The add_publisherAssertions message is used to add relationship assertions to the existing set of assertions.
`DispositionReport`	`delete_binding(java.lang.String authInfo, java.lang.String bindingKey)` The delete_binding message causes one or more bindingTemplate to be deleted.
`DispositionReport`	`delete_binding(java.lang.String authInfo, java.util.Vector bindingKeyStrings)` The delete_binding message causes one or more bindingTemplate to be deleted.
`DispositionReport`	`delete_business(java.lang.String authInfo, java.lang.String businessKey)` The delete_business message is used to remove one or more businessEntity structures.
`DispositionReport`	`delete_business(java.lang.String authInfo, java.util.Vector businessKeyStrings)` The delete_business message is used to remove one or more businessEntity structures.
`DispositionReport`	`delete_publisherAssertions(java.lang.String authInfo, PublisherAssertion publisherAssertion)` The delete_publisherAssertions message is used to delete specific publisher assertions from the assertion collection controlled by a particular publisher account.
`DispositionReport`	`delete_publisherAssertions(java.lang.String authInfo, java.util.Vector publisherAssertion)` The delete_publisherAssertions message is used to delete specific publisher assertions from the assertion collection controlled by a particular publisher account.
`DispositionReport`	`delete_service(java.lang.String authInfo, java.lang.String serviceKey)` The delete_service message is used to remove one or more businessService structures.
`DispositionReport`	`delete_service(java.lang.String authInfo, java.util.Vector serviceKeyStrings)` The delete_service message is used to remove one or more businessService structures.
`DispositionReport`	`delete_tModel(java.lang.String authInfo, java.lang.String tModelKey)` The delete_tModel message is used to remove or retire one or more tModel structures.
`DispositionReport`	`delete_tModel(java.lang.String authInfo, java.util.Vector tModelKeyStrings)` The delete_tModel message is used to remove or retire one or more tModel structures.
`DispositionReport`	`discard_authToken(AuthInfo authInfo)` The discard_authToken message is used to inform an Operator Site that the authentication token can be discarded.
`DispositionReport`	`discard_authToken(java.lang.String authInfo)` The discard_authToken message is used to inform an Operator Site that the authentication token can be discarded.
`BindingDetail`	`find_binding(FindQualifiers findQualifiers, java.lang.String serviceKey, TModelBag tModelBag, int maxRows)` The find_binding method returns a bindingDetail message that contains a bindingTemplates structure with zero or more bindingTemplate structures matching the criteria specified in the argument list.
`BusinessList`	`find_business(CategoryBag categoryBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int)` instead
`BusinessList`	`find_business(DiscoveryURLs discoveryURLs, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int)` instead
`BusinessList`	`find_business(IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int)` instead
`BusinessList`	`find_business(java.lang.String name, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int)` instead
`BusinessList`	`find_business(TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated.Use `find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int)` instead
`BusinessList`	`find_business(java.util.Vector names, DiscoveryURLs discoveryURLs, IdentifierBag identifierBag, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)` The find_business message returns a businessList message that matches the conditions specified in the arguments.
`RelatedBusinessesList`	`find_relatedBusinesses(java.lang.String businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers)` Deprecated. UDDI version 2, errata 2 added maxrows as a parameter to this method. Use `find_relatedBusinesses(String, KeyedReference, FindQualifiers, int)` instead
`RelatedBusinessesList`	`find_relatedBusinesses(java.lang.String businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int maxRows)` The find_relatedBusinesses API call is used to locate information about businessEntity registrations that are related to a specific business entity whose key is passed in the inquiry.
`ServiceList`	`find_service(java.lang.String businessKey, CategoryBag categoryBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_service(String, Vector, CategoryBag, TModelBag, FindQualifiers, int)` instead
`ServiceList`	`find_service(java.lang.String businessKey, java.lang.String name, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_service(String, Vector, CategoryBag, TModelBag, FindQualifiers, int)` instead
`ServiceList`	`find_service(java.lang.String businessKey, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_service(String, Vector, CategoryBag, TModelBag, FindQualifiers, int)` instead
`ServiceList`	`find_service(java.lang.String businessKey, java.util.Vector names, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)` This function returns a serviceList on success.
`TModelList`	`find_tModel(CategoryBag categoryBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_tModel(String, CategoryBag, IdentifierBag, FindQualifiers, int)` instead
`TModelList`	`find_tModel(IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_tModel(String, CategoryBag, IdentifierBag, FindQualifiers, int)` instead
`TModelList`	`find_tModel(java.lang.String name, CategoryBag categoryBag, IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows)` This find_tModel message is for locating a list of tModel entries that match a set of specific criteria.
`TModelList`	`find_tModel(java.lang.String name, FindQualifiers findQualifiers, int maxRows)` Deprecated. This method has been deprecated. Use `find_tModel(String, CategoryBag, IdentifierBag, FindQualifiers, int)` instead
`AssertionStatusReport`	`get_assertionStatusReport(java.lang.String authInfo, CompletionStatus completionStatus)` The get_assertionStatusReport message is used to request a status report containing publisher assertions and status information.
`AssertionStatusReport`	`get_assertionStatusReport(java.lang.String authInfo, java.lang.String completionStatus)` The get_assertionStatusReport message is used to request a status report containing publisher assertions and status information.
`AuthToken`	`get_authToken(java.lang.String userid, java.lang.String cred)` The get_authToken message is used to obtain an authentication token.
`BindingDetail`	`get_bindingDetail(java.lang.String bindingKey)` The get_bindingDetail message is for requesting the run-time bindingTemplate information location information for the purpose of invoking a registered business API.
`BindingDetail`	`get_bindingDetail(java.util.Vector bindingKeyStrings)` The get_bindingDetail message is for requesting the run-time bindingTemplate information location information for the purpose of invoking a registered business API.
`BusinessDetail`	`get_businessDetail(java.lang.String businessKey)` The get_businessDetail message returns complete businessEntity information for one or more specified businessEntitys
`BusinessDetail`	`get_businessDetail(java.util.Vector businessKeyStrings)` The get_businessDetail message returns complete businessEntity information for one or more specified businessEntitys
`BusinessDetailExt`	`get_businessDetailExt(java.lang.String businessKey)` The get_businessDetailExt message returns extended businessEntity information for one or more specified businessEntitys.
`BusinessDetailExt`	`get_businessDetailExt(java.util.Vector businessKeyStrings)` The get_businessDetailExt message returns extended businessEntity information for one or more specified businessEntitys.
`PublisherAssertions`	`get_publisherAssertions(java.lang.String authInfo)` The get_publisherAssertions message is used to get a list of active publisher assertions that are controlled by an individual publisher account.
`RegisteredInfo`	`get_registeredInfo(java.lang.String authInfo)` The get_registeredInfo message is used to get an abbreviated list of all businessEntity keys and tModel keys that are controlled by the individual associated the credentials passed.
`ServiceDetail`	`get_serviceDetail(java.lang.String serviceKey)` The get_serviceDetail message is used to request full information about a known businessService structure.
`ServiceDetail`	`get_serviceDetail(java.util.Vector serviceKeyStrings)` The get_serviceDetail message is used to request full information about a known businessService structure.
`TModelDetail`	`get_tModelDetail(java.lang.String tModelKey)` The get_tModelDetail message is used to request full information about a known tModel structure.
`TModelDetail`	`get_tModelDetail(java.util.Vector tModelKeyStrings)` The get_tModelDetail message is used to request full information about a known tModel structure.
`java.util.Properties`	`getConfiguration()` Get the configuration properties
`BindingDetail`	`save_binding(java.lang.String authInfo, java.util.Vector bindingTemplates)` The save_binding message is used to save or update a complete bindingTemplate structure.
`BusinessDetail`	`save_business(java.lang.String authInfo, UploadRegister[] uploadRegisters)` Deprecated. This method has been deprecated. Use `save_business(String, Vector)` instead
`BusinessDetail`	`save_business(java.lang.String authInfo, java.util.Vector businessEntities)` The save_business message is used to save or update information about a complete businessEntity structure.
`ServiceDetail`	`save_service(java.lang.String authInfo, java.util.Vector businessServices)` The save_service message adds or updates one or more businessService structures.
`TModelDetail`	`save_tModel(java.lang.String authInfo, UploadRegister[] uploadRegisters)` Deprecated. This method has been deprecated. Use `save_tModel(String, Vector)` instead
`TModelDetail`	`save_tModel(java.lang.String authInfo, java.util.Vector tModels)` The save_tModel message adds or updates one or more tModel structures.
`org.w3c.dom.Element`	`send(org.w3c.dom.Element el, boolean inquiry)` Sends an XML DOM tree indentified by the given element to either the inquiry or publish URL.
`org.w3c.dom.Element`	`send(UDDIElement el, boolean inquiry)` Sends a UDDIElement to either the inquiry or publish URL.
`PublisherAssertions`	`set_publisherAssertions(java.lang.String authInfo, PublisherAssertion pub)` The set_publisherAssertions message is used to save the complete set of publisher assertions for an individual publisher account.
`PublisherAssertions`	`set_publisherAssertions(java.lang.String authInfo, java.util.Vector publisherAssertion)` The set_publisherAssertions message is used to save the complete set of publisher assertions for an individual publisher account.
`void`	`setConfiguration(java.util.Properties p)` Set the configuration properties
`void`	`setInquiryURL(java.lang.String url)` Set the URL to be used for inquiry requests.
`void`	`setInquiryURL(java.net.URL url)` Set the URL to be used for inquiry requests.
`void`	`setPublishURL(java.lang.String url)` Set the URL to be used for publish requests.
`void`	`setPublishURL(java.net.URL url)` Set the URL to be used for publish requests.
`DispositionReport`	`validate_values_businessEntity(java.util.Vector businessEntity)` A UDDI operator sends the validate_values message to the appropriate external service, whenever a publisher saves data that uses a categorization value or identifier whose use is regulated by the external party who controls that service.
`DispositionReport`	`validate_values_businessService(java.util.Vector businessService)` A UDDI operator sends the validate_values message to the appropriate external service, whenever a publisher saves data that uses a categorization value or identifier whose use is regulated by the external party who controls that service.
`DispositionReport`	`validate_values_tModel(java.util.Vector tModel)` A UDDI operator sends the validate_values message to the appropriate external service, whenever a publisher saves data that uses a categorization value or identifier whose use is regulated by the external party who controls that service.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

inquiryURL

protected java.net.URL inquiryURL

publishURL

protected java.net.URL publishURL

Constructor Detail

UDDIProxy

public UDDIProxy()

Default constructor.

UDDIProxy

public UDDIProxy(java.net.URL inquiryURL,
                 java.net.URL publishURL)

Construct a UDDIProxy object.
Parameters:: inquiryURL - URL to be used for inquiry requests.; publishURL - URL to be used for publish requests.

UDDIProxy

public UDDIProxy(java.util.Properties p)
          throws java.net.MalformedURLException

Construct a UDDIProxy object

Parameters:

p - Properties object which contains configuration information for UDDI4J. This properties object overrides settings normally retrieved from system properties.

This object may also specify properties affecting UDDIProxy. Current settings affected by this properties object include:

org.uddi4j.TransportClassName: Specifies the name of the SOAP transport support class. Options include, org.uddi4j.transport.ApacheSOAPTransport, org.uddi4j.transport.ApacheAxisTransport, org.uddi4j.transport.HPSOAPTransport.
org.uddi4j.inquiryURL: The URL to be used by UDDIProxy for inquiry requests. setInquiryURL method overrides.
org.uddi4j.publishURL: The URL to be used by UDDIProxy for publish requests. setPublishURL methods override.

Throws:

java.net.MalformedURLException - In case the publish or inquiry URLs are malformed.

Method Detail

setConfiguration

public void setConfiguration(java.util.Properties p)
                      throws java.net.MalformedURLException

Set the configuration properties

Parameters:: p - Properties object containing configuration information. See UDDIProxy(Properties) for configuration details.
Throws:: java.net.MalformedURLException - In case the publish or inquiry URLs are malformed.

getConfiguration

public java.util.Properties getConfiguration()

Get the configuration properties

Returns:: The configuration properties

setInquiryURL

public void setInquiryURL(java.lang.String url)
                   throws java.net.MalformedURLException

Set the URL to be used for inquiry requests.

Parameters:: url - Inquiry URL string
Throws:: java.net.MalformedURLException - In case the Inquiry URL is malformed.

setInquiryURL

public void setInquiryURL(java.net.URL url)

Set the URL to be used for inquiry requests.

Parameters:: url - Inquiry URL

setPublishURL

public void setPublishURL(java.lang.String url)
                   throws java.net.MalformedURLException

Set the URL to be used for publish requests. If HTTPS is specified as the procotol, it must be added as a supported protocol. For Sun's SSL support, this can be done with the following code fragment:

    System.setProperty("java.protocol.handler.pkgs",
                       "com.sun.net.ssl.internal.www.protocol");
    java.security.Security.addProvider(new com.sun.net.ssl.internal.ssl.Provider());

Parameters:: url -
Throws:: java.net.MalformedURLException - Thrown if HTTPS is not registered as a valid URL protocol.

setPublishURL

public void setPublishURL(java.net.URL url)

Set the URL to be used for publish requests.

Parameters:: url - Publish URL

find_binding

public BindingDetail find_binding(FindQualifiers findQualifiers,
                                  java.lang.String serviceKey,
                                  TModelBag tModelBag,
                                  int maxRows)
                           throws UDDIException,
                                  TransportException

The find_binding method returns a bindingDetail message that contains a bindingTemplates structure with zero or more bindingTemplate structures matching the criteria specified in the argument list.

Parameters:: findQualifiers - This collection of findQualifier elements can be used to alter the default behavior of search functionality.; serviceKey - Used to specify a particular instance of a businessService element in the registered data. Only bindings in the specific businessService data identified by the serviceKey passed will be searched.; tModelBag - This is a list of tModel uuid_key values that represent the technical fingerprint to locate in a bindingTemplate structure contained within the businessService instance specified by the serviceKey value. If more than one tModel key is specified in this structure, only bindingTemplate information that exactly matches all of the tModel keys specified will be returned (logical AND). The order of the keys in the tModelBag is not relevant. All tModelKey values begin with a uuid URN qualifier (e.g. "uuid:" followed by a known tModel UUID value.; maxRows - This optional integer value allows the requesting program to limit the number of results returned.
Returns:: This function returns a bindingDetail message on success. In the event that no matches were located for the specified criteria, the bindingDetail structure returned in the response the will be empty (e.g. contain no bindingTemplate data.) In the even of a large number of matches, an Operator Site may truncate the result set. If this occurs, the response message will contain the truncated attribute with the value of this attribute set to true. Searching using tModelBag will also return any bindingTemplate information that matches due to hostingRedirector references. The resolved bindingTemplate structure will be returned, even if that bindingTemplate is owned by a different businessService structure.
Throws:: UDDIException; TransportException

find_business

public BusinessList find_business(java.lang.String name,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  TransportException

Deprecated. This method has been deprecated. Use find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int) instead

Find business matching specified criteria.

Parameters:: name - Partial business name to match. Leftmost match.; findQualifiers - Optional findQualifiers. null indicates no find qualifiers.; maxRows - Maximum number of results. 0 indicates no maximum.
Returns:: This function returns a businessList on success. In the event that no matches were located for the specified criteria, a businessList structure with zero businessInfo structures is returned.
Throws:: UDDIException - Contains a DispositionReport that indicates the error number.; TransportException - Thrown if non-UDDI related communication errors occur.

find_business

public BusinessList find_business(IdentifierBag identifierBag,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  TransportException

Deprecated. This method has been deprecated. Use find_business(Vector, DiscoveryURLs, IdentifierBag, CategoryBag, TModelBag, FindQualifiers, int) instead