org.ogf.graap.wsag.client.api
Interface AgreementFactoryRegistryClient

All Known Implementing Classes:

AbstractFactoryRegistryClient, RestAgreementFactoryRegistryClient, WsrfAgreementFactoryRegistryClient

public interface AgreementFactoryRegistryClient

Client to an agreement factory registry. The registry is used to query a list of agreement factory clients that is hosted on a WSAG4J server.

Author:

Oliver Waeldrich

Field Summary

static ClientLocator<AgreementFactoryRegistryClient>

FACTORY Default registry builder.

Method Summary

AgreementFactoryClient	getFactory(String resourceId) Returns an AgreementFactoryClient for the factory with the given resource id or null if no factory with that resource id exists.
AgreementFactoryClient[]	listAgreementFactories() Lists all agreement factories at the given endpoint.

Field Detail

FACTORY

static final ClientLocator<AgreementFactoryRegistryClient> FACTORY

Default registry builder.

Method Detail

listAgreementFactories

AgreementFactoryClient[] listAgreementFactories()
                                                throws ResourceUnknownException,
                                                       ResourceUnavailableException

Lists all agreement factories at the given endpoint.

Returns:

a set of AgreementFactoryClient available at the given endpoint

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getFactory

AgreementFactoryClient getFactory(String resourceId)
                                  throws ResourceUnknownException,
                                         ResourceUnavailableException

Returns an AgreementFactoryClient for the factory with the given resource id or null if no factory with that resource id exists.

Parameters:

resourceId - the factory resource id

Returns:

the agreement factory client for the requested resource id or null if no factory with the given id exists

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable