toolbox.uddi
Interface InquiryProxy

All Known Implementing Classes:

InquiryProxyJUDDIImpl, InquiryProxyOSRImpl

public interface InquiryProxy

Interface that defines a proxy for the UDDI Inquiry API. Implementations of this interface are responsible for abstracting the UDDI inquiry API from various UDDI implementations.

At present this interface is only focussed on returning information related to WSDL services.

Method Summary

void	destroy() Destroy this proxy instance.
ServiceInfo	findServiceInfo(java.lang.String provider, java.lang.String serviceName, java.lang.String namespace, java.lang.String portName) Search for a WSDL based service using the given parameters.
ServiceInfo	findServiceInfo(java.lang.String provider, java.lang.String serviceName, java.lang.String namespace, java.lang.String portName, AuthenticationContext ctx) Search for a WSDL based service using the given parameters and AuthenticationContext.
java.lang.String	getProviderKey(java.lang.String providerName) Return the UDDI key of the named provider (business).
java.lang.String	getProviderKey(java.lang.String providerName, AuthenticationContext ctx) Return the UDDI key of the named provider (business).
void	init(UDDIManager manager, java.util.Map props) Initialise this proxy with the given manager and configuration properties.

Method Detail

init

void init(UDDIManager manager,
          java.util.Map props)
          throws UDDIException

Initialise this proxy with the given manager and configuration properties.

Parameters:

manager - UDDIManager that created this proxy.

props - Map containing configuration properties.

Throws:

UDDIException - if the manager cannot be initialised.

findServiceInfo

ServiceInfo findServiceInfo(java.lang.String provider,
                            java.lang.String serviceName,
                            java.lang.String namespace,
                            java.lang.String portName)
                            throws UDDIException

Search for a WSDL based service using the given parameters.

Parameters:

provider - String containing the name of the service provider.

serviceName - String containing the name of the service.

namespace - String containing the XML namespace of the service.

portName - String containing the service port name.

Returns:

ServiceInfo instance or null if the service does not exist.

Throws:

UDDIException - if the search cannot be performed.

findServiceInfo

ServiceInfo findServiceInfo(java.lang.String provider,
                            java.lang.String serviceName,
                            java.lang.String namespace,
                            java.lang.String portName,
                            AuthenticationContext ctx)
                            throws UDDIException

Search for a WSDL based service using the given parameters and AuthenticationContext.

Parameters:

provider - String containing the name of the service provider.

serviceName - String containing the name of the service.

namespace - String containing the XML namespace of the service.

portName - String containing the service port name.

ctx - AuthenticationContext instance to use.

Returns:

ServiceInfo instance or null if the service does not exist.

Throws:

UDDIException - if the search cannot be performed.

getProviderKey

java.lang.String getProviderKey(java.lang.String providerName)
                                throws UDDIException

Return the UDDI key of the named provider (business).

Parameters:

providerName - String containing the provider name.

Returns:

String containing the UDDI key of the provider.

Throws:

UDDIException - if an exception occurs during lookup.

getProviderKey

java.lang.String getProviderKey(java.lang.String providerName,
                                AuthenticationContext ctx)
                                throws UDDIException

Return the UDDI key of the named provider (business).

Parameters:

providerName - String containing the provider name.

ctx - AuthenticationContext instance to use.

Returns:

String containing the UDDI key of the provider.

Throws:

UDDIException - if an exception occurs during lookup.

destroy

void destroy()

Destroy this proxy instance.