org.globus.ogsa
Interface ServiceDataSet

All Known Implementing Classes:

ServiceDataSetImpl, XindiceServiceDataSet

public interface ServiceDataSet

This interface defines the API used to access a collection of service data contained in a service

Method Summary

void	add(ServiceData serviceData) Adds a service data element to the set and makes it available to queries and subscriptions
QName	checkMatching(QName name) If the name is a local name without a namespace, a matching qualified name with the same local name is returned.
ServiceData	create(java.lang.String name) Creates a service data element with local name name.
void	delete(java.lang.String name)
java.lang.Object	evaluate(java.lang.Object expression) This method can be used to provide native expression types in the ServiceDataSet implementation, and it may be called by the framework as a result of a findServiceData query or a subscription expression evaluation.
ServiceData	get(java.lang.String name)
QName[]	getNames() Get the names of all currently contained service data elements
QName[]	getNotifiableNames() Get the names of all currently contained service data elements that can be subscribed to.
java.util.Iterator	iterator()
void	notifyListeners(ServiceData serviceData) This method is called by service data elements on their parent set when they change.
void	notifyListenersWithAck(ServiceData serviceData) This method is called by service data elements on their parent set when they change.
void	registerListener(ServiceDataListener listener) Registers a listener that will be called whenever a SerivceData value changes in the contained set.
ServiceData	remove(java.lang.String name)
void	removeListener(ServiceDataListener listener)
int	size()

Method Detail

evaluate

public java.lang.Object evaluate(java.lang.Object expression)
                          throws FaultType

This method can be used to provide native expression types in the ServiceDataSet implementation, and it may be called by the framework as a result of a findServiceData query or a subscription expression evaluation.

Throws:

FaultType

create

public ServiceData create(java.lang.String name)
                   throws GridServiceException

Creates a service data element with local name name. Note the element is not added to the set (and thus not target to queries or subscriptions) until the add method is called

Throws:

GridServiceException

add

public void add(ServiceData serviceData)
         throws GridServiceException

Adds a service data element to the set and makes it available to queries and subscriptions

Throws:

GridServiceException

checkMatching

public QName checkMatching(QName name)
                    throws GridServiceException

If the name is a local name without a namespace, a matching qualified name with the same local name is returned. This allows for queries and subscriptions on a local name only.

Throws:

GridServiceException

get

public ServiceData get(java.lang.String name)
                throws GridServiceException

Throws:

GridServiceException

delete

public void delete(java.lang.String name)
            throws GridServiceException

Throws:

GridServiceException

remove

public ServiceData remove(java.lang.String name)
                   throws GridServiceException

Throws:

GridServiceException

registerListener

public void registerListener(ServiceDataListener listener)

Registers a listener that will be called whenever a SerivceData value changes in the contained set.

removeListener

public void removeListener(ServiceDataListener listener)

getNames

public QName[] getNames()

Get the names of all currently contained service data elements

getNotifiableNames

public QName[] getNotifiableNames()

Get the names of all currently contained service data elements that can be subscribed to.

iterator

public java.util.Iterator iterator()

Returns:

an iterator over the ServiceData elements

size

public int size()

Returns:

number of ServiceData instances contained in this set

notifyListeners

public void notifyListeners(ServiceData serviceData)

This method is called by service data elements on their parent set when they change. See: ServiceData.notifyChange

notifyListenersWithAck

public void notifyListenersWithAck(ServiceData serviceData)

This method is called by service data elements on their parent set when they change. See: ServiceData.notifyChange The call returns when a notification has been sent to all listeners and their subscribers.