Class RDF4JProtocolSession

java.lang.Object

org.eclipse.rdf4j.http.client.SPARQLProtocolSession

org.eclipse.rdf4j.http.client.RDF4JProtocolSession

All Implemented Interfaces:

AutoCloseable, HttpClientDependent

public class RDF4JProtocolSession
extends SPARQLProtocolSession

A SPARQLProtocolSession subclass which extends the standard SPARQL 1.1 Protocol with additional functionality, as documented in the RDF4J REST API.

Author:

Andreas Schwarte, Jeen Broekstra

See Also:

• RDF4J REST API

Field Summary

Fields inherited from class SPARQLProtocolSession

DEFAULT_MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH_PARAM, UTF8

Modifier and Type	Field	Description
static final int	DEFAULT_MAXIMUM_URL_LENGTH	The default value of the threshold for URL length, beyond which we use the POST method for SPARQL query requests.
static final int	MAXIMUM_URL_LENGTH	Deprecated. use SPARQLProtocolSession.DEFAULT_MAXIMUM_URL_LENGTH instead.
static final String	MAXIMUM_URL_LENGTH_PARAM	System property for configuration of URL length threshold: rdf4j.sparql.url.maxlength.
protected static final Charset	UTF8

Constructor Summary

Constructors

Constructor	Description
RDF4JProtocolSession(RDF4JHttpClient client, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
void	addData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts)
protected HttpRequest.Builder	applyAdditionalHeaders(HttpRequest.Builder builder)	Applies additional HTTP headers (from SPARQLProtocolSession.getAdditionalHttpHeaders()) and the authorization header to the supplied request builder.
void	beginTransaction(IsolationLevel isolationLevel)
void	beginTransaction(TransactionSetting... transactionSettings)
void	cancelQueryExplanation(String explainRequestId)
protected void	checkRepositoryURL()
protected void	checkServerURL()
void	clearNamespaces()
void	close()
void	commitTransaction()
void	createRepository(RepositoryConfig config)	Create a new repository.
void	deleteRepository(String repositoryID)
TupleQueryResult	getContextIDs()
void	getContextIDs(TupleQueryResultHandler handler)
String	getNamespace(String prefix)
TupleQueryResult	getNamespaces()
void	getNamespaces(TupleQueryResultHandler handler)
protected HttpRequest	getQueryMethod(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
protected List<NameValuePair>	getQueryMethodParameters(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
void	getRepositoryConfig(StatementCollector statementCollector)	Retrieve configuration of the current repository and send it to the supplied StatementCollector
TupleQueryResult	getRepositoryList()
void	getRepositoryList(TupleQueryResultHandler handler)
String	getRepositoryURL()
String	getServerProtocol()
String	getServerURL()
void	getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, RDFHandler handler, Resource... contexts)
protected HttpRequest	getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxExecutionTime, Binding... bindings)
protected List<NameValuePair>	getUpdateMethodParameters(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
String	getUpdateURL()
void	prepareTransaction()
void	removeData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts)
void	removeNamespacePrefix(String prefix)
void	rollbackTransaction()
Explanation	sendQueryExplanation(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Explanation.Level level, Binding... bindings)
void	sendTransaction(Iterable<? extends TransactionOperation> txn)	Deprecated. since 2.8.0
void	setNamespacePrefix(String prefix, String name)
void	setRepository(String repositoryURL)
void	setServerURL(String serverURL)
void	setUsernameAndPassword(String username, String password)	Set the username and password for authentication with the remote server.
long	size(Resource... contexts)
void	updateRepository(RepositoryConfig config)	Update the config of an existing repository.
protected void	upload(InputStream contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts)
void	upload(InputStream contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Resource... contexts)
protected void	upload(Reader contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts)
void	upload(Reader contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Resource... contexts)
protected void	upload(HttpRequestBody reqBody, String baseURI, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts)

Methods inherited from class SPARQLProtocolSession

execute, executeNoContent, executeOK, getAdditionalHttpHeaders, getAuthenticationHandler, getBackgroundTupleQueryResult, getBoolean, getErrorInfo, getHttpClient, getParserConfig, getPreferredBooleanQueryResultFormat, getPreferredRDFFormat, getPreferredTupleQueryResultFormat, getQueryURL, getRDF, getRDFBackground, getResponseMIMEType, getTupleQueryResult, getUpdateMethod, getUpdateMethodParameters, getValueFactory, isPassThroughEnabled, sendBooleanQuery, sendBooleanQuery, sendGraphQuery, sendGraphQuery, sendGraphQuery, sendGraphQuery, sendTupleQuery, sendTupleQuery, sendTupleQuery, sendUpdate, sendUpdate, setAdditionalHttpHeaders, setAuthenticationHandler, setHttpClient, setParserConfig, setPassThroughEnabled, setPreferredBooleanQueryResultFormat, setPreferredRDFFormat, setPreferredTupleQueryResultFormat, setQueryURL, setUpdateURL, setUsernameAndPasswordForUrl, setValueFactory, shouldUsePost

Modifier and Type	Method	Description
protected HttpResponse	execute(HttpRequest request)	Executes the given HTTP request and returns the response on success (2xx or 404).
protected void	executeNoContent(HttpRequest method)
protected HttpResponse	executeOK(HttpRequest method)	Convenience method to deal with HTTP level errors of tuple, graph and boolean queries in the same way.
Map<String,String>	getAdditionalHttpHeaders()	Get the additional HTTP headers which will be used
AuthenticationHandler	getAuthenticationHandler()	Returns the current AuthenticationHandler, or null if none has been set.
protected TupleQueryResult	getBackgroundTupleQueryResult(HttpRequest method, WeakReference<?> callerRef)	Deprecated. WeakReferenceinvalid input: '<'?
protected boolean	getBoolean(HttpRequest method)	Parse the response in this thread using a suitable BooleanQueryResultParser.
protected ErrorInfo	getErrorInfo(HttpResponse response)
final RDF4JHttpClient	getHttpClient()	RDF4JHttpClient that has been assigned or has been used by this object.
ParserConfig	getParserConfig()
BooleanQueryResultFormat	getPreferredBooleanQueryResultFormat()	Gets the preferred BooleanQueryResultFormat for encoding boolean query results.
RDFFormat	getPreferredRDFFormat()	Gets the preferred RDFFormat for encoding RDF documents.
TupleQueryResultFormat	getPreferredTupleQueryResultFormat()	Gets the preferred TupleQueryResultFormat for encoding tuple query results.
String	getQueryURL()
protected void	getRDF(HttpRequest method, RDFHandler handler, boolean requireContext)	Parse the response in this thread using the provided RDFHandler.
protected GraphQueryResult	getRDFBackground(HttpRequest method, boolean requireContext, WeakReference<?> callerRef)	Deprecated. WeakReferenceinvalid input: '<'?
protected String	getResponseMIMEType(HttpResponse response)	Gets the MIME type specified in the response headers of the supplied method, if any.
protected void	getTupleQueryResult(HttpRequest method, TupleQueryResultHandler handler)	Parse the response in this thread using the provided TupleQueryResultHandler.
protected HttpRequest	getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
protected List<NameValuePair>	getUpdateMethodParameters(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
ValueFactory	getValueFactory()
boolean	isPassThroughEnabled()	Indicates if direct pass-through of the endpoint result to the supplied Sink is enabled.
boolean	sendBooleanQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
boolean	sendBooleanQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, Binding... bindings)
GraphQueryResult	sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings)	Deprecated. WeakReferenceinvalid input: '<'?
void	sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, RDFHandler handler, Binding... bindings)
GraphQueryResult	sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings)	Deprecated. WeakReferenceinvalid input: '<'?
void	sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, RDFHandler handler, Binding... bindings)
TupleQueryResult	sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings)	Deprecated. WeakReferenceinvalid input: '<'?
void	sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, TupleQueryResultHandler handler, Binding... bindings)
TupleQueryResult	sendTupleQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings)	Deprecated. WeakReferenceinvalid input: '<'?
void	sendUpdate(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings)
void	sendUpdate(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings)
void	setAdditionalHttpHeaders(Map<String,String> additionalHttpHeaders)	Set additional HTTP headers to be included in every request to the server, which may be required for certain unusual server configurations.
void	setAuthenticationHandler(AuthenticationHandler handler)	Sets an AuthenticationHandler that will be applied to every outgoing request.
void	setHttpClient(RDF4JHttpClient httpClient)	Assign an RDF4JHttpClient that this object should use.
void	setParserConfig(ParserConfig parserConfig)	Sets the parser configuration used to process HTTP response data.
void	setPassThroughEnabled(boolean passThroughEnabled)	Configure direct pass-through of the endpoint result to the supplied Sink.
void	setPreferredBooleanQueryResultFormat(BooleanQueryResultFormat format)	Sets the preferred format for encoding boolean query results.
void	setPreferredRDFFormat(RDFFormat format)	Sets the preferred format for encoding RDF documents.
void	setPreferredTupleQueryResultFormat(TupleQueryResultFormat format)	Sets the preferred format for encoding tuple query results.
protected void	setQueryURL(String queryURL)
protected void	setUpdateURL(String updateURL)
protected void	setUsernameAndPasswordForUrl(String username, String password, String url)
void	setValueFactory(ValueFactory valueFactory)
protected boolean	shouldUsePost(String fullQueryUrl)	Return whether the provided query should use POST (otherwise use GET)

Methods inherited from class Object

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

Constructor Details

RDF4JProtocolSession

public RDF4JProtocolSession(RDF4JHttpClient client,
 ExecutorService executor)

Method Details

setServerURL

public void setServerURL(String serverURL)

getServerURL

public String getServerURL()

getRepositoryURL

public String getRepositoryURL()

setRepository

public void setRepository(String repositoryURL)

checkRepositoryURL

protected void checkRepositoryURL()

checkServerURL

protected void checkServerURL()

getUpdateURL

public String getUpdateURL()

Overrides:

getUpdateURL in class SPARQLProtocolSession

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class SPARQLProtocolSession

getRepositoryList

public TupleQueryResult getRepositoryList()
                                   throws IOException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

RepositoryException

UnauthorizedException

QueryInterruptedException

getRepositoryList

public void getRepositoryList(TupleQueryResultHandler handler)
                       throws IOException,
TupleQueryResultHandlerException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

TupleQueryResultHandlerException

RepositoryException

UnauthorizedException

QueryInterruptedException

getServerProtocol

public String getServerProtocol()
                         throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

size

public long size(Resource... contexts)
          throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

createRepository

public void createRepository(RepositoryConfig config)
                      throws IOException,
RepositoryException

Create a new repository.

Parameters:

config - the repository configuration

Throws:

IOException

RepositoryException

updateRepository

public void updateRepository(RepositoryConfig config)
                      throws IOException,
RepositoryException

Update the config of an existing repository.

Parameters:

config - the repository configuration

Throws:

IOException

RepositoryException

deleteRepository

public void deleteRepository(String repositoryID)
                      throws IOException,
RepositoryException

Throws:

IOException

RepositoryException

getRepositoryConfig

public void getRepositoryConfig(StatementCollector statementCollector)
                         throws UnauthorizedException,
QueryInterruptedException,
RDFHandlerException,
RepositoryException,
IOException

Retrieve configuration of the current repository and send it to the supplied StatementCollector

Parameters:

statementCollector - receiver of the repository config information

Throws:

IOException

RepositoryException

RDFHandlerException

QueryInterruptedException

UnauthorizedException

Since:

3.1.0

getNamespaces

public TupleQueryResult getNamespaces()
                               throws IOException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

RepositoryException

UnauthorizedException

QueryInterruptedException

getNamespaces

public void getNamespaces(TupleQueryResultHandler handler)
                   throws IOException,
TupleQueryResultHandlerException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

TupleQueryResultHandlerException

RepositoryException

UnauthorizedException

QueryInterruptedException

getNamespace

public String getNamespace(String prefix)
                    throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

setNamespacePrefix

public void setNamespacePrefix(String prefix,
 String name)
                        throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

removeNamespacePrefix

public void removeNamespacePrefix(String prefix)
                           throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

clearNamespaces

public void clearNamespaces()
                     throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

getContextIDs

public TupleQueryResult getContextIDs()
                               throws IOException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

RepositoryException

UnauthorizedException

QueryInterruptedException

getContextIDs

public void getContextIDs(TupleQueryResultHandler handler)
                   throws IOException,
TupleQueryResultHandlerException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

TupleQueryResultHandlerException

RepositoryException

UnauthorizedException

QueryInterruptedException

getStatements

public void getStatements(Resource subj,
 IRI pred,
 Value obj,
 boolean includeInferred,
 RDFHandler handler,
 Resource... contexts)
                   throws IOException,
RDFHandlerException,
RepositoryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

RDFHandlerException

RepositoryException

UnauthorizedException

QueryInterruptedException

beginTransaction

public void beginTransaction(IsolationLevel isolationLevel)
                      throws RDF4JException,
IOException,
UnauthorizedException

Throws:

RDF4JException

IOException

UnauthorizedException

beginTransaction

public void beginTransaction(TransactionSetting... transactionSettings)
                      throws RDF4JException,
IOException,
UnauthorizedException

Throws:

RDF4JException

IOException

UnauthorizedException

prepareTransaction

public void prepareTransaction()
                        throws RDF4JException,
IOException,
UnauthorizedException

Throws:

RDF4JException

IOException

UnauthorizedException

commitTransaction

public void commitTransaction()
                       throws RDF4JException,
IOException,
UnauthorizedException

Throws:

RDF4JException

IOException

UnauthorizedException

rollbackTransaction

public void rollbackTransaction()
                         throws RDF4JException,
IOException,
UnauthorizedException

Throws:

RDF4JException

IOException

UnauthorizedException

sendTransaction

@Deprecated(since="2.8.0")
public void sendTransaction(Iterable<? extends TransactionOperation> txn)
                     throws IOException,
RepositoryException,
UnauthorizedException

Deprecated.

since 2.8.0

Sends a transaction list as serialized XML to the server.

Parameters:

txn -

Throws:

IOException

RepositoryException

UnauthorizedException

addData

public void addData(InputStream contents,
 String baseURI,
 RDFFormat dataFormat,
 Resource... contexts)
             throws UnauthorizedException,
RDFParseException,
RepositoryException,
IOException

Throws:

UnauthorizedException

RDFParseException

RepositoryException

IOException

removeData

public void removeData(InputStream contents,
 String baseURI,
 RDFFormat dataFormat,
 Resource... contexts)
                throws UnauthorizedException,
RDFParseException,
RepositoryException,
IOException

Throws:

UnauthorizedException

RDFParseException

RepositoryException

IOException

upload

public void upload(InputStream contents,
 String baseURI,
 RDFFormat dataFormat,
 boolean overwrite,
 boolean preserveNodeIds,
 Resource... contexts)
            throws IOException,
RDFParseException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RDFParseException

RepositoryException

UnauthorizedException

upload

protected void upload(InputStream contents,
 String baseURI,
 RDFFormat dataFormat,
 boolean overwrite,
 boolean preserveNodeIds,
 Protocol.Action action,
 Resource... contexts)
               throws IOException,
RDFParseException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RDFParseException

RepositoryException

UnauthorizedException

upload

public void upload(Reader contents,
 String baseURI,
 RDFFormat dataFormat,
 boolean overwrite,
 boolean preserveNodeIds,
 Resource... contexts)
            throws UnauthorizedException,
RDFParseException,
RepositoryException,
IOException

Throws:

UnauthorizedException

RDFParseException

RepositoryException

IOException

getQueryMethod

protected HttpRequest getQueryMethod(QueryLanguage ql,
 String query,
 String baseURI,
 Dataset dataset,
 boolean includeInferred,
 int maxQueryTime,
 Binding... bindings)

Overrides:

getQueryMethod in class SPARQLProtocolSession

sendQueryExplanation

public Explanation sendQueryExplanation(QueryLanguage ql,
 String query,
 String baseURI,
 Dataset dataset,
 boolean includeInferred,
 int maxQueryTime,
 Explanation.Level level,
 Binding... bindings)
                                 throws IOException,
RepositoryException,
MalformedQueryException,
UnauthorizedException,
QueryInterruptedException

Throws:

IOException

RepositoryException

MalformedQueryException

UnauthorizedException

QueryInterruptedException

cancelQueryExplanation

public void cancelQueryExplanation(String explainRequestId)
                            throws IOException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RepositoryException

UnauthorizedException

getUpdateMethod

protected HttpRequest getUpdateMethod(QueryLanguage ql,
 String update,
 String baseURI,
 Dataset dataset,
 boolean includeInferred,
 int maxExecutionTime,
 Binding... bindings)

Overrides:

getUpdateMethod in class SPARQLProtocolSession

upload

protected void upload(Reader contents,
 String baseURI,
 RDFFormat dataFormat,
 boolean overwrite,
 boolean preserveNodeIds,
 Protocol.Action action,
 Resource... contexts)
               throws IOException,
RDFParseException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RDFParseException

RepositoryException

UnauthorizedException

upload

protected void upload(HttpRequestBody reqBody,
 String baseURI,
 boolean overwrite,
 boolean preserveNodeIds,
 Protocol.Action action,
 Resource... contexts)
               throws IOException,
RDFParseException,
RepositoryException,
UnauthorizedException

Throws:

IOException

RDFParseException

RepositoryException

UnauthorizedException

setUsernameAndPassword

public void setUsernameAndPassword(String username,
 String password)

Description copied from class: SPARQLProtocolSession

Set the username and password for authentication with the remote server.

Overrides:

setUsernameAndPassword in class SPARQLProtocolSession

Parameters:

username - the username

password - the password

getQueryMethodParameters

protected List<NameValuePair> getQueryMethodParameters(QueryLanguage ql,
 String query,
 String baseURI,
 Dataset dataset,
 boolean includeInferred,
 int maxQueryTime,
 Binding... bindings)

Overrides:

getQueryMethodParameters in class SPARQLProtocolSession

getUpdateMethodParameters

protected List<NameValuePair> getUpdateMethodParameters(QueryLanguage ql,
 String update,
 String baseURI,
 Dataset dataset,
 boolean includeInferred,
 int maxQueryTime,
 Binding... bindings)

Overrides:

getUpdateMethodParameters in class SPARQLProtocolSession

applyAdditionalHeaders

protected HttpRequest.Builder applyAdditionalHeaders(HttpRequest.Builder builder)

Applies additional HTTP headers (from SPARQLProtocolSession.getAdditionalHttpHeaders()) and the authorization header to the supplied request builder.

Parameters:

builder - the request builder to add headers to

Returns:

the same builder, with headers added