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
public class RDF4JProtocolSession extends SPARQLProtocolSession
ASPARQLProtocolSessionsubclass 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 org.eclipse.rdf4j.http.client.SPARQLProtocolSession
DEFAULT_MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH, MAXIMUM_URL_LENGTH_PARAM, UTF8
-
-
Constructor Summary
Constructors Constructor Description RDF4JProtocolSession(org.apache.http.client.HttpClient client, ExecutorService executor)RDF4JProtocolSession(org.apache.http.client.HttpClient client, ScheduledExecutorService executor)Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts)voidbeginTransaction(IsolationLevel isolationLevel)voidbeginTransaction(TransactionSetting... transactionSettings)protected voidcheckRepositoryURL()protected voidcheckServerURL()voidclearNamespaces()voidclose()voidcommitTransaction()voidcreateRepository(RepositoryConfig config)Create a new repository.voiddeleteRepository(String repositoryID)TupleQueryResultgetContextIDs()voidgetContextIDs(TupleQueryResultHandler handler)StringgetNamespace(String prefix)TupleQueryResultgetNamespaces()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 suppliedStatementCollectorTupleQueryResultgetRepositoryList()voidgetRepositoryList(TupleQueryResultHandler handler)StringgetRepositoryURL()StringgetServerProtocol()StringgetServerURL()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)StringgetUpdateURL()voidprepareTransaction()voidremoveData(InputStream contents, String baseURI, RDFFormat dataFormat, Resource... contexts)voidremoveNamespacePrefix(String prefix)voidrollbackTransaction()voidsendTransaction(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.longsize(Resource... contexts)voidupdateRepository(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 Detail
-
RDF4JProtocolSession
@Deprecated(since="3.6.2") public RDF4JProtocolSession(org.apache.http.client.HttpClient client, ScheduledExecutorService executor)
Deprecated.
-
RDF4JProtocolSession
public RDF4JProtocolSession(org.apache.http.client.HttpClient client, ExecutorService executor)
-
-
Method Detail
-
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:
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
public String getServerProtocol() throws IOException, RepositoryException, UnauthorizedException
-
size
public long size(Resource... contexts) throws IOException, RepositoryException, UnauthorizedException
-
createRepository
public void createRepository(RepositoryConfig config) throws IOException, RepositoryException
Create a new repository.- Parameters:
config- the repository configuration- Throws:
IOExceptionRepositoryException
-
updateRepository
public void updateRepository(RepositoryConfig config) throws IOException, RepositoryException
Update the config of an existing repository.- Parameters:
config- the repository configuration- Throws:
IOExceptionRepositoryException
-
deleteRepository
public void deleteRepository(String repositoryID) throws IOException, RepositoryException
- 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
public void clearNamespaces() throws IOException, RepositoryException, UnauthorizedException
-
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
public void prepareTransaction() throws RDF4JException, IOException, UnauthorizedException
-
commitTransaction
public void commitTransaction() throws RDF4JException, IOException, UnauthorizedException
-
rollbackTransaction
public void rollbackTransaction() 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.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
public void setUsernameAndPassword(String username, String password)
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
-
-