Package org.eclipse.rdf4j.http.client
Class RDF4JProtocolSession
java.lang.Object
org.eclipse.rdf4j.http.client.SPARQLProtocolSession
org.eclipse.rdf4j.http.client.RDF4JProtocolSession
- All Implemented Interfaces:
AutoCloseable,HttpClientDependent
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:
-
Field Summary
Fields inherited from class org.eclipse.rdf4j.http.client.SPARQLProtocolSession
DEFAULT_MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH_PARAM, UTF8 -
Constructor Summary
ConstructorsConstructorDescriptionRDF4JProtocolSession(org.apache.http.client.HttpClient client, ExecutorService executor) RDF4JProtocolSession(org.apache.http.client.HttpClient client, ScheduledExecutorService executor) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts) voidbeginTransaction(IsolationLevel isolationLevel) voidbeginTransaction(TransactionSetting... transactionSettings) protected voidprotected voidvoidvoidclose()voidvoidcreateRepository(RepositoryConfig config) Create a new repository.voiddeleteRepository(String repositoryID) voidgetContextIDs(TupleQueryResultHandler handler) getNamespace(String prefix) voidgetNamespaces(TupleQueryResultHandler handler) protected org.apache.http.client.methods.HttpUriRequestgetQueryMethod(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) voidgetRepositoryConfig(StatementCollector statementCollector) Retrieve configuration of the current repository and send it to the suppliedStatementCollectorvoidgetRepositoryList(TupleQueryResultHandler handler) voidgetStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, RDFHandler handler, Resource... contexts) protected org.apache.http.client.methods.HttpUriRequestgetUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxExecutionTime, Binding... bindings) protected List<org.apache.http.NameValuePair>getUpdateMethodParameters(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) voidvoidremoveData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts) voidremoveNamespacePrefix(String prefix) voidvoidsendTransaction(Iterable<? extends TransactionOperation> txn) Deprecated.since 2.8.0voidsetNamespacePrefix(String prefix, String name) voidsetRepository(String repositoryURL) voidsetServerURL(String serverURL) voidsetUsernameAndPassword(String username, String password) Set the username and password for authentication with the remote server.longvoidupdateRepository(RepositoryConfig config) Update the config of an existing repository.protected voidupload(InputStream contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) voidupload(InputStream contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Resource... contexts) protected voidupload(Reader contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) voidupload(Reader contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Resource... contexts) protected voidupload(org.apache.http.HttpEntity reqEntity, String baseURI, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) Methods inherited from class org.eclipse.rdf4j.http.client.SPARQLProtocolSession
execute, executeNoContent, executeOK, getAdditionalHttpHeaders, getBackgroundTupleQueryResult, getBoolean, getConnectionTimeout, getErrorInfo, getHttpClient, getHttpContext, 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, setConnectionTimeout, setHttpClient, setParserConfig, setPassThroughEnabled, setPreferredBooleanQueryResultFormat, setPreferredRDFFormat, setPreferredTupleQueryResultFormat, setQueryURL, setUpdateURL, setUsernameAndPasswordForUrl, setValueFactory, shouldUsePost
-
Constructor Details
-
RDF4JProtocolSession
@Deprecated(since="3.6.2") public RDF4JProtocolSession(org.apache.http.client.HttpClient client, ScheduledExecutorService executor) Deprecated. -
RDF4JProtocolSession
-
-
Method Details
-
setServerURL
-
getServerURL
-
getRepositoryURL
-
setRepository
-
checkRepositoryURL
protected void checkRepositoryURL() -
checkServerURL
protected void checkServerURL() -
getUpdateURL
- Overrides:
getUpdateURLin classSPARQLProtocolSession
-
close
public void close()- Specified by:
closein interfaceAutoCloseable- Overrides:
closein classSPARQLProtocolSession
-
getRepositoryList
public TupleQueryResult getRepositoryList() throws IOException, RepositoryException, UnauthorizedException, QueryInterruptedException -
getRepositoryList
public void getRepositoryList(TupleQueryResultHandler handler) throws IOException, TupleQueryResultHandlerException, RepositoryException, UnauthorizedException, QueryInterruptedException -
getServerProtocol
-
size
public long size(Resource... contexts) throws IOException, RepositoryException, UnauthorizedException -
createRepository
Create a new repository.- Parameters:
config- the repository configuration- Throws:
IOExceptionRepositoryException
-
updateRepository
Update the config of an existing repository.- Parameters:
config- the repository configuration- Throws:
IOExceptionRepositoryException
-
deleteRepository
- Throws:
IOExceptionRepositoryException
-
getRepositoryConfig
public void getRepositoryConfig(StatementCollector statementCollector) throws UnauthorizedException, QueryInterruptedException, RDFHandlerException, RepositoryException, IOException Retrieve configuration of the current repository and send it to the suppliedStatementCollector- Parameters:
statementCollector- receiver of the repository config information- Throws:
IOExceptionRepositoryExceptionRDFHandlerExceptionQueryInterruptedExceptionUnauthorizedException- Since:
- 3.1.0
-
getNamespaces
public TupleQueryResult getNamespaces() throws IOException, RepositoryException, UnauthorizedException, QueryInterruptedException -
getNamespaces
public void getNamespaces(TupleQueryResultHandler handler) throws IOException, TupleQueryResultHandlerException, RepositoryException, UnauthorizedException, QueryInterruptedException -
getNamespace
public String getNamespace(String prefix) throws IOException, RepositoryException, UnauthorizedException -
setNamespacePrefix
public void setNamespacePrefix(String prefix, String name) throws IOException, RepositoryException, UnauthorizedException -
removeNamespacePrefix
public void removeNamespacePrefix(String prefix) throws IOException, RepositoryException, UnauthorizedException -
clearNamespaces
-
getContextIDs
public TupleQueryResult getContextIDs() throws IOException, RepositoryException, UnauthorizedException, QueryInterruptedException -
getContextIDs
public void getContextIDs(TupleQueryResultHandler handler) 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 -
beginTransaction
public void beginTransaction(IsolationLevel isolationLevel) throws RDF4JException, IOException, UnauthorizedException -
beginTransaction
public void beginTransaction(TransactionSetting... transactionSettings) throws RDF4JException, IOException, UnauthorizedException -
prepareTransaction
-
commitTransaction
-
rollbackTransaction
-
sendTransaction
@Deprecated(since="2.8.0") public void sendTransaction(Iterable<? extends TransactionOperation> txn) throws IOException, RepositoryException, UnauthorizedException Deprecated.since 2.8.0Sends a transaction list as serialized XML to the server.- Parameters:
txn-- Throws:
IOExceptionRepositoryExceptionUnauthorizedException
-
addData
public void addData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts) throws UnauthorizedException, RDFParseException, RepositoryException, IOException -
removeData
public void removeData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts) 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 -
upload
protected void upload(InputStream contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) 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 -
getQueryMethod
protected org.apache.http.client.methods.HttpUriRequest getQueryMethod(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) - Overrides:
getQueryMethodin classSPARQLProtocolSession
-
getUpdateMethod
protected org.apache.http.client.methods.HttpUriRequest getUpdateMethod(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxExecutionTime, Binding... bindings) - Overrides:
getUpdateMethodin classSPARQLProtocolSession
-
upload
protected void upload(Reader contents, String baseURI, RDFFormat dataFormat, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) throws IOException, RDFParseException, RepositoryException, UnauthorizedException -
upload
protected void upload(org.apache.http.HttpEntity reqEntity, String baseURI, boolean overwrite, boolean preserveNodeIds, Protocol.Action action, Resource... contexts) throws IOException, RDFParseException, RepositoryException, UnauthorizedException -
setUsernameAndPassword
Description copied from class:SPARQLProtocolSessionSet the username and password for authentication with the remote server.- Overrides:
setUsernameAndPasswordin classSPARQLProtocolSession- Parameters:
username- the usernamepassword- the password
-
getQueryMethodParameters
protected List<org.apache.http.NameValuePair> getQueryMethodParameters(QueryLanguage ql, String query, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) - Overrides:
getQueryMethodParametersin classSPARQLProtocolSession
-
getUpdateMethodParameters
protected List<org.apache.http.NameValuePair> getUpdateMethodParameters(QueryLanguage ql, String update, String baseURI, Dataset dataset, boolean includeInferred, int maxQueryTime, Binding... bindings) - Overrides:
getUpdateMethodParametersin classSPARQLProtocolSession
-
RDF4JProtocolSession(HttpClient, ExecutorService)instead