org.apache.marmotta.ldclient.api.provider

Interface DataProvider

All Known Implementing Classes:

AbstractHTMLDataProvider, AbstractHttpProvider, AbstractXMLDataProvider, BlockingProvider

public interface DataProvider

Abstract interface for defining different implementations of data providers. Standard data providers are Linked Data and SPARQL, but in principle any data source can be wrapped as RDF (e.g. Google Data API)

Data provider should be implemented as CDI service beans and can make use of @PostConstruct methods for registering themselves for specific URIs or carrying out maintenance work.

Author:

Sebastian Schaffert

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Return the name of this data provider.
String[]	listMimeTypes() Return the list of mime types accepted by this data provider.
ClientResponse	retrieveResource(String resource, LDClientService client, Endpoint endpoint) Retrieve the data for a resource using the given http client and endpoint definition.

Method Detail

getName

String getName()

Return the name of this data provider. To be used e.g. in the configuration and in log messages.

Returns:

listMimeTypes

String[] listMimeTypes()

Return the list of mime types accepted by this data provider.

Returns:

retrieveResource

ClientResponse retrieveResource(String resource,
                              LDClientService client,
                              Endpoint endpoint)
                                throws DataRetrievalException

Retrieve the data for a resource using the given http client and endpoint definition. The service is supposed to manage the connection handling itself. See AbstractHttpProvider for a generic implementation of this method.

Parameters:

resource - the resource to be retrieved

endpoint - the endpoint definition

Returns:

a completely specified client response, including expiry information and the set of triples

Throws:

DataRetrievalException