org.wso2.carbon.discovery.util

Class DiscoveryMgtUtils

java.lang.Object

org.wso2.carbon.discovery.util.DiscoveryMgtUtils

public class DiscoveryMgtUtils
extends Object

Utility class which handles WS-Discovery management activities such as managing WS-D proxy configurations and contacting remote WS-Discovery proxies to obtain service information. All the configurations managed by this class are stored in the configuration registry of Carbon.

Constructor Summary

Constructors

Constructor and Description
DiscoveryMgtUtils()

Method Summary

Modifier and Type	Method and Description
static void	addDiscoveryProxy(DiscoveryProxyDetails pd, org.wso2.carbon.registry.api.Registry registry) Add a new WS-Discovery proxy configuration.
static boolean	discoveryProxyExists(String name, org.wso2.carbon.registry.api.Registry registry) Check whether the named WS-D proxy configuration exists in the registry
static org.apache.neethi.Policy	getClientSecurityPolicy(org.wso2.carbon.registry.api.Registry registry) Get the client side security policy for the remote discovery proxy.
static org.apache.axis2.description.Parameter	getDiscoveryParam(org.apache.axis2.engine.AxisConfiguration axisConfig)
static DiscoveryProxyDetails[]	getDiscoveryProxies(org.wso2.carbon.registry.api.Registry registry) Returns all existing WS-D proxy configurations
static DiscoveryProxyDetails	getDiscoveryProxy(String name, org.wso2.carbon.registry.api.Registry registry) Get the named WS-D proxy configuration
static String	getDiscoveryProxyURL(org.apache.axis2.engine.AxisConfiguration axisConfig) Get the URL of the remote WS-Discovery proxy.
static String	getExistingServiceIdOrUpdate(String name, String uniqueId, org.wso2.carbon.registry.api.Registry registry) Get the previously assigned unique ID of the given service.
static TargetServiceDetails	getServiceDetails(TargetService service) Construct a target service description using the given TargetService instance
static boolean	isServiceDiscoveryEnabled(org.apache.axis2.engine.AxisConfiguration axisConfig) Check whether service discovery is enabled in the configuration.
static void	persistPublisherConfiguration(String proxyURL, boolean enabled, org.wso2.carbon.registry.api.Registry registry) Save the WS-Discovery service publisher configuration to the registry.
static TargetService[]	probeDiscoveryProxy(String name, ProbeDetails pd, org.wso2.carbon.registry.api.Registry registry) Probe the specified WS-D proxy to obtain target service details
static void	removeDiscoveryProxy(String name, org.wso2.carbon.registry.api.Registry registry) Remove the named WS-D proxy configuration from the registry
static TargetService	resolveService(String name, String id, org.wso2.carbon.registry.api.Registry registry) Resolve the specified service ID against the given proxy

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryMgtUtils

public DiscoveryMgtUtils()

Method Detail

addDiscoveryProxy

public static void addDiscoveryProxy(DiscoveryProxyDetails pd,
                                     org.wso2.carbon.registry.api.Registry registry)
                              throws DiscoveryException,
                                     org.wso2.carbon.registry.api.RegistryException

Add a new WS-Discovery proxy configuration. A proxy configuration must contain a name and a valid URL via which the respective WS-D proxy can be contacted. This method does not allow overwriting existing proxy configuration. In such cases an exception will be thrown.

Parameters:

pd - WS-Discovery proxy description

registry - Configuration registry where information should be saved

Throws:

DiscoveryException - if the proxy description is invalid

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

getExistingServiceIdOrUpdate

public static String getExistingServiceIdOrUpdate(String name,
                                                  String uniqueId,
                                                  org.wso2.carbon.registry.api.Registry registry)
                                           throws DiscoveryException,
                                                  org.wso2.carbon.registry.api.RegistryException

Get the previously assigned unique ID of the given service. If such an ID is not already assigned to the given service then the provided unique ID will be assigned to the service and the association will be recorded in the registry.

Parameters:

name - Name of the service

uniqueId - Unique ID to be assigned in case an ID is not specified already

registry - Configuration registry where service ID list is stored

Returns:

the Unique ID assigned to the service

Throws:

DiscoveryException - if the registry is not available

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

removeDiscoveryProxy

public static void removeDiscoveryProxy(String name,
                                        org.wso2.carbon.registry.api.Registry registry)
                                 throws DiscoveryException,
                                        org.wso2.carbon.registry.api.RegistryException

Remove the named WS-D proxy configuration from the registry

Parameters:

name - Name of the proxy configuration to be removed

registry - Configuration registry where proxy information is saved

Throws:

DiscoveryException - if the named configuration does not exist

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

getDiscoveryProxy

public static DiscoveryProxyDetails getDiscoveryProxy(String name,
                                                      org.wso2.carbon.registry.api.Registry registry)
                                               throws DiscoveryException,
                                                      org.wso2.carbon.registry.api.RegistryException

Get the named WS-D proxy configuration

Parameters:

name - Name of the proxy configuration

registry - Configuration registry where proxy information is saved

Returns:

a proxy description or null if no such configuration exists

Throws:

DiscoveryException - If the registry is unavailable

org.wso2.carbon.registry.api.RegistryException - If an error occurs while accessing the registry

getDiscoveryProxies

public static DiscoveryProxyDetails[] getDiscoveryProxies(org.wso2.carbon.registry.api.Registry registry)
                                                   throws DiscoveryException,
                                                          org.wso2.carbon.registry.api.RegistryException

Returns all existing WS-D proxy configurations

Parameters:

registry - Configuration registry where proxy information is saved

Returns:

an array of proxy configuration or null if no proxies are configured

Throws:

DiscoveryException - if the registry is unavailable

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

discoveryProxyExists

public static boolean discoveryProxyExists(String name,
                                           org.wso2.carbon.registry.api.Registry registry)
                                    throws DiscoveryException,
                                           org.wso2.carbon.registry.api.RegistryException

Check whether the named WS-D proxy configuration exists in the registry

Parameters:

name - The name of the proxy to be tested

registry - Configuration registry where proxy information is saved

Returns:

true if the configuration exists and false otherwise

Throws:

DiscoveryException - if the registry is unavailable

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

probeDiscoveryProxy

public static TargetService[] probeDiscoveryProxy(String name,
                                                  ProbeDetails pd,
                                                  org.wso2.carbon.registry.api.Registry registry)
                                           throws DiscoveryException,
                                                  org.wso2.carbon.registry.api.RegistryException

Probe the specified WS-D proxy to obtain target service details

Parameters:

name - Name of the proxy to be queried

pd - Probe description

registry - Configuration registry where proxy information is saved

Returns:

an array of target service descriptions or null

Throws:

DiscoveryException - if the proxy configuration is invalid or the proxy is unavailable

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

resolveService

public static TargetService resolveService(String name,
                                           String id,
                                           org.wso2.carbon.registry.api.Registry registry)
                                    throws DiscoveryException,
                                           org.wso2.carbon.registry.api.RegistryException

Resolve the specified service ID against the given proxy

Parameters:

name - Name of the proxy to be queried

id - Service ID to be resolved

registry - Configuration registry where proxy information is saved

Returns:

a target service description or null

Throws:

DiscoveryException - if the proxy configuration is invalid or the proxy is unavailable

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

isServiceDiscoveryEnabled

public static boolean isServiceDiscoveryEnabled(org.apache.axis2.engine.AxisConfiguration axisConfig)
                                         throws org.wso2.carbon.registry.api.RegistryException

Check whether service discovery is enabled in the configuration. This method first checks whether the DiscoveryConstants.DISCOVERY_PROXY parameter is set in the given AxisConfiguration. If not it checks whether service discovery status is set to 'true' in the configuration registry. If discovery is enabled in the registry configuration, this method will also add the corresponding parameter to AxisConfiguration.

Parameters:

axisConfig - AxisConfiguration

Returns:

service discovery status

Throws:

org.wso2.carbon.registry.api.RegistryException - if an error occurs while accessing the registry

getDiscoveryProxyURL

public static String getDiscoveryProxyURL(org.apache.axis2.engine.AxisConfiguration axisConfig)
                                   throws org.wso2.carbon.registry.api.RegistryException

Get the URL of the remote WS-Discovery proxy. This method first attempts to get the URL from the AxisConfiguration. If discovery is not enabled, it will attempt to retrieve the URL from the configuration registry.

Parameters:

axisConfig - AxisConfiguration instance

Returns:

URL of the proxy or null

Throws:

org.wso2.carbon.registry.api.RegistryException - on error

getDiscoveryParam

public static org.apache.axis2.description.Parameter getDiscoveryParam(org.apache.axis2.engine.AxisConfiguration axisConfig)

persistPublisherConfiguration

public static void persistPublisherConfiguration(String proxyURL,
                                                 boolean enabled,
                                                 org.wso2.carbon.registry.api.Registry registry)
                                          throws org.wso2.carbon.registry.api.RegistryException

Save the WS-Discovery service publisher configuration to the registry. This configuration contains the remote discovery proxy URL and the current status of the publisher (ie enabled/disabled)

Parameters:

proxyURL - URL of the discovery proxy

enabled - true if the publisher is enabled and false otherwise

registry - Configuration registry

Throws:

org.wso2.carbon.registry.api.RegistryException - on error

getClientSecurityPolicy

public static org.apache.neethi.Policy getClientSecurityPolicy(org.wso2.carbon.registry.api.Registry registry)
                                                        throws org.wso2.carbon.registry.api.RegistryException,
                                                               XMLStreamException

Get the client side security policy for the remote discovery proxy. This method first checks whether a resource named DiscoveryConstants.DISCOVERY_CLIENT_POLICY is available at the root of the configuration registry. If not it attempts to load the policy from a file named DiscoveryConstants.DISCOVERY_CLIENT_POLICY which should reside in the configuration file directory of Carbon.

Parameters:

registry - Configuration registry

Returns:

a Policy instance or null

Throws:

org.wso2.carbon.registry.api.RegistryException - If the registry cannot be accessed

XMLStreamException - If the policy XML cannot be parsed

getServiceDetails

public static TargetServiceDetails getServiceDetails(TargetService service)

Construct a target service description using the given TargetService instance

Parameters:

service - the TargetService object - must not be null

Returns:

a target service description