org.wso2.carbon.discovery

Class DiscoveryAdmin

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.discovery.DiscoveryAdmin

public class DiscoveryAdmin
extends org.wso2.carbon.core.AbstractAdmin

Admin service implementation for managing WS-Discovery proxies, connecting to external WS-D proxies and using its web service API.

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
DiscoveryAdmin()

Method Summary

Modifier and Type	Method and Description
void	addDiscoveryProxy(DiscoveryProxyDetails pd) Add a new WS-D proxy to the system configuration.
void	disableServiceDiscovery(boolean sendBye) Disable publishing services using WS-Discovery
void	enableServiceDiscovery(String proxyURL) Enable publishing services using WS-Discovery to the specified Discovery proxy
DiscoveryProxyDetails[]	getDiscoveryProxies() Get all the WS-D proxies configured.
DiscoveryProxyDetails	getDiscoveryProxy(String name) Get the WS-D proxy description for the specified name
ServiceDiscoveryConfig	getServiceDiscoveryConfig() Get the current service discovery configuration
TargetServiceDetails[]	probeDiscoveryProxy(String name, ProbeDetails probe) Probe the specified WS-D proxy to search for target services discovered
void	removeDiscoveryProxy(String name) Remove the specified WS-D proxy from the configuration
TargetServiceDetails	resolveTargetService(String name, String serviceId) Contact the specified the WS-D proxy and resolve the service with the specified service ID
void	updateDiscoveryProxy(DiscoveryProxyDetails pd) Update an existing WS-D proxy configuration.

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryAdmin

public DiscoveryAdmin()

Method Detail

addDiscoveryProxy

public void addDiscoveryProxy(DiscoveryProxyDetails pd)
                       throws Exception

Add a new WS-D proxy to the system configuration. A WS-D proxy is identified by a unique name and must contain a valid target URL.

Parameters:

pd - WS-D proxy details

Throws:

Exception - on error

removeDiscoveryProxy

public void removeDiscoveryProxy(String name)
                          throws Exception

Remove the specified WS-D proxy from the configuration

Parameters:

name - Name of the proxy to be removed

Throws:

Exception - on error

updateDiscoveryProxy

public void updateDiscoveryProxy(DiscoveryProxyDetails pd)
                          throws Exception

Update an existing WS-D proxy configuration. This will overwrite any previous settings.

Parameters:

pd - the updated WS-D proxy configuration

Throws:

Exception - on error

getDiscoveryProxies

public DiscoveryProxyDetails[] getDiscoveryProxies()
                                            throws Exception

Get all the WS-D proxies configured.

Returns:

an array of WS-D proxy descriptions or null if no proxies are configured

Throws:

Exception - on error

getDiscoveryProxy

public DiscoveryProxyDetails getDiscoveryProxy(String name)
                                        throws Exception

Get the WS-D proxy description for the specified name

Parameters:

name - Name of the proxy

Returns:

a WS-D proxy description or null if no such proxy exists

Throws:

Exception - on error

probeDiscoveryProxy

public TargetServiceDetails[] probeDiscoveryProxy(String name,
                                                  ProbeDetails probe)
                                           throws Exception

Probe the specified WS-D proxy to search for target services discovered

Parameters:

name - Name of the proxy to be probed

probe - Probe description containing the search criteria

Returns:

an array of target service descriptions or null

Throws:

Exception - on error

resolveTargetService

public TargetServiceDetails resolveTargetService(String name,
                                                 String serviceId)
                                          throws Exception

Contact the specified the WS-D proxy and resolve the service with the specified service ID

Parameters:

name - Name of the WS-D proxy to be used

serviceId - ID of the service to be resolved

Returns:

a target service description or null

Throws:

Exception - on error

getServiceDiscoveryConfig

public ServiceDiscoveryConfig getServiceDiscoveryConfig()
                                                 throws Exception

Get the current service discovery configuration

Returns:

a ServiceDiscoveryConfig instance

Throws:

Exception - on error

enableServiceDiscovery

public void enableServiceDiscovery(String proxyURL)
                            throws Exception

Enable publishing services using WS-Discovery to the specified Discovery proxy

Parameters:

proxyURL - URL of the target discovery proxy

Throws:

Exception - on error

disableServiceDiscovery

public void disableServiceDiscovery(boolean sendBye)
                             throws Exception

Disable publishing services using WS-Discovery

Parameters:

sendBye - true is BYE messages should be sent before disabling WS-Discovery

Throws:

Exception - on error