oracle.uddi.client
Class UddiClient

java.lang.Object
oracle.uddi.client.UddiAbstractClient
oracle.uddi.client.UddiClient

All Implemented Interfaces:

UddiClientMessageConstants

public class UddiClient

extends UddiAbstractClient

UddiClient provides a client-side interface to the UDDI registry. It exposes a method-call-based interface to the registry which can perform both the inquiry and publishing requests defined by the UDDI specification. Each UDDI SOAP/XML message is modeled as a method call, using an RPC-like mapping to ultimately communicate via the SOAP protocol with the UDDI registry. Furthermore, this class also exposes a small set of convenient wrapper methods over the standard UDDI messages.

Refer to the UDDI Home Page for specifications and more information about UDDI.

In its constructor, UddiClient takes an implementation of a SoapTransportLiaison. This is a transport implementation which handles the details of transporting the Soap message from client to server and receiving the results from the server. For example, Oracle provides an implementation that uses Oracle SOAP over the HTTP transport protocol to communicate from client to server.

In its constructor, UddiClient also takes an implementation of an AuthenticationLiaison. Authentication and session management are handled by the UddiClient interface object, which delegates some tasks to the AuthenticationLiaison implementation. In addition, session management, including but not limited to the standard UDDI 'authInfo' element in publishing messages, is managed by the UddiClient. This means that users do not need to worry about passing authInfo in all publishing messages; it is done transparently.

In its constructor, UddiClient also takes a UddiVersionConstants as an parameter, indicating the UDDI version that the client instance should use.

Field Summary

static java.lang.String

PROPERTY_DEFAULT_UDDI_VERSION The name of the JVM property, which specifies the default UDDI version to be used when version is not specified in the constructor.

Fields inherited from interface oracle.uddi.client.UddiClientMessageConstants

ERR_CATEGORY_MGMT, ERR_NULL_SOAP_BODY, ERR_UNMARSHALLING

Constructor Summary

UddiClient(java.lang.String inquiryUrl, java.lang.String publishingUrl, SoapTransportLiaison transport)
Constructor which allows the specification of the inquiry URL, publishing URL, and SOAP transport mechanism.

UddiClient(java.lang.String inquiryUrl, java.lang.String publishingUrl, SoapTransportLiaison transport, AuthenticationLiaison authLiaison)
Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, and authentication mechanism.

UddiClient(java.lang.String inquiryUrl, java.lang.String publishingUrl, SoapTransportLiaison transport, AuthenticationLiaison authLiaison, UddiVersionConstants version)
Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, authentication mechanism, and version.

UddiClient(java.lang.String inquiryUrl, java.lang.String publishingUrl, SoapTransportLiaison transport, UddiVersionConstants version)
Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, and version.

Method Summary

DispositionReport	addPublisherAssertion(PublisherAssertion publisherAssertion) Adds a single publisherAssertion.
DispositionReport	addPublisherAssertions(java.util.List listPublisherAssertion) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
void	authenticate() Authenticates the client to the registry in a registry-specific manner.
void	close() Closes the connection and frees up any dedicated resources.
DispositionReport	deleteBinding(java.util.List listBindingKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
DispositionReport	deleteBinding(java.lang.String bindingKey) Deletes a single bindingTemplate given a single bindingTemplate key.
DispositionReport	deleteBusiness(java.util.List listBusinessKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
DispositionReport	deleteBusiness(java.lang.String businessKey) Deletes a single businessEntity given a single businessEntity key.
DispositionReport	deletePublisherAssertion(PublisherAssertion publisherAssertion) Deletes a single publisherAssertion.
DispositionReport	deletePublisherAssertions(java.util.List listPublisherAssertion) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
DispositionReport	deleteService(java.util.List listServiceKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
DispositionReport	deleteService(java.lang.String serviceKey) Deletes a single businessService given a single businessService key.
DispositionReport	deleteTModel(java.util.List listTModelKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
DispositionReport	deleteTModel(java.lang.String tModelKey) Deletes a single tModel given a single tModel key.
DispositionReport	discardAuthToken() Discards the 'authToken' value which represents an authenticated session with the server.
BindingDetail	findBinding(FindQualifiers findQualifiers, java.lang.String serviceKey, TModelBag tModelbag, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(CategoryBag categoryBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(DiscoveryURLs discoveryURLs, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(IdentifierBag identifierBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(java.util.List listName, DiscoveryURLs discoveryURLs, IdentifierBag identifierBag, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(java.lang.String name, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessList	findBusiness(TModelBag tModelBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
RelatedBusinessesList	findRelatedBusinesses(java.lang.String businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
ServiceList	findService(java.lang.String businessKey, CategoryBag categoryBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
ServiceList	findService(java.lang.String businessKey, java.util.List listName, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
ServiceList	findService(java.lang.String businessKey, java.lang.String name, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
ServiceList	findService(java.lang.String businessKey, TModelBag tModelBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModelList	findTModel(CategoryBag categoryBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModelList	findTModel(IdentifierBag identifierBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModelList	findTModel(java.lang.String name, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModelList	findTModel(java.lang.String name, IdentifierBag identifierBag, CategoryBag categoryBag, FindQualifiers findQualifiers, java.lang.Integer maxRows) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
AssertionStatusReport	getAssertionStatusReport(java.lang.String completionStatus) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
AuthenticationLiaison	getAuthenticationLiaison() Returns the authentication implementation object that was supplied in the constructor.
java.lang.String	getAuthInfo() Returns the token of the authenticated session which is managed by the UddiClient.
AuthToken	getAuthToken(java.lang.String userid, java.lang.String cred) Gets the 'authToken' value which represents an authenticated session with the server.
BindingDetail	getBindingDetail(java.util.List listBindingKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BindingTemplate	getBindingTemplate(java.lang.String bindingKey) Gets a single BindingTemplate object given a single bindingTemplate key.
BusinessDetail	getBusinessDetail(java.util.List listBusinessKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessDetailExt	getBusinessDetailExt(java.util.List listBusinessKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessEntity	getBusinessEntity(java.lang.String businessKey) Gets a single BusinessEntity object given a single businessEntity key.
BusinessService	getBusinessService(java.lang.String serviceKey) Gets a single BusinessService object given a single businessService key.
java.lang.String	getInquiryUrl() Returns the inquiry URL for the UDDI registry that was specified in the constructor.
PublisherAssertions	getPublisherAssertions() Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
java.lang.String	getPublishingUrl() Returns the publishing URL for the UDDI registry that was specified in the constructor.
RegisteredInfo	getRegisteredInfo() Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
ServiceDetail	getServiceDetail(java.util.List listServiceKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModel	getTModel(java.lang.String tModelKey) Gets a single TModel object given a single tModel key.
TModelDetail	getTModelDetail(java.util.List listTModelKey) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
UddiElementFactory	getUddiElementFactory() Gets an instance of the factory to construct all data structures needed for all UDDI requests.
UddiVersionConstants	getVersion() Returns an object which encapsulates the version of UDDI supported by this implementation.
BindingTemplate	saveBinding(BindingTemplate bindingTemplate) Saves a single BindingTemplate object.
BindingDetail	saveBinding(java.util.List bindingTemplates) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessEntity	saveBusiness(BusinessEntity businessEntity) Saves a single BusinessEntity object.
BusinessDetail	saveBusiness(java.util.List businessEntities) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
BusinessDetail	saveBusinessWithRegisters(java.util.List uploadRegisters) Deprecated. it is not widely implemented in UDDIv1 and is formally deprecated in UDDIv2
BusinessService	saveService(BusinessService businessService) Saves a single BusinessService object.
ServiceDetail	saveService(java.util.List businessServices) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModelDetail	saveTModel(java.util.List tModels) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
TModel	saveTModel(TModel tModel) Saves a single TModel object.
TModelDetail	saveTModelWithRegisters(java.util.List uploadRegisters) Deprecated. it is not widely implemented in UDDIv1 and is formally deprecated in UDDIv2
PublisherAssertions	setPublisherAssertions(java.util.List listPublisherAssertion) Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details.
void	setVersion(UddiVersionConstants version) Set the UDDI version that the instance operates.

Methods inherited from class oracle.uddi.client.UddiAbstractClient

getSoapTransportLiaison, send, send

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_DEFAULT_UDDI_VERSION

public static final java.lang.String PROPERTY_DEFAULT_UDDI_VERSION

The name of the JVM property, which specifies the default UDDI version to be used when version is not specified in the constructor. The name is oracle.uddi.client.defaultVersion Currently the valid values are 1 or 2. If the property is not specified or the value is invalid, it is defaulted to the latest version.

See Also:

Constant Field Values

Constructor Detail

UddiClient

public UddiClient(java.lang.String inquiryUrl,
                  java.lang.String publishingUrl,
SoapTransportLiaison transport,
AuthenticationLiaison authLiaison)

Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, and authentication mechanism. The UDDI version used is dependent of the JVM property PROPERTY_DEFAULT_UDDI_VERSION.

Parameters:

inquiryUrl - the URL to the inquiry UDDI registry, null if inquiry is not needed.

publishingUrl - the URL to the publishing UDDI registry, null if publishing is not needed.

transport - the SOAP transport mechanism to connect to the designated URL.

authLiaison - the registry-specific authentication mechanism to be used.

UddiClient

public UddiClient(java.lang.String inquiryUrl,
                  java.lang.String publishingUrl,
SoapTransportLiaison transport,
AuthenticationLiaison authLiaison,
UddiVersionConstants version)

Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, authentication mechanism, and version.

Parameters:

inquiryUrl - the URL to the inquiry UDDI registry, null if inquiry is not needed.

publishingUrl - the URL to the publishing UDDI registry, null if publishing is not needed.

transport - the SOAP transport mechanism to connect to the designated URL.

authLiaison - the registry-specific authentication mechanism to be used.

version - the UDDI version to use for sending requests

UddiClient

public UddiClient(java.lang.String inquiryUrl,
                  java.lang.String publishingUrl,
SoapTransportLiaison transport)

Constructor which allows the specification of the inquiry URL, publishing URL, and SOAP transport mechanism. This is a convenience constructor which automatically uses a transport- specific authentication mechanism, namely the TransportAuthenticationLiaison.

Parameters:

inquiryUrl - the URL to the inquiry UDDI registry, null if inquiry is not needed.

publishingUrl - the URL to the publishing UDDI registry, null if publishing is not needed.

transport - the SOAP transport mechanism to connect to the designated URL.

UddiClient

public UddiClient(java.lang.String inquiryUrl,
                  java.lang.String publishingUrl,
SoapTransportLiaison transport,
UddiVersionConstants version)

Constructor which allows the specification of the inquiry URL, publishing URL, SOAP transport mechanism, and version. This is a convenience constructor which automatically uses a transport- specific authentication mechanism, namely the TransportAuthenticationLiaison.

Parameters:

inquiryUrl - the URL to the inquiry UDDI registry, null if inquiry is not needed.

publishingUrl - the URL to the publishing UDDI registry, null if publishing is not needed.

transport - the SOAP transport mechanism to connect to the designated URL.

version - the UDDI version to use for sending requests

Method Detail

getInquiryUrl

public java.lang.String getInquiryUrl()

Returns the inquiry URL for the UDDI registry that was specified in the constructor. It may be null.

getPublishingUrl

public java.lang.String getPublishingUrl()

Returns the publishing URL for the UDDI registry that was specified in the constructor. It may be null.

getVersion

public UddiVersionConstants getVersion()

Returns an object which encapsulates the version of UDDI supported by this implementation.

setVersion

public void setVersion(UddiVersionConstants version)

Set the UDDI version that the instance operates. This method allows an instance to send different versions of UDDI request in its life time.

Note: After setting the version, the caller should call getUddiElementFactory() again to get the appropriate UddiElementFactory instance for the version desired.

getUddiElementFactory

public UddiElementFactory getUddiElementFactory()

Gets an instance of the factory to construct all data structures needed for all UDDI requests. This factory object is required to create the objects (subclasses of UddiElement) necessary to make UDDI requests.

See Also:

setVersion(oracle.uddi.message.UddiVersionConstants)

getAuthenticationLiaison

public AuthenticationLiaison getAuthenticationLiaison()

Returns the authentication implementation object that was supplied in the constructor.

getAuthInfo

public java.lang.String getAuthInfo()

Returns the token of the authenticated session which is managed by the UddiClient.

authenticate

public void authenticate()
                  throws UddiClientException,
                         org.apache.soap.SOAPException

Authenticates the client to the registry in a registry-specific manner. This method is required for all operations that require authentication (UDDI publishing API) but is not required for operations that accept anonymous connections (UDDI inquiry API).

Throws:

UddiClientException

org.apache.soap.SOAPException

findBinding

public BindingDetail findBinding(FindQualifiers findQualifiers,
                                 java.lang.String serviceKey,
TModelBag tModelbag,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(java.lang.String name,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(IdentifierBag identifierBag,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(CategoryBag categoryBag,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(TModelBag tModelBag,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(DiscoveryURLs discoveryURLs,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findBusiness

public BusinessList findBusiness(java.util.List listName,
DiscoveryURLs discoveryURLs,
IdentifierBag identifierBag,
CategoryBag categoryBag,
TModelBag tModelBag,
FindQualifiers findQualifiers,
                                 java.lang.Integer maxRows)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

findRelatedBusinesses

public RelatedBusinessesList findRelatedBusinesses(java.lang.String businessKey,
KeyedReference keyedReference,
FindQualifiers findQualifiers)
                                            throws UddiClientException,
                                                   org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

findService

public ServiceList findService(java.lang.String businessKey,
                               java.lang.String name,
FindQualifiers findQualifiers,
                               java.lang.Integer maxRows)
                        throws UddiClientException,
                               org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findService

public ServiceList findService(java.lang.String businessKey,
CategoryBag categoryBag,
FindQualifiers findQualifiers,
                               java.lang.Integer maxRows)
                        throws UddiClientException,
                               org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findService

public ServiceList findService(java.lang.String businessKey,
TModelBag tModelBag,
FindQualifiers findQualifiers,
                               java.lang.Integer maxRows)
                        throws UddiClientException,
                               org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findService

public ServiceList findService(java.lang.String businessKey,
                               java.util.List listName,
CategoryBag categoryBag,
TModelBag tModelBag,
FindQualifiers findQualifiers,
                               java.lang.Integer maxRows)
                        throws UddiClientException,
                               org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

findTModel

public TModelList findTModel(java.lang.String name,
FindQualifiers findQualifiers,
                             java.lang.Integer maxRows)
                      throws UddiClientException,
                             org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findTModel

public TModelList findTModel(CategoryBag categoryBag,
FindQualifiers findQualifiers,
                             java.lang.Integer maxRows)
                      throws UddiClientException,
                             org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findTModel

public TModelList findTModel(IdentifierBag identifierBag,
FindQualifiers findQualifiers,
                             java.lang.Integer maxRows)
                      throws UddiClientException,
                             org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

findTModel

public TModelList findTModel(java.lang.String name,
IdentifierBag identifierBag,
CategoryBag categoryBag,
FindQualifiers findQualifiers,
                             java.lang.Integer maxRows)
                      throws UddiClientException,
                             org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

getBindingDetail

public BindingDetail getBindingDetail(java.util.List listBindingKey)
                               throws UddiClientException,
                                      org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Parameters:

listBindingKey - a list of String objects representing the unique keys of the desired result set

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getBusinessDetail

public BusinessDetail getBusinessDetail(java.util.List listBusinessKey)
                                 throws UddiClientException,
                                        org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Parameters:

listBusinessKey - a list of String objects representing the unique keys of the desired result set

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getBusinessDetailExt

public BusinessDetailExt getBusinessDetailExt(java.util.List listBusinessKey)
                                       throws UddiClientException,
                                              org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Parameters:

listBusinessKey - a list of String objects representing the unique keys of the desired result set

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getServiceDetail

public ServiceDetail getServiceDetail(java.util.List listServiceKey)
                               throws UddiClientException,
                                      org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Parameters:

listServiceKey - a list of String objects representing the unique keys of the desired result set

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getTModelDetail

public TModelDetail getTModelDetail(java.util.List listTModelKey)
                             throws UddiClientException,
                                    org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Inquiry API

Parameters:

listTModelKey - a list of String objects representing the unique keys of the desired result set

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getTModel

public TModel getTModel(java.lang.String tModelKey)
                 throws UddiClientException,
                        org.apache.soap.SOAPException

Gets a single TModel object given a single tModel key. This is a convenient helper method which is simpler to use than getTModelDetail() when you are retrieving data for a single tModel only.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getBindingTemplate

public BindingTemplate getBindingTemplate(java.lang.String bindingKey)
                                   throws UddiClientException,
                                          org.apache.soap.SOAPException

Gets a single BindingTemplate object given a single bindingTemplate key. This is a convenient helper method which is simpler to use than getBindingDetail() when you are retrieving data for a single bindingTemplate only.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getBusinessService

public BusinessService getBusinessService(java.lang.String serviceKey)
                                   throws UddiClientException,
                                          org.apache.soap.SOAPException

Gets a single BusinessService object given a single businessService key. This is a convenient helper method which is simpler to use than getServiceDetail() when you are retrieving data for a single businessService only.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getBusinessEntity

public BusinessEntity getBusinessEntity(java.lang.String businessKey)
                                 throws UddiClientException,
                                        org.apache.soap.SOAPException

Gets a single BusinessEntity object given a single businessEntity key. This is a convenient helper method which is simpler to use than getBusinessDetail() when you are retrieving data for a single businessEntity only.

Category: Inquiry API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

addPublisherAssertion

public DispositionReport addPublisherAssertion(PublisherAssertion publisherAssertion)
                                        throws UddiClientException,
                                               org.apache.soap.SOAPException

Adds a single publisherAssertion. This is a convenient helper method of the general method that adds a list of publisherAssertions.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

addPublisherAssertions

public DispositionReport addPublisherAssertions(java.util.List listPublisherAssertion)
                                         throws UddiClientException,
                                                org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

since UDDIv2

Throws:

UddiClientException

org.apache.soap.SOAPException

deleteBinding

public DispositionReport deleteBinding(java.lang.String bindingKey)
                                throws UddiClientException,
                                       org.apache.soap.SOAPException

Deletes a single bindingTemplate given a single bindingTemplate key. This is a convenient helper method which is simpler to use than its alternative form when you are deleting a single entity only.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteBinding

public DispositionReport deleteBinding(java.util.List listBindingKey)
                                throws UddiClientException,
                                       org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Parameters:

listBindingKey - a list of String objects representing the unique keys of the entities to delete

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteBusiness

public DispositionReport deleteBusiness(java.lang.String businessKey)
                                 throws UddiClientException,
                                        org.apache.soap.SOAPException

Deletes a single businessEntity given a single businessEntity key. This is a convenient helper method which is simpler to use than its alternative form when you are deleting a single entity only.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteBusiness

public DispositionReport deleteBusiness(java.util.List listBusinessKey)
                                 throws UddiClientException,
                                        org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Parameters:

listBusinessKey - a list of String objects representing the unique keys of the entities to delete

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deletePublisherAssertion

public DispositionReport deletePublisherAssertion(PublisherAssertion publisherAssertion)
                                           throws UddiClientException,
                                                  org.apache.soap.SOAPException

Deletes a single publisherAssertion. This is a convenient helper method of the general method that deletes a list of publisherAssertions.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

deletePublisherAssertions

public DispositionReport deletePublisherAssertions(java.util.List listPublisherAssertion)
                                            throws UddiClientException,
                                                   org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

deleteService

public DispositionReport deleteService(java.lang.String serviceKey)
                                throws UddiClientException,
                                       org.apache.soap.SOAPException

Deletes a single businessService given a single businessService key. This is a convenient helper method which is simpler to use than its alternative form when you are deleting a single entity only.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteService

public DispositionReport deleteService(java.util.List listServiceKey)
                                throws UddiClientException,
                                       org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Parameters:

listServiceKey - a list of String objects representing the unique keys of the entities to delete

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteTModel

public DispositionReport deleteTModel(java.lang.String tModelKey)
                               throws UddiClientException,
                                      org.apache.soap.SOAPException

Deletes a single tModel given a single tModel key. This is a convenient helper method which is simpler to use than its alternative form when you are deleting a single entity only.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

deleteTModel

public DispositionReport deleteTModel(java.util.List listTModelKey)
                               throws UddiClientException,
                                      org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Parameters:

listTModelKey - a list of String objects representing the unique keys of the entities to delete

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

discardAuthToken

public DispositionReport discardAuthToken()
                                   throws UddiClientException,
                                          org.apache.soap.SOAPException

Discards the 'authToken' value which represents an authenticated session with the server. This method is typically only used by an implementation of AuthenticationLiaison and SHOULD NOT be called directly by a user of the API.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getAssertionStatusReport

public AssertionStatusReport getAssertionStatusReport(java.lang.String completionStatus)
                                               throws UddiClientException,
                                                      org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Parameters:

completionStatus - an optional argument that lets the caller to restrict the result set to only those relationships that have the status value specified. The valid values are : AssertionStatusItem.COMPLETION_STATUS_COMPLETE, AssertionStatusItem.COMPLETION_STATUS_FROMKEY_INCOMPLETE, AssertionStatusItem.COMPLETION_STATUS_TOKEY_INCOMPLETE .

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

getAuthToken

public AuthToken getAuthToken(java.lang.String userid,
                              java.lang.String cred)
                       throws UddiClientException,
                              org.apache.soap.SOAPException

Gets the 'authToken' value which represents an authenticated session with the server. This method is typically only used by an implementation of AuthenticationLiaison and SHOULD NOT be called directly by a user of the API.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

getPublisherAssertions

public PublisherAssertions getPublisherAssertions()
                                           throws UddiClientException,
                                                  org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

getRegisteredInfo

public RegisteredInfo getRegisteredInfo()
                                 throws UddiClientException,
                                        org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveBinding

public BindingTemplate saveBinding(BindingTemplate bindingTemplate)
                            throws UddiException,
UddiClientException,
                                   org.apache.soap.SOAPException

Saves a single BindingTemplate object. This is a convenient helper method which is simpler to use than its alternative form when you are saving a single entity only.

Category: Publishing API

Throws:

UddiException

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveBinding

public BindingDetail saveBinding(java.util.List bindingTemplates)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveBusiness

public BusinessEntity saveBusiness(BusinessEntity businessEntity)
                            throws UddiException,
UddiClientException,
                                   org.apache.soap.SOAPException

Saves a single BusinessEntity object. This is a convenient helper method which is simpler to use than its alternative form when you are saving a single entity only.

Category: Publishing API

Throws:

UddiException

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveBusiness

public BusinessDetail saveBusiness(java.util.List businessEntities)
                            throws UddiClientException,
                                   org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Note: This method should only be used for the save_business request in which businessEntity information is provided. To use the save_business request in which uploadRegisters are used to reference the business information, use the saveBusinessWithRegisters(List) method instead.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveBusinessWithRegisters

public BusinessDetail saveBusinessWithRegisters(java.util.List uploadRegisters)
                                         throws UddiClientException,
                                                org.apache.soap.SOAPException

Deprecated. it is not widely implemented in UDDIv1 and is formally deprecated in UDDIv2

Saves the businessEntity objects referred to by the list of UploadRegister objects provided. This method maps directly to the UDDI standard API 'save_business'; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Note: This method should only be used for the save_business request in which uploadRegisters are used to reference the business information. To use the save_business request in which businessEntity information is provided, use the saveBusiness(List) method instead.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

saveService

public BusinessService saveService(BusinessService businessService)
                            throws UddiException,
UddiClientException,
                                   org.apache.soap.SOAPException

Saves a single BusinessService object. This is a convenient helper method which is simpler to use than its alternative form when you are saving a single entity only.

Category: Publishing API

Throws:

UddiException

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveService

public ServiceDetail saveService(java.util.List businessServices)
                          throws UddiClientException,
                                 org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveTModel

public TModel saveTModel(TModel tModel)
                  throws UddiException,
UddiClientException,
                         org.apache.soap.SOAPException

Saves a single TModel object. This is a convenient helper method which is simpler to use than its alternative form when you are saving a single entity only.

Category: Publishing API

Throws:

UddiException

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveTModel

public TModelDetail saveTModel(java.util.List tModels)
                        throws UddiClientException,
                               org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Note: This method should only be used for the save_tModel request in which tModel information is provided. To use the save_tModel request in which uploadRegisters are used to reference the tModel information, use the saveTModelWithRegisters(List) method instead.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv1

saveTModelWithRegisters

public TModelDetail saveTModelWithRegisters(java.util.List uploadRegisters)
                                     throws UddiClientException,
                                            org.apache.soap.SOAPException

Deprecated. it is not widely implemented in UDDIv1 and is formally deprecated in UDDIv2

Saves the tModel objects referred to by the list of UploadRegister objects provided. This method maps directly to the UDDI standard API 'save_tModel'; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Note: This method should only be used for the save_tModel request in which uploadRegisters are used to reference the tModel information. To use the save_tModel request in which tModel information is provided, use the saveTModel(List) method instead.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

setPublisherAssertions

public PublisherAssertions setPublisherAssertions(java.util.List listPublisherAssertion)
                                           throws UddiClientException,
                                                  org.apache.soap.SOAPException

Maps directly to a UDDI standard API of the same name; see the specifications available at the UDDI Home Page for semantic details. As a general rule, optional parameters can be null.

Category: Publishing API

Throws:

UddiClientException

org.apache.soap.SOAPException

Since:

UDDIv2

close

public void close()
           throws UddiClientException,
                  org.apache.soap.SOAPException

Closes the connection and frees up any dedicated resources. It should always be called when use of this object is no longer needed. Closing a UddiClient object which is already closed should not raise any Throwable conditions.

Overrides:

close in class UddiAbstractClient

Throws:

UddiClientException

org.apache.soap.SOAPException