uk.org.ogsadai.client.toolkit.service
Interface Registry

All Superinterfaces:

Properties, Service

public interface Registry

extends Service, Properties

An interface designed to provide a generic client-side view of a registry service.

Author:

The OGSA-DAI Team.

Method Summary

boolean	add(java.net.URL url, org.w3c.dom.Document metadata) Add a service to the registry.
ServiceMetaData	getServiceMetaData(java.net.URL url) Get the meta data describing a specific service.
java.net.URL[]	getServices() Obtain the URLs of all registered services.
java.net.URL[]	getServices(javax.xml.namespace.QName portType) Obtain the URLs of all registered services that support a named port type.
java.net.URL[]	getServices(javax.xml.namespace.QName[] portTypes) Obtain the URLs of all registered services that support a set of named port types.
boolean	remove(java.net.URL url) Remove a service from the registry.

Methods inherited from interface uk.org.ogsadai.client.toolkit.service.Service

getResourceIDs, getURL, ping, setConnectionProperty, setResourceID

Methods inherited from interface uk.org.ogsadai.client.toolkit.service.Properties

getProperties, getProperty

Method Detail

add

public boolean add(java.net.URL url,
                   org.w3c.dom.Document metadata)
            throws ServiceCommsException

Add a service to the registry.

Parameters:

url - URL of the service to register

metadata - An XML document containing information that the service wishes to publish.

Returns:

true if the registration was successful else false.

Throws:

ServiceCommsException - if there is a problem communicating with the registry.

remove

public boolean remove(java.net.URL url)
               throws ServiceCommsException

Remove a service from the registry.

Parameters:

url - URL of the service to remove

Returns:

true if the removal was successful else false.

Throws:

ServiceCommsException - if there is a problem communicating with the registry.

getServices

public java.net.URL[] getServices()
                           throws ServiceCommsException

Obtain the URLs of all registered services.

Returns:

an array of URLs

Throws:

ServiceCommsException - if there is a problem communicating with the registry.

getServices

public java.net.URL[] getServices(javax.xml.namespace.QName portType)
                           throws ServiceCommsException

Obtain the URLs of all registered services that support a named port type.

Parameters:

portType - Port type name.

Returns:

an array of URLs

Throws:

ServiceCommsException - if there is a problem communicating with the registry.

getServices

public java.net.URL[] getServices(javax.xml.namespace.QName[] portTypes)
                           throws ServiceCommsException

Obtain the URLs of all registered services that support a set of named port types.

Parameters:

portTypes - Port type names.

Returns:

an array of URLs

Throws:

ServiceCommsException - if there is a problem communicating with the registry.

getServiceMetaData

public ServiceMetaData getServiceMetaData(java.net.URL url)
                                   throws ServiceCommsException

Get the meta data describing a specific service.

Parameters:

url - URL of the service if interest.

Returns:

meta data about the service as held within the registry.

Throws:

ServiceCommsException - if there is a problem communicating with the registry.