Package org.eclipse.rdf4j.http.client
Class SPARQLProtocolSession
java.lang.Object
org.eclipse.rdf4j.http.client.SPARQLProtocolSession
- All Implemented Interfaces:
AutoCloseable
,HttpClientDependent
- Direct Known Subclasses:
RDF4JProtocolSession
The SPARQLProtocolSession provides low level HTTP methods for communication with SPARQL endpoints. All methods are
compliant to the SPARQL 1.1 Protocol W3C Recommendation.
For both Tuple and Graph queries there is a variant which parses the result in the background, see
BackgroundTupleResult
and BackgroundGraphResult
. For boolean queries the result is parsed in the
current thread. All methods in this class guarantee that HTTP connections are closed properly and returned to the
connection pool. The methods in this class are not guaranteed to be thread-safe.
Functionality specific to the RDF4J HTTP protocol can be found in RDF4JProtocolSession
(which is used by
HTTPRepository).- Author:
- Herko ter Horst, Arjohn Kampman, Andreas Schwarte, Jeen Broekstra
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The default value of the threshold for URL length, beyond which we use the POST method for SPARQL query requests.static final int
Deprecated.static final String
System property for configuration of URL length threshold:rdf4j.sparql.url.maxlength
.protected static final Charset
-
Constructor Summary
ConstructorDescriptionSPARQLProtocolSession
(org.apache.http.client.HttpClient client, ExecutorService executor) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
protected org.apache.http.HttpResponse
execute
(org.apache.http.client.methods.HttpUriRequest method) protected void
executeNoContent
(org.apache.http.client.methods.HttpUriRequest method) protected org.apache.http.HttpResponse
executeOK
(org.apache.http.client.methods.HttpUriRequest method) Convenience method to deal with HTTP level errors of tuple, graph and boolean queries in the same way.Get the additional HTTP headers which will be usedprotected TupleQueryResult
getBackgroundTupleQueryResult
(org.apache.http.client.methods.HttpUriRequest method, WeakReference<?> callerRef) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedprotected boolean
getBoolean
(org.apache.http.client.methods.HttpUriRequest method) Parse the response in this thread using a suitableBooleanQueryResultParser
.long
Gets the http connection read timeout in milliseconds.protected ErrorInfo
getErrorInfo
(org.apache.http.HttpResponse response) final org.apache.http.client.HttpClient
HttpClient
that has been assigned or has been used by this object.protected org.apache.http.protocol.HttpContext
Get theHttpContext
used for sending HTTP requests.Gets the preferredBooleanQueryResultFormat
for encoding boolean query results.Gets the preferredRDFFormat
for encoding RDF documents.Gets the preferredTupleQueryResultFormat
for encoding tuple query results.protected org.apache.http.client.methods.HttpUriRequest
getQueryMethod
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) protected List
<org.apache.http.NameValuePair> getQueryMethodParameters
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) protected void
getRDF
(org.apache.http.client.methods.HttpUriRequest method, RDFHandler handler, boolean requireContext) Parse the response in this thread using the providedRDFHandler
.protected GraphQueryResult
getRDFBackground
(org.apache.http.client.methods.HttpUriRequest method, boolean requireContext, WeakReference<?> callerRef) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedprotected String
getResponseMIMEType
(org.apache.http.HttpResponse method) Gets the MIME type specified in the response headers of the supplied method, if any.protected void
getTupleQueryResult
(org.apache.http.client.methods.HttpUriRequest method, TupleQueryResultHandler handler) Parse the response in this thread using the providedTupleQueryResultHandler
.protected org.apache.http.client.methods.HttpUriRequest
getUpdateMethod
(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) protected org.apache.http.client.methods.HttpUriRequest
getUpdateMethod
(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings) protected List
<org.apache.http.NameValuePair> getUpdateMethodParameters
(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) protected List
<org.apache.http.NameValuePair> getUpdateMethodParameters
(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings) boolean
Indicates if direct pass-through of the endpoint result to the suppliedSink
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) sendGraphQuery
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedvoid
sendGraphQuery
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, RDFHandler handler, Binding... bindings) sendGraphQuery
(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedvoid
sendGraphQuery
(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, RDFHandler handler, Binding... bindings) sendTupleQuery
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedvoid
sendTupleQuery
(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, TupleQueryResultHandler handler, Binding... bindings) sendTupleQuery
(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings) Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedvoid
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
setConnectionTimeout
(long timeout) Sets the http connection read timeout.void
setHttpClient
(org.apache.http.client.HttpClient httpClient) Assign anHttpClient
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 suppliedSink
.void
Sets the preferred format for encoding boolean query results.void
setPreferredRDFFormat
(RDFFormat format) Sets the preferred format for encoding RDF documents.void
Sets the preferred format for encoding tuple query results.protected void
setQueryURL
(String queryURL) protected void
setUpdateURL
(String updateURL) void
setUsernameAndPassword
(String username, String password) Set the username and password for authentication with the remote server.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)
-
Field Details
-
UTF8
-
DEFAULT_MAXIMUM_URL_LENGTH
public static final int DEFAULT_MAXIMUM_URL_LENGTHThe default value of the threshold for URL length, beyond which we use the POST method for SPARQL query requests. The default is based on the lowest common denominator for various web servers.- See Also:
-
MAXIMUM_URL_LENGTH
Deprecated.useDEFAULT_MAXIMUM_URL_LENGTH
instead.- See Also:
-
MAXIMUM_URL_LENGTH_PARAM
System property for configuration of URL length threshold:rdf4j.sparql.url.maxlength
. A threshold of 0 (or a negative value) means that the POST method is used for every SPARQL query request.- See Also:
-
-
Constructor Details
-
SPARQLProtocolSession
-
-
Method Details
-
getHttpClient
public final org.apache.http.client.HttpClient getHttpClient()Description copied from interface:HttpClientDependent
HttpClient
that has been assigned or has been used by this object. The life cycle might not be or might be tied to this object, depending on whetherHttpClient
was passed to or created by this object respectively.- Specified by:
getHttpClient
in interfaceHttpClientDependent
- Returns:
- an
HttpClient
instance or null
-
setHttpClient
public void setHttpClient(org.apache.http.client.HttpClient httpClient) Description copied from interface:HttpClientDependent
Assign anHttpClient
that this object should use. The life cycle of the givenHttpClient
is independent of this object. Closing or shutting down this object does not have any impact on the given client. Callers must ensure that the given client is properly closed elsewhere.- Specified by:
setHttpClient
in interfaceHttpClientDependent
- Parameters:
httpClient
-
-
setValueFactory
-
getValueFactory
-
setQueryURL
-
setUpdateURL
-
setPreferredTupleQueryResultFormat
Sets the preferred format for encoding tuple query results.- Parameters:
format
- The preferredTupleQueryResultFormat
, or null to indicate no specific format is preferred.
-
getPreferredTupleQueryResultFormat
Gets the preferredTupleQueryResultFormat
for encoding tuple query results. TheSPARQL/XML
format is preferred by default.- Returns:
- The preferred format, of null if no specific format is preferred.
-
setPreferredRDFFormat
-
getPreferredRDFFormat
-
setPreferredBooleanQueryResultFormat
Sets the preferred format for encoding boolean query results.- Parameters:
format
- The preferredBooleanQueryResultFormat
, or null to indicate no specific format is preferred.
-
getPreferredBooleanQueryResultFormat
Gets the preferredBooleanQueryResultFormat
for encoding boolean query results. Thebinary
format is preferred by default.- Returns:
- The preferred format, of null if no specific format is preferred.
-
setUsernameAndPassword
-
setUsernameAndPasswordForUrl
-
getQueryURL
-
getUpdateURL
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
-
sendTupleQuery
@Deprecated(since="4.1.2") public TupleQueryResult sendTupleQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removed -
sendTupleQuery
@Deprecated(since="4.1.2") public TupleQueryResult sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removed -
sendTupleQuery
public void sendTupleQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, TupleQueryResultHandler handler, Binding... bindings) throws IOException, TupleQueryResultHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendUpdate
public void sendUpdate(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendUpdate
public void sendUpdate(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendGraphQuery
@Deprecated(since="4.1.2") public GraphQueryResult sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, WeakReference<?> callerRef, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removed -
sendGraphQuery
@Deprecated(since="4.1.2") public GraphQueryResult sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, WeakReference<?> callerRef, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removed -
sendGraphQuery
public void sendGraphQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, RDFHandler handler, Binding... bindings) throws IOException, RDFHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendGraphQuery
public void sendGraphQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, RDFHandler handler, Binding... bindings) throws IOException, RDFHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendBooleanQuery
public boolean sendBooleanQuery(QueryLanguage ql, String query, Dataset dataset, boolean includeInferred, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
sendBooleanQuery
public boolean sendBooleanQuery(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) throws IOException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException -
getAdditionalHttpHeaders
-
setAdditionalHttpHeaders
Set additional HTTP headers to be included in every request to the server, which may be required for certain unusual server configurations.- Parameters:
additionalHttpHeaders
- a map containing pairs of header names and values. May be null
-
getQueryMethod
protected org.apache.http.client.methods.HttpUriRequest getQueryMethod(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) -
shouldUsePost
Return whether the provided query should use POST (otherwise use GET)- Parameters:
fullQueryUrl
- the complete URL, including hostname and all HTTP query parameters
-
getUpdateMethod
protected org.apache.http.client.methods.HttpUriRequest getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, Binding... bindings) -
getUpdateMethod
protected org.apache.http.client.methods.HttpUriRequest getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) -
getQueryMethodParameters
-
getUpdateMethodParameters
-
getUpdateMethodParameters
-
getBackgroundTupleQueryResult
@Deprecated(since="4.1.2") protected TupleQueryResult getBackgroundTupleQueryResult(org.apache.http.client.methods.HttpUriRequest method, WeakReference<?> callerRef) throws RepositoryException, QueryInterruptedException, MalformedQueryException, IOException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedParse the response in a background thread. HTTP connections are dealt with in theBackgroundTupleResult
or (in the error-case) in this method. -
getTupleQueryResult
protected void getTupleQueryResult(org.apache.http.client.methods.HttpUriRequest method, TupleQueryResultHandler handler) throws IOException, TupleQueryResultHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Parse the response in this thread using the providedTupleQueryResultHandler
. All HTTP connections are closed and released in this method -
getRDFBackground
@Deprecated(since="4.1.2") protected GraphQueryResult getRDFBackground(org.apache.http.client.methods.HttpUriRequest method, boolean requireContext, WeakReference<?> callerRef) throws IOException, RDFHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Deprecated.WeakReferenceinvalid input: '<'?> callerRef argument will be removedParse the response in a background thread. HTTP connections are dealt with in theBackgroundGraphResult
or (in the error-case) in this method. -
getRDF
protected void getRDF(org.apache.http.client.methods.HttpUriRequest method, RDFHandler handler, boolean requireContext) throws IOException, RDFHandlerException, RepositoryException, MalformedQueryException, UnauthorizedException, QueryInterruptedException Parse the response in this thread using the providedRDFHandler
. All HTTP connections are closed and released in this method -
getBoolean
protected boolean getBoolean(org.apache.http.client.methods.HttpUriRequest method) throws IOException, RDF4JException Parse the response in this thread using a suitableBooleanQueryResultParser
. All HTTP connections are closed and released in this method- Throws:
RDF4JException
IOException
-
executeOK
protected org.apache.http.HttpResponse executeOK(org.apache.http.client.methods.HttpUriRequest method) throws IOException, RDF4JException Convenience method to deal with HTTP level errors of tuple, graph and boolean queries in the same way. This method aborts the HTTP connection.- Parameters:
method
-- Throws:
RDF4JException
IOException
-
executeNoContent
protected void executeNoContent(org.apache.http.client.methods.HttpUriRequest method) throws IOException, RDF4JException - Throws:
IOException
RDF4JException
-
execute
protected org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest method) throws IOException, RDF4JException - Throws:
IOException
RDF4JException
-
getResponseMIMEType
Gets the MIME type specified in the response headers of the supplied method, if any. For example, if the response headers contain Content-Type: application/xml;charset=UTF-8, this method will return application/xml as the MIME type.- Parameters:
method
- The method to get the reponse MIME type from.- Returns:
- The response MIME type, or null if not available.
- Throws:
IOException
-
getErrorInfo
- Throws:
RepositoryException
-
setParserConfig
Sets the parser configuration used to process HTTP response data.- Parameters:
parserConfig
- The parserConfig to set.
-
getParserConfig
- Returns:
- Returns the parser configuration used to process HTTP response data.
-
getConnectionTimeout
public long getConnectionTimeout()Gets the http connection read timeout in milliseconds. -
setConnectionTimeout
public void setConnectionTimeout(long timeout) Sets the http connection read timeout.- Parameters:
timeout
- timeout in milliseconds. Zero sets to infinity.
-
getHttpContext
protected org.apache.http.protocol.HttpContext getHttpContext()Get theHttpContext
used for sending HTTP requests.- Returns:
- the
HttpContext
instance used for all protocol session requests.
-
isPassThroughEnabled
public boolean isPassThroughEnabled()Indicates if direct pass-through of the endpoint result to the suppliedSink
is enabled.- Returns:
- the passThroughEnabled setting.
-
setPassThroughEnabled
public void setPassThroughEnabled(boolean passThroughEnabled) Configure direct pass-through of the endpoint result to the suppliedSink
.If not explicitly configured, the setting defaults to
true
.- Parameters:
passThroughEnabled
- the passThroughEnabled to set.
-
DEFAULT_MAXIMUM_URL_LENGTH
instead.