org.wso2.carbon.discovery.client

Class DiscoveryClient

java.lang.Object

org.wso2.carbon.discovery.client.DiscoveryClient

public class DiscoveryClient
extends Object

The WS-Discovery client API. This API can be used to probe external discovery proxies by sending WS-D probe requests. Also it can be used to WS-D resolve requests. This API is a wrapper for the Axis2 client API. Therefore Axis2 modules such as Addressing and Rampart can be enagaged on the DiscoveryClient to support various QoS requirements. However since the ServiceClient API of Axis2 is not intended to be thread safe, it is not recommended to use this class as a shared instance in a multithreaded setting.

Constructor Summary

Constructors

Constructor and Description
DiscoveryClient(org.apache.axis2.context.ConfigurationContext cfgCtx, String proxyURL)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleanup the service client
void	engageModule(String module) Engage the named module on the Discovery client
TargetService[]	probe() Send a generic probe request to the Discovery proxy.
TargetService[]	probe(QName[] types, URI[] scopes) Send a probe request with the specified types and scopes to the discovery proxy.
TargetService[]	probe(QName[] types, URI[] scopes, String matchBy) Send a probe request with the specified types and scopes to the discovery proxy.
TargetService	resolve(String epr) Send a WS-Discovery resolve request for the given service ID
void	setProperty(String name, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryClient

public DiscoveryClient(org.apache.axis2.context.ConfigurationContext cfgCtx,
                       String proxyURL)
                throws DiscoveryException

Throws:

DiscoveryException

Method Detail

setProperty

public void setProperty(String name,
                        Object value)

engageModule

public void engageModule(String module)
                  throws DiscoveryException

Engage the named module on the Discovery client

Parameters:

module - Name of the module (eg: rampart)

Throws:

DiscoveryException - If an error occurs while engaging the named module

probe

public TargetService[] probe()
                      throws DiscoveryException

Send a generic probe request to the Discovery proxy. The probe request will not contain any scope information or type information on it and hence the proxy will return all the target services registered on the proxy.

Returns:

an array of TargetService objects

Throws:

DiscoveryException - if an error occured while contacting the WS-D proxy

probe

public TargetService[] probe(QName[] types,
                             URI[] scopes)
                      throws DiscoveryException

Send a probe request with the specified types and scopes to the discovery proxy. Default matching rule will be used to search for available target services.

Parameters:

types - Types to be included in the probe

scopes - Scopes to be included in the probe

Returns:

an array of TargetService objects

Throws:

DiscoveryException - if an error occured while contacting the WS-D proxy

probe

public TargetService[] probe(QName[] types,
                             URI[] scopes,
                             String matchBy)
                      throws DiscoveryException

Send a probe request with the specified types and scopes to the discovery proxy. The specified matching rule will be used to search for available target services.

Parameters:

types - Types to be included in the probe

scopes - Scopes to be included in the probe

matchBy - The matching rule for scopes

Returns:

an array of TargetService objects

Throws:

DiscoveryException - if an error occured while contacting the WS-D proxy

resolve

public TargetService resolve(String epr)
                      throws DiscoveryException

Send a WS-Discovery resolve request for the given service ID

Parameters:

epr - ID of the service to be resolved

Returns:

a TargetService object or null if the ID cannot be resolved

Throws:

DiscoveryException - if an error occured while contacting the WS-D proxy

cleanup

public void cleanup()
             throws DiscoveryException

Cleanup the service client

Throws:

DiscoveryException - on error