com.ibm.uddi.client
Class UDDIProxy

java.lang.Object
  |
  +--com.ibm.uddi.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

Constructor Summary
UDDIProxy()
          Default constructor.
UDDIProxy(java.net.URL inquiryURL, java.net.URL publishURL, org.apache.soap.transport.SOAPTransport transport)
          Construct a UDDIProxy object.
 
Method Summary
 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_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.
 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 bag, FindQualifiers findQualifiers, int maxRows)
          The find_business message returns a businessList message that matches the conditions specified in the arguments.
 BusinessList find_business(DiscoveryURLs bag, FindQualifiers findQualifiers, int maxRows)
          The find_business message returns a businessList message that matches the conditions specified in the arguments.
 BusinessList find_business(IdentifierBag bag, FindQualifiers findQualifiers, int maxRows)
          The find_business message returns a businessList message that matches the conditions specified in the arguments.
 BusinessList find_business(java.lang.String name, FindQualifiers findQualifiers, int maxRows)
          Find business matching specified criteria.
 BusinessList find_business(TModelBag bag, FindQualifiers findQualifiers, int maxRows)
          The find_business message returns a businessList message that matches the conditions specified in the arguments.
 ServiceList find_service(java.lang.String businessKey, CategoryBag bag, FindQualifiers findQualifiers, int maxRows)
          This function returns a serviceList on success.
 ServiceList find_service(java.lang.String businessKey, java.lang.String name, FindQualifiers findQualifiers, int maxRows)
          This function returns a serviceList on success.
 ServiceList find_service(java.lang.String businessKey, TModelBag bag, FindQualifiers findQualifiers, int maxRows)
          This function returns a serviceList on success.
 TModelList find_tModel(CategoryBag bag, 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(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)
          This find_tModel message is for locating a list of tModel entries that match a set of specific criteria.
 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.
 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.
 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)
          The save_business message is used to save or update information about a complete businessEntity structure.
 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)
          The save_tModel message adds or updates one or more tModel structures.
 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.
 void setInquiryURL(java.lang.String 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 setTransport(org.apache.soap.transport.SOAPTransport transport)
          Specifies the SOAP Transport to use.
 DispositionReport validate_categorization(java.lang.String tModelKey, java.lang.String keyValueString, BusinessEntity businessEntity)
          The validate_categorization service performs two functions.
 DispositionReport validate_categorization(java.lang.String tModelKey, java.lang.String keyValueString, BusinessService businessService)
          The validate_categorization service performs two functions.
 DispositionReport validate_categorization(java.lang.String tModelKey, java.lang.String keyValueString, TModel tModel)
          The validate_categorization service performs two functions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UDDIProxy

public UDDIProxy()
Default constructor.

UDDIProxy

public UDDIProxy(java.net.URL inquiryURL,
                 java.net.URL publishURL,
                 org.apache.soap.transport.SOAPTransport transport)
Construct a UDDIProxy object.
Parameters:
inquiryURL - URL to be used for inquiry requests.
publishURL - URL to be used for publish requests.
transport - null indicates standard HTTP transport. Can pass in a different transport to use.
Method Detail

setTransport

public void setTransport(org.apache.soap.transport.SOAPTransport transport)
Specifies the SOAP Transport to use. If not set, defaults to the standard HTTP transport.
Parameters:
transport -  

setInquiryURL

public void setInquiryURL(java.lang.String url)
                   throws java.net.MalformedURLException
Set the URL to be used for inquiry requests.
Parameters:
url -  
Throws:
java.net.MalformedURLException -  

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.

find_binding

public BindingDetail find_binding(FindQualifiers findQualifiers,
                                  java.lang.String serviceKey,
                                  TModelBag tmodelbag,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
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 tModel bag 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 -  
org.apache.soap.SOAPException -  

find_business

public BusinessList find_business(java.lang.String name,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
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.
org.apache.soap.SOAPException - Thrown if non-UDDI related communication errors occur.

find_business

public BusinessList find_business(IdentifierBag bag,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The find_business message returns a businessList message that matches the conditions specified in the arguments.
Parameters:
bag - This is a list of business identifier references. The returned businessList contains businessInfo structures matching any of the identifiers passed (logical OR).
findQualifiers - can be used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
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 -  
org.apache.soap.SOAPException -  

find_business

public BusinessList find_business(CategoryBag bag,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The find_business message returns a businessList message that matches the conditions specified in the arguments.
Parameters:
bag - This is a list of category references. The returned businessList contains businessInfo structures matching all of the categories passed (logical AND).
findQualifiers - can be used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
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 -  
org.apache.soap.SOAPException -  

find_business

public BusinessList find_business(TModelBag bag,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The find_business message returns a businessList message that matches the conditions specified in the arguments.
Parameters:
bag - The registered businessEntity data contains bindingTemplates that in turn contain specific tModel references. The tModelBag argument lets you search for businesses that have bindings that are compatible with a specific tModel pattern. The returned businessList contains businessInfo structures that match all of the tModel keys passed (logical AND). tModelKey values must be formatted as URN qualified UUID values (e.g. prefixed with "uuid:")
findQualifiers - can be used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
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 -  
org.apache.soap.SOAPException -  

find_business

public BusinessList find_business(DiscoveryURLs bag,
                                  FindQualifiers findQualifiers,
                                  int maxRows)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The find_business message returns a businessList message that matches the conditions specified in the arguments.
Parameters:
bag - This is a list of URL's to be matched against the data associated with the discoveryURL's contents of registered businessEntity information. To search for URL without regard to useType attribute values, pass the useType component of the discoveryURL elements as empty attributes. If useType values are included, then the match will be made only on registered information that match both the useType and URL value. The returned businessList contains businessInfo structures matching any of the URL's passed (logical OR).
findQualifiers - can be used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
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 -  
org.apache.soap.SOAPException -  

find_service

public ServiceList find_service(java.lang.String businessKey,
                                java.lang.String name,
                                FindQualifiers findQualifiers,
                                int maxRows)
                         throws UDDIException,
                                org.apache.soap.SOAPException
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Parameters:
businessKey - used to specify a particular BusinessEntity instance.
name - Represents a partial name. Any businessService data contained in the specified businessEntity with a matching partial name value gets returned.
findQualifiers - Used to alter the default behavior of search functionality.
maxRows - Allows the requesting program to limit the number of results returned. A value of 0 indicates no limit.
Returns:
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

find_service

public ServiceList find_service(java.lang.String businessKey,
                                CategoryBag bag,
                                FindQualifiers findQualifiers,
                                int maxRows)
                         throws UDDIException,
                                org.apache.soap.SOAPException
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Parameters:
businessKey - This uuid_key is used to specify a particular BusinessEntity instance.
bag - This is a list of category references. The returned serviceList contains businessInfo structures matching all of the categories passed (logical AND).
findQualifiers - used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
Returns:
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

find_service

public ServiceList find_service(java.lang.String businessKey,
                                TModelBag bag,
                                FindQualifiers findQualifiers,
                                int maxRows)
                         throws UDDIException,
                                org.apache.soap.SOAPException
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Parameters:
businessKey - This uuid_key is used to specify a particular BusinessEntity instance.
bag -  
findQualifiers - used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
Returns:
This function returns a serviceList on success. In the event that no matches were located for the specified criteria, the serviceList structure returned will contain an empty businessServices structure.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

find_tModel

public TModelList find_tModel(java.lang.String name,
                              FindQualifiers findQualifiers,
                              int maxRows)
                       throws UDDIException,
                              org.apache.soap.SOAPException
This find_tModel message is for locating a list of tModel entries that match a set of specific criteria. The response will be a list of abbreviated information about tModels that match the criteria (tModelList).
Parameters:
name - This string value represents a partial name. The returned tModelList contains tModelInfo structures for businesses whose name matches the value passed (leftmost match).
findQualifiers - used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
Returns:
This function returns a tModelList on success. In the event that no matches were located for the specified criteria, an empty tModelList object will be returned (e.g. will contain zero tModelInfo objects). This signifies zero matches
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

find_tModel

public TModelList find_tModel(CategoryBag bag,
                              FindQualifiers findQualifiers,
                              int maxRows)
                       throws UDDIException,
                              org.apache.soap.SOAPException
This find_tModel message is for locating a list of tModel entries that match a set of specific criteria. The response will be a list of abbreviated information about tModels that match the criteria (tModelList).
Parameters:
bag - This is a list of category references. The returned tModelList contains tModelInfo structures matching all of the categories passed (logical AND).
findQualifiers - used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
Returns:
This function returns a tModelList on success. In the event that no matches were located for the specified criteria, an empty tModelList object will be returned (e.g. will contain zero tModelInfo objects). This signifies zero matches
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

find_tModel

public TModelList find_tModel(IdentifierBag identifierBag,
                              FindQualifiers findQualifiers,
                              int maxRows)
                       throws UDDIException,
                              org.apache.soap.SOAPException
This find_tModel message is for locating a list of tModel entries that match a set of specific criteria. The response will be a list of abbreviated information about tModels that match the criteria (tModelList).
Parameters:
identifierBag - This is a list of business identifier references. The returned tModelList contains tModelInfo structures matching any of the identifiers passed (logical OR).
findQualifiers - used to alter the default behavior of search functionality.
maxRows - allows the requesting program to limit the number of results returned.
Returns:
This function returns a tModelList on success. In the event that no matches were located for the specified criteria, an empty tModelList object will be returned (e.g. will contain zero tModelInfo objects). This signifies zero matches.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_bindingDetail

public BindingDetail get_bindingDetail(java.lang.String bindingKey)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The get_bindingDetail message is for requesting the run-time bindingTemplate information location information for the purpose of invoking a registered business API.
Parameters:
bindingKey - uuid_key string that represent specific instance of known bindingTemplate data.
Returns:
This function returns a bindingDetail message on successful match
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_bindingDetail

public BindingDetail get_bindingDetail(java.util.Vector bindingKeyStrings)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The get_bindingDetail message is for requesting the run-time bindingTemplate information location information for the purpose of invoking a registered business API.
Parameters:
bindingKey - Vector of uuid_key strings that represent specific instances of known bindingTemplate data.
Returns:
This function returns a bindingDetail message on successful match of one or more bindingKey values. If multiple bindingKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_businessDetail

public BusinessDetail get_businessDetail(java.lang.String businessKey)
                                  throws UDDIException,
                                         org.apache.soap.SOAPException
The get_businessDetail message returns complete businessEntity information for one or more specified businessEntitys
Parameters:
businessKey - A uuid_key string that represents a specific instance of known businessEntity data.
Returns:
This function returns a businessDetail object on successful match of one or more businessKey values. If multiple businessKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_businessDetail

public BusinessDetail get_businessDetail(java.util.Vector businessKeyStrings)
                                  throws UDDIException,
                                         org.apache.soap.SOAPException
The get_businessDetail message returns complete businessEntity information for one or more specified businessEntitys
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of known businessEntity data.
Returns:
This function returns a businessDetail message on successful match of one or more businessKey values. If multiple businessKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_businessDetailExt

public BusinessDetailExt get_businessDetailExt(java.lang.String businessKey)
                                        throws UDDIException,
                                               org.apache.soap.SOAPException
The get_businessDetailExt message returns extended businessEntity information for one or more specified businessEntitys. This message returns exactly the same information as the get_businessDetail message, but may contain additional attributes if the source is an external registry (not an Operator Site) that is compatible with this API specification.
Parameters:
businessKey - A uuid_key string that represents a specific instance of known businessEntity data.
Returns:
This function returns a businessDetailExt message on successful match of one or more businessKey values. If multiple businessKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_businessDetailExt

public BusinessDetailExt get_businessDetailExt(java.util.Vector businessKeyStrings)
                                        throws UDDIException,
                                               org.apache.soap.SOAPException
The get_businessDetailExt message returns extended businessEntity information for one or more specified businessEntitys. This message returns exactly the same information as the get_businessDetail message, but may contain additional attributes if the source is an external registry (not an Operator Site) that is compatible with this API specification.
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of known businessEntity data.
Returns:
This function returns a businessDetailExt message on successful match of one or more businessKey values. If multiple businessKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_serviceDetail

public ServiceDetail get_serviceDetail(java.lang.String serviceKey)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The get_serviceDetail message is used to request full information about a known businessService structure.
Parameters:
serviceKey - A uuid_key string that represents a specific instance of known businessService data.
Returns:
This function returns a serviceDetail message on successful match of one or more serviceKey values. If multiple serviceKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_serviceDetail

public ServiceDetail get_serviceDetail(java.util.Vector serviceKeyStrings)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The get_serviceDetail message is used to request full information about a known businessService structure.
Parameters:
serviceKeyStrings - A vector of uuid_key strings that represent specific instances of known businessService data.
Returns:
This function returns a serviceDetail message on successful match of one or more serviceKey values. If multiple serviceKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_tModelDetail

public TModelDetail get_tModelDetail(java.lang.String tModelKey)
                              throws UDDIException,
                                     org.apache.soap.SOAPException
The get_tModelDetail message is used to request full information about a known tModel structure.
Parameters:
tModelKey - A URN qualified uuid_key string that represent a specific instance of known tModel data. All tModelKey values begin with a uuid URN qualifier (e.g. "uuid:" followed by a known tModel UUID value.)
Returns:
This function returns a tModelDetail message on successful match of one or more tModelKey values. If multiple tModelKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_tModelDetail

public TModelDetail get_tModelDetail(java.util.Vector tModelKeyStrings)
                              throws UDDIException,
                                     org.apache.soap.SOAPException
The get_tModelDetail message is used to request full information about a known tModel structure.
Parameters:
tModelKeyStrings - A Vector of URN qualified uuid_key strings that represent specific instances of known tModel data. All tModelKey values begin with a uuid URN qualifier (e.g. "uuid:" followed by a known tModel UUID value.)
Returns:
This function returns a tModelDetail message on successful match of one or more tModelKey values. If multiple tModelKey values were passed, the results will be returned in the same order as the keys passed.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_binding

public DispositionReport delete_binding(java.lang.String authInfo,
                                        java.lang.String bindingKey)
                                 throws UDDIException,
                                        org.apache.soap.SOAPException
The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
bindingKey - A uuid_key value that represents a specific instance of known bindingTemplate data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_binding

public DispositionReport delete_binding(java.lang.String authInfo,
                                        java.util.Vector bindingKeyStrings)
                                 throws UDDIException,
                                        org.apache.soap.SOAPException
The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
bindingKeyStrings - A vector of uuid_key strings that represents specific instances of known bindingTemplate data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_business

public DispositionReport delete_business(java.lang.String authInfo,
                                         java.lang.String businessKey)
                                  throws UDDIException,
                                         org.apache.soap.SOAPException
The delete_business message is used to remove one or more businessEntity structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
businessKey - Uuid_key string that represents specific instance of known businessEntity data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_business

public DispositionReport delete_business(java.lang.String authInfo,
                                         java.util.Vector businessKeyStrings)
                                  throws UDDIException,
                                         org.apache.soap.SOAPException
The delete_business message is used to remove one or more businessEntity structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
businessKeyStrings - Vector of uuid_key strings that represent specific instances of known businessEntity data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_service

public DispositionReport delete_service(java.lang.String authInfo,
                                        java.lang.String serviceKey)
                                 throws UDDIException,
                                        org.apache.soap.SOAPException
The delete_service message is used to remove one or more businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
serviceKey - uuid_key string that represents specific instance of known businessService data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_service

public DispositionReport delete_service(java.lang.String authInfo,
                                        java.util.Vector serviceKeyStrings)
                                 throws UDDIException,
                                        org.apache.soap.SOAPException
The delete_service message is used to remove one or more businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
serviceKeyStrings - Vector of uuid_key strings that represent specific instances of known businessService data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_tModel

public DispositionReport delete_tModel(java.lang.String authInfo,
                                       java.lang.String tModelKey)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The delete_tModel message is used to remove or retire one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
tModelKey - uuid_key string that represents specific instance of known tModel data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

delete_tModel

public DispositionReport delete_tModel(java.lang.String authInfo,
                                       java.util.Vector tModelKeyStrings)
                                throws UDDIException,
                                       org.apache.soap.SOAPException
The delete_tModel message is used to remove or retire one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
tModelKeyStrings - Vector of uuid_key strings that represent specific instances of known tModel data.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

discard_authToken

public DispositionReport discard_authToken(AuthInfo authInfo)
                                    throws UDDIException,
                                           org.apache.soap.SOAPException
The discard_authToken message is used to inform an Operator Site that the authentication token can be discarded. Subsequent calls that use the same authToken may be rejected. This message is optional for Operator Sites that do not manage session state or that do not support the get_authToken message.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator. Discarding an expired authToken will be processed and reported as a success condition.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_authToken

public AuthToken get_authToken(java.lang.String userid,
                               java.lang.String cred)
                        throws UDDIException,
                               org.apache.soap.SOAPException
The get_authToken message is used to obtain an authentication token. Authentication tokens are opaque values that are required for all other publisher API calls. This message is not required for Operator Sites that have an external mechanism defined for users to get an authentication token. This API is provided for implementations that do not have some other method of obtaining an authentication token or certificate, or that choose to use userID and Password based authentication.
Parameters:
userid - user that an individual authorized user was assigned by an Operator Site. Operator Sites will each provide a way for individuals to obtain a UserID and password that will be valid only at the given Operator Site.
cred - password or credential that is associated with the user.
Returns:
This function returns an authToken object that contains a valid authInfo object that can be used in subsequent calls to publisher API calls that require an authInfo value.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

get_registeredInfo

public RegisteredInfo get_registeredInfo(java.lang.String authInfo)
                                  throws UDDIException,
                                         org.apache.soap.SOAPException
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.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken API call.
Returns:
Upon successful completion, a registeredInfo object will be returned, listing abbreviated business information in one or more businessInfo objects, and tModel information in one or more tModelInfo objects. This API is useful for determining the full extent of registered information controlled by a single user in a single call.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_binding

public BindingDetail save_binding(java.lang.String authInfo,
                                  java.util.Vector bindingTemplates)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The save_binding message is used to save or update a complete bindingTemplate structure. This message can be used to add or update one or more bindingTemplate structures to one or more existing businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
bindingTemplates - Vector of bindingTemplate objects. The order in which these are processed is not defined. To save a new bindingTemplate, pass a bindingTemplate object with an empty bindingKey attribute value.
Returns:
This API returns a bindingDetail object containing the final results of the call that reflects the newly registered information for the effected bindingTemplate objects.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_business

public BusinessDetail save_business(java.lang.String authInfo,
                                    java.util.Vector businessEntities)
                             throws UDDIException,
                                    org.apache.soap.SOAPException
The save_business message is used to save or update information about a complete businessEntity structure. This API has the broadest scope of all of the save_x API calls in the publisher API, and can be used to make sweeping changes to the published information for one or more businessEntity structures controlled by an individual.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
businessEntities - Vector of businessEntity objects. These objects can be obtained in advance by using the get_businessDetail API call or by any other means.
Returns:
This API returns a businessDetail message containing the final results of the call that reflects the new registered information for the businessEntity information provided.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_business

public BusinessDetail save_business(java.lang.String authInfo,
                                    UploadRegister[] uploadRegisters)
                             throws UDDIException,
                                    org.apache.soap.SOAPException
The save_business message is used to save or update information about a complete businessEntity structure. This API has the broadest scope of all of the save_x API calls in the publisher API, and can be used to make sweeping changes to the published information for one or more businessEntity structures controlled by an individual.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
uploadRegisters - Vector of UpLoadRegister objects which contain resolvable HTTP URL addresses that each point to a single and valid businessEntity or businessEntityExt structure. This allows a registry to be updated to reflect the contents of an XML document that is URL addressable. The URL must return a pure XML document that only contains a businessEntity structure as its top-level element, and be accessible using the standard HTTP-GET protocol.
Returns:
This API returns a businessDetail message containing the final results of the call that reflects the new registered information for the businessEntity information provided.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_service

public ServiceDetail save_service(java.lang.String authInfo,
                                  java.util.Vector businessServices)
                           throws UDDIException,
                                  org.apache.soap.SOAPException
The save_service message adds or updates one or more businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
businessServices - Vector of businessService objects. These objects can be obtained in advance by using the get_serviceDetail API call or by any other means.
Returns:
This API returns a serviceDetail object containing the final results of the call that reflects the newly registered information for the effected businessService structures.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_tModel

public TModelDetail save_tModel(java.lang.String authInfo,
                                java.util.Vector tModels)
                         throws UDDIException,
                                org.apache.soap.SOAPException
The save_tModel message adds or updates one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
tModels - Vector of complete tModel structures. If adding a new tModel, the tModelKey value should be passed as an empty element.
Returns:
This API returns a tModelDetail message containing the final results of the call that reflects the new registered information for the effected tModel structures
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

save_tModel

public TModelDetail save_tModel(java.lang.String authInfo,
                                UploadRegister[] uploadRegisters)
                         throws UDDIException,
                                org.apache.soap.SOAPException
The save_tModel message adds or updates one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtained using the get_authToken method.
uploadRegisters - Vector of UploadRegister objects that contain resolvable HTTP URL addresses that each point to a single and valid tModel structure. This allows a registry to be updated to reflect the contents of an XML document that is URL addressable. The URL must return a pure XML document that only contains a tModel structure as its top-level element, and be accessible using the standard HTTP-GET protocol.
Returns:
This API returns a tModelDetail message containing the final results of the call that reflects the new registered information for the effected tModel structures
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

validate_categorization

public DispositionReport validate_categorization(java.lang.String tModelKey,
                                                 java.lang.String keyValueString,
                                                 BusinessEntity businessEntity)
                                          throws UDDIException,
                                                 org.apache.soap.SOAPException
The validate_categorization service performs two functions. It is used to verify that a specific category (keyValue) exists within the given taxonomy. The service also optionally restricts the entities that may be classified within the category.
Parameters:
tModelKey - The identifier of a registered tModel that is used as a namespace qualifier that implies a specific taxonomy.
keyValueString - The category identifier of the category within the identified taxonomy.
businessEntity - The businessEntity structure being categorized
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

validate_categorization

public DispositionReport validate_categorization(java.lang.String tModelKey,
                                                 java.lang.String keyValueString,
                                                 BusinessService businessService)
                                          throws UDDIException,
                                                 org.apache.soap.SOAPException
The validate_categorization service performs two functions. It is used to verify that a specific category (keyValue) exists within the given taxonomy. The service also optionally restricts the entities that may be classified within the category.
Parameters:
tModelKey - The identifier of a registered tModel that is used as a namespace qualifier that implies a specific taxonomy.
keyValueString - The category identifier of the category within the identified taxonomy.
businessService - The business service structure being categorized.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

validate_categorization

public DispositionReport validate_categorization(java.lang.String tModelKey,
                                                 java.lang.String keyValueString,
                                                 TModel tModel)
                                          throws UDDIException,
                                                 org.apache.soap.SOAPException
The validate_categorization service performs two functions. It is used to verify that a specific category (keyValue) exists within the given taxonomy. The service also optionally restricts the entities that may be classified within the category.
Parameters:
tModelKey - The identifier of a registered tModel that is used as a namespace qualifier that implies a specific taxonomy.
keyValueString - The category identifier of the category within the identified taxonomy.
tModel - The tModel structure being categorized.
Returns:
Upon successful completion, a dispositionReport is returned with a single success indicator.
Throws:
UDDIException -  
org.apache.soap.SOAPException -  

send

public org.w3c.dom.Element send(UDDIElement el,
                                boolean inquiry)
                         throws org.apache.soap.SOAPException
Sends a UDDIElement to either the inquiry or publish URL.
Parameters:
el -  
inquiry -  
Returns:
An element representing a XML DOM tree containing the UDDI response.
Throws:
org.apache.soap.SOAPException -  

send

public org.w3c.dom.Element send(org.w3c.dom.Element el,
                                boolean inquiry)
                         throws org.apache.soap.SOAPException
Sends an XML DOM tree indentified by the given element to either the inquiry or publish URL.
Parameters:
el -  
inquiry -  
Returns:
An element representing a XML DOM tree containing the UDDI response.
Throws:
org.apache.soap.SOAPException -  


Copyright © 2001, International Business Machines Corporation. All Rights Reserved.