Module org.apache.jena.rdfconnection

Package org.apache.jena.rdflink

Class RDFLinkHTTP

java.lang.Object

org.apache.jena.rdflink.RDFLinkHTTP

All Implemented Interfaces:

java.lang.AutoCloseable, LinkDatasetGraph, LinkDatasetGraphAccess, LinkSparqlQuery, LinkSparqlUpdate, RDFLink, Transactional

Direct Known Subclasses:

RDFLinkFuseki

public class RDFLinkHTTP
extends java.lang.Object
implements RDFLink

Implementation of the RDFLink interface using remote SPARQL operations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jena.sparql.core.Transactional

Transactional.Promote

Method Summary

Modifier and Type	Method	Description
void	abort()
void	begin()
void	begin(ReadWrite mode)
void	begin(TxnType txnType)
void	clearDataset()	Clear the dataset - remove all named graphs, clear the default graph.
void	close()	Close this connection.
void	commit()
void	delete()	Remove all data from the default graph.
void	delete(Node graphName)	Delete a graph from the dataset.
void	end()
static RDFLinkHTTPBuilder	from(RDFLinkHTTP base)	Create a RDFLinkHTTPBuilder initialized with the settings of another RDFLinkRemote.
Graph	get()	Fetch the default graph.
Graph	get(Node graphName)	Fetch a named graph.
DatasetGraph	getDataset()	Fetch the contents of the dataset
java.lang.String	getDestination()	Return the destination URL for the connection.
java.lang.String	getGraphStoreEndpoint()
java.net.http.HttpClient	getHttpClient()	Return the HttpClient in-use.
java.lang.String	getQueryEndpoint()
java.lang.String	getUpdateEndpoint()
boolean	isClosed()	Test whether this connection is closed or not
boolean	isInTransaction()
boolean	isRemote()	Whether this RDFLink is to a remote server or not.
void	load(java.lang.String file)	Send file - this merges the file RDF into the default graph of a dataset.
void	load(Graph graph)	Load (add, append) RDF into the default graph of a dataset.
void	load(Node graphName, java.lang.String file)	Load (add, append) RDF into a named graph in a dataset.
void	load(Node graphName, Graph graph)	Load (add, append) RDF into a named graph in a dataset.
void	loadDataset(java.lang.String file)
void	loadDataset(DatasetGraph dataset)
static RDFLinkHTTPBuilder	newBuilder()	Create a RDFLinkHTTPBuilder.
QueryExecBuilder	newQuery()	Return a QueryExecBuilder that is initially configured for this link setup and type.
boolean	promote(Transactional.Promote promote)
void	put(java.lang.String file)	Set the contents of the default graph of a dataset.
void	put(Graph graph)	Set the contents of the default graph of a dataset.
void	put(Node graphName, java.lang.String file)	Set the contents of a named graph of a dataset.
void	put(Node graphName, Graph graph)	Set the contents of a named graph of a dataset.
void	putDataset(java.lang.String file)
void	putDataset(DatasetGraph dataset)
QueryExec	query(java.lang.String queryString)	Setup a SPARQL query execution.
QueryExec	query(Query query)	Setup a SPARQL query execution.
boolean	queryAsk(java.lang.String queryString)	Execute a ASK query and return a boolean
Graph	queryConstruct(java.lang.String queryString)	Execute a CONSTRUCT query and return as a Graph
Graph	queryDescribe(java.lang.String queryString)	Execute a DESCRIBE query and return as a Graph
void	queryRowSet(java.lang.String queryString, java.util.function.Consumer<RowSet> rowSetAction)	Execute a SELECT query and process the RowSet with the handler code.
void	querySelect(java.lang.String queryString, java.util.function.Consumer<Binding> rowAction)	Execute a SELECT query and process the rows of the results with the handler code.
static RDFLinkHTTPBuilder	service(java.lang.String destinationURL)	Create a RDFLinkHTTPBuilder.
ReadWrite	transactionMode()
TxnType	transactionType()
void	update(java.lang.String updateString)	Execute a SPARQL Update.
void	update(UpdateRequest update)	Execute a SPARQL Update.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jena.rdflink.RDFLink

queryAsk, queryConstruct, queryConstructDataset, queryConstructDataset, queryDescribe, queryRowSet, querySelect, update

Methods inherited from interface org.apache.jena.sparql.core.Transactional

calc, calculate, calculateRead, calculateWrite, exec, execute, executeRead, executeWrite, promote

Method Detail

newBuilder

public static RDFLinkHTTPBuilder newBuilder()

Create a RDFLinkHTTPBuilder.

service

public static RDFLinkHTTPBuilder service(java.lang.String destinationURL)

Create a RDFLinkHTTPBuilder.

from

public static RDFLinkHTTPBuilder from(RDFLinkHTTP base)

Create a RDFLinkHTTPBuilder initialized with the settings of another RDFLinkRemote.

isRemote

public boolean isRemote()

Description copied from interface: RDFLink

Whether this RDFLink is to a remote server or not.

Specified by:

isRemote in interface RDFLink

getHttpClient

public java.net.http.HttpClient getHttpClient()

Return the HttpClient in-use.

getDestination

public java.lang.String getDestination()

Return the destination URL for the connection.

getQueryEndpoint

public java.lang.String getQueryEndpoint()

getUpdateEndpoint

public java.lang.String getUpdateEndpoint()

getGraphStoreEndpoint

public java.lang.String getGraphStoreEndpoint()

queryRowSet

public void queryRowSet(java.lang.String queryString,
                        java.util.function.Consumer<RowSet> rowSetAction)

Execute a SELECT query and process the RowSet with the handler code.

Specified by:

queryRowSet in interface LinkSparqlQuery

Specified by:

queryRowSet in interface RDFLink

Parameters:

queryString -

rowSetAction -

querySelect

public void querySelect(java.lang.String queryString,
                        java.util.function.Consumer<Binding> rowAction)

Execute a SELECT query and process the rows of the results with the handler code.

Specified by:

querySelect in interface LinkSparqlQuery

Specified by:

querySelect in interface RDFLink

Parameters:

queryString -

rowAction -

queryConstruct

public Graph queryConstruct(java.lang.String queryString)

Execute a CONSTRUCT query and return as a Graph

Specified by:

queryConstruct in interface LinkSparqlQuery

Specified by:

queryConstruct in interface RDFLink

queryDescribe

public Graph queryDescribe(java.lang.String queryString)

Execute a DESCRIBE query and return as a Graph

Specified by:

queryDescribe in interface LinkSparqlQuery

Specified by:

queryDescribe in interface RDFLink

queryAsk

public boolean queryAsk(java.lang.String queryString)

Execute a ASK query and return a boolean

Specified by:

queryAsk in interface LinkSparqlQuery

Specified by:

queryAsk in interface RDFLink

query

public QueryExec query(java.lang.String queryString)

Description copied from interface: RDFLink

Setup a SPARQL query execution.

This is a low-level operation. Handling the QueryExecution should be done with try-resource. Some QueryExecutions, such as ones connecting to a remote server, need to be properly closed to release system resources.

See also RDFLink.querySelect(String, Consumer), RDFLink.queryConstruct(String), RDFLink.queryDescribe(String), RDFLink.queryAsk(String) for ways to execute queries of a specific form.

Specified by:

query in interface LinkSparqlQuery

Specified by:

query in interface RDFLink

Returns:

QueryExecution

query

public QueryExec query(Query query)

Description copied from interface: RDFLink

Setup a SPARQL query execution. See also RDFLink.querySelect(Query, Consumer), RDFLink.queryConstruct(Query), RDFLink.queryDescribe(Query), RDFLink.queryAsk(Query) for ways to execute queries for of a specific form.

Specified by:

query in interface LinkSparqlQuery

Specified by:

query in interface RDFLink

Returns:

QueryExecution

newQuery

public QueryExecBuilder newQuery()

Description copied from interface: RDFLink

Return a QueryExecBuilder that is initially configured for this link setup and type. The query built will be set to go to the same dataset/remote endpoint as the other RDFLink operations.

Specified by:

newQuery in interface LinkSparqlQuery

Specified by:

newQuery in interface RDFLink

Returns:

QueryExecBuilder

update

public void update(java.lang.String updateString)

Description copied from interface: RDFLink

Execute a SPARQL Update.

Specified by:

update in interface LinkSparqlUpdate

Specified by:

update in interface RDFLink

update

public void update(UpdateRequest update)

Description copied from interface: RDFLink

Execute a SPARQL Update.

Specified by:

update in interface LinkSparqlUpdate

Specified by:

update in interface RDFLink

get

public Graph get(Node graphName)

Fetch a named graph. This is SPARQL Graph Store Protocol HTTP GET or equivalent.

Specified by:

get in interface LinkDatasetGraphAccess

Specified by:

get in interface RDFLink

Parameters:

graphName - URI string for the graph name (null or Quad.defaultGraphIRI for the default graph)

Returns:

Graph

get

public Graph get()

Description copied from interface: RDFLink

Fetch the default graph. This is SPARQL Graph Store Protocol HTTP GET or equivalent.

Specified by:

get in interface LinkDatasetGraphAccess

Specified by:

get in interface RDFLink

Returns:

Graph

load

public void load(java.lang.String file)

Description copied from interface: RDFLink

Send file - this merges the file RDF into the default graph of a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

load in interface LinkDatasetGraph

Specified by:

load in interface RDFLink

Parameters:

file - File of the data.

load

public void load(Node graphName,
                 java.lang.String file)

Description copied from interface: RDFLink

Load (add, append) RDF into a named graph in a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

load in interface LinkDatasetGraph

Specified by:

load in interface RDFLink

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

file - File of the data.

load

public void load(Graph graph)

Description copied from interface: RDFLink

Load (add, append) RDF into the default graph of a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

Specified by:

load in interface LinkDatasetGraph

Specified by:

load in interface RDFLink

Parameters:

graph - Data.

load

public void load(Node graphName,
                 Graph graph)

Description copied from interface: RDFLink

Load (add, append) RDF into a named graph in a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

Specified by:

load in interface LinkDatasetGraph

Specified by:

load in interface RDFLink

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

graph - Data.

put

public void put(java.lang.String file)

Description copied from interface: RDFLink

Set the contents of the default graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

put in interface LinkDatasetGraph

Specified by:

put in interface RDFLink

Parameters:

file - File of the data.

put

public void put(Node graphName,
                java.lang.String file)

Description copied from interface: RDFLink

Set the contents of a named graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

Specified by:

put in interface LinkDatasetGraph

Specified by:

put in interface RDFLink

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

file - File of the data.

put

public void put(Graph graph)

Description copied from interface: RDFLink

Set the contents of the default graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

put in interface LinkDatasetGraph

Specified by:

put in interface RDFLink

Parameters:

graph - Data.

put

public void put(Node graphName,
                Graph graph)

Description copied from interface: RDFLink

Set the contents of a named graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

Specified by:

put in interface LinkDatasetGraph

Specified by:

put in interface RDFLink

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

graph - Data.

delete

public void delete(Node graphName)

Description copied from interface: RDFLink

Delete a graph from the dataset. Null or Quad.defaultGraphIRI means the default graph, which is cleared, not removed.

Specified by:

delete in interface LinkDatasetGraph

Specified by:

delete in interface RDFLink

delete

public void delete()

Description copied from interface: RDFLink

Remove all data from the default graph.

Specified by:

delete in interface LinkDatasetGraph

Specified by:

delete in interface RDFLink

getDataset

public DatasetGraph getDataset()

Description copied from interface: LinkDatasetGraphAccess

Fetch the contents of the dataset

Specified by:

getDataset in interface LinkDatasetGraphAccess

loadDataset

public void loadDataset(java.lang.String file)

Specified by:

loadDataset in interface LinkDatasetGraph

Specified by:

loadDataset in interface RDFLink

loadDataset

public void loadDataset(DatasetGraph dataset)

Specified by:

loadDataset in interface LinkDatasetGraph

Specified by:

loadDataset in interface RDFLink

putDataset

public void putDataset(java.lang.String file)

Specified by:

putDataset in interface LinkDatasetGraph

Specified by:

putDataset in interface RDFLink

putDataset

public void putDataset(DatasetGraph dataset)

Specified by:

putDataset in interface LinkDatasetGraph

Specified by:

putDataset in interface RDFLink

clearDataset

public void clearDataset()

Description copied from interface: RDFLink

Clear the dataset - remove all named graphs, clear the default graph.

Specified by:

clearDataset in interface LinkDatasetGraph

Specified by:

clearDataset in interface RDFLink

close

public void close()

Description copied from interface: RDFLink

Close this connection. Use with try-resource.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface LinkDatasetGraph

Specified by:

close in interface LinkDatasetGraphAccess

Specified by:

close in interface LinkSparqlQuery

Specified by:

close in interface LinkSparqlUpdate

Specified by:

close in interface RDFLink

isClosed

public boolean isClosed()

Description copied from interface: RDFLink

Test whether this connection is closed or not

Specified by:

isClosed in interface LinkDatasetGraph

Specified by:

isClosed in interface LinkDatasetGraphAccess

Specified by:

isClosed in interface RDFLink

begin

public void begin()

Specified by:

begin in interface Transactional

begin

public void begin(TxnType txnType)

Specified by:

begin in interface Transactional

begin

public void begin(ReadWrite mode)

Specified by:

begin in interface Transactional

promote

public boolean promote(Transactional.Promote promote)

Specified by:

promote in interface Transactional

commit

public void commit()

Specified by:

commit in interface Transactional

abort

public void abort()

Specified by:

abort in interface Transactional

isInTransaction

public boolean isInTransaction()

Specified by:

isInTransaction in interface Transactional

end

public void end()

Specified by:

end in interface Transactional

transactionMode

public ReadWrite transactionMode()

Specified by:

transactionMode in interface Transactional

transactionType

public TxnType transactionType()

Specified by:

transactionType in interface Transactional