Package org.eclipse.rdf4j.repository.http

Class HTTPRepository

java.lang.Object

org.eclipse.rdf4j.repository.base.AbstractRepository

org.eclipse.rdf4j.repository.http.HTTPRepository

All Implemented Interfaces:

HttpClientDependent, SessionManagerDependent, Repository

public class HTTPRepository
extends AbstractRepository
implements HttpClientDependent, SessionManagerDependent

A repository that serves as a client for a remote repository on an RDF4J Server. Methods in this class may throw the specific RepositoryException subclass UnauthorizedException, the semantics of which is defined by the HTTP protocol.

This repository client uses a RDF4J-specific extension of the SPARQL 1.1 Protocol to communicate with the server. For communicating with a SPARQL endpoint that is not based on RDF4J, it is recommended to use SPARQLRepository instead.

Author:

Arjohn Kampman, Jeen Broekstra, Herko ter Horst

See Also:

UnauthorizedException

Field Summary

Fields inherited from class org.eclipse.rdf4j.repository.base.AbstractRepository

logger

Constructor Summary

Constructors

Constructor	Description
HTTPRepository(String repositoryURL)
HTTPRepository(String serverURL, String repositoryID)

Method Summary

Modifier and Type	Method	Description
protected RDF4JProtocolSession	createHTTPClient()	Creates a new RDF4JProtocolSession object.
Map<String,String>	getAdditionalHttpHeaders()	Get the additional HTTP headers which will be used
RepositoryConnection	getConnection()
File	getDataDir()
org.apache.http.client.HttpClient	getHttpClient()
HttpClientSessionManager	getHttpClientSessionManager()
RDFFormat	getPreferredRDFFormat()	Indicates the current preferred RDFFormat.
TupleQueryResultFormat	getPreferredTupleQueryResultFormat()	Indicates the current preferred TupleQueryResultFormat.
String	getRepositoryURL()
org.eclipse.rdf4j.model.ValueFactory	getValueFactory()
protected void	initializeInternal()
boolean	isWritable()
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	setDataDir(File dataDir)
void	setHttpClient(org.apache.http.client.HttpClient httpClient)
void	setHttpClientSessionManager(HttpClientSessionManager client)
void	setPreferredRDFFormat(RDFFormat format)	Sets the preferred serialization format for RDF to the supplied RDFFormat, overriding the SPARQLProtocolSession's default preference.
void	setPreferredTupleQueryResultFormat(TupleQueryResultFormat format)	Sets the preferred serialization format for tuple query results to the supplied TupleQueryResultFormat, overriding the SPARQLProtocolSession 's default preference.
void	setUsernameAndPassword(String username, String password)	Set the username and password to use for authenticating with the remote repository.
protected void	shutDownInternal()

Methods inherited from class org.eclipse.rdf4j.repository.base.AbstractRepository

init, isInitialized, shutDown

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRepository

public HTTPRepository(String serverURL,
                      String repositoryID)

HTTPRepository

public HTTPRepository(String repositoryURL)

Method Detail

setDataDir

public void setDataDir(File dataDir)

Specified by:

setDataDir in interface Repository

getDataDir

public File getDataDir()

Specified by:

getDataDir in interface Repository

getHttpClientSessionManager

public HttpClientSessionManager getHttpClientSessionManager()

Specified by:

getHttpClientSessionManager in interface SessionManagerDependent

setHttpClientSessionManager

public void setHttpClientSessionManager(HttpClientSessionManager client)

Specified by:

setHttpClientSessionManager in interface SessionManagerDependent

getAdditionalHttpHeaders

public Map<String,String> getAdditionalHttpHeaders()

Get the additional HTTP headers which will be used

Returns:

a read-only view of the additional HTTP headers which will be included in every request to the server.

setAdditionalHttpHeaders

public 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. This will only take effect on connections subsequently returned by getConnection().

Parameters:

additionalHttpHeaders - a map containing pairs of header names and values. May be null

getHttpClient

public final org.apache.http.client.HttpClient getHttpClient()

Specified by:

getHttpClient in interface HttpClientDependent

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

Specified by:

setHttpClient in interface HttpClientDependent

getValueFactory

public org.eclipse.rdf4j.model.ValueFactory getValueFactory()

Specified by:

getValueFactory in interface Repository

getConnection

public RepositoryConnection getConnection()
                                   throws RepositoryException

Specified by:

getConnection in interface Repository

Throws:

RepositoryException

isWritable

public boolean isWritable()
                   throws RepositoryException

Specified by:

isWritable in interface Repository

Throws:

RepositoryException

setPreferredTupleQueryResultFormat

public void setPreferredTupleQueryResultFormat(TupleQueryResultFormat format)

Sets the preferred serialization format for tuple query results to the supplied TupleQueryResultFormat, overriding the SPARQLProtocolSession 's default preference. Setting this parameter is not necessary in most cases as the SPARQLProtocolSession by default indicates a preference for the most compact and efficient format available.

Parameters:

format - the preferred TupleQueryResultFormat. If set to 'null' no explicit preference will be stated.

getPreferredTupleQueryResultFormat

public TupleQueryResultFormat getPreferredTupleQueryResultFormat()

Indicates the current preferred TupleQueryResultFormat.

Returns:

The preferred format, of 'null' if no explicit preference is defined.

setPreferredRDFFormat

public void setPreferredRDFFormat(RDFFormat format)

Sets the preferred serialization format for RDF to the supplied RDFFormat, overriding the SPARQLProtocolSession's default preference. Setting this parameter is not necessary in most cases as the SPARQLProtocolSession by default indicates a preference for the most compact and efficient format available.

Use with caution: if set to a format that does not support context serialization any context info contained in the query result will be lost.

Parameters:

format - the preferred RDFFormat. If set to 'null' no explicit preference will be stated.

getPreferredRDFFormat

public RDFFormat getPreferredRDFFormat()

Indicates the current preferred RDFFormat.

Returns:

The preferred format, of 'null' if no explicit preference is defined.

setUsernameAndPassword

public void setUsernameAndPassword(String username,
                                   String password)

Set the username and password to use for authenticating with the remote repository.

Parameters:

username - the username. Setting this to null will disable authentication.

password - the password. Setting this to null will disable authentication.

getRepositoryURL

public String getRepositoryURL()

initializeInternal

protected void initializeInternal()
                           throws RepositoryException

Specified by:

initializeInternal in class AbstractRepository

Throws:

RepositoryException

shutDownInternal

protected void shutDownInternal()
                         throws RepositoryException

Specified by:

shutDownInternal in class AbstractRepository

Throws:

RepositoryException

createHTTPClient

protected RDF4JProtocolSession createHTTPClient()

Creates a new RDF4JProtocolSession object.

Returns:

a RDF4JProtocolSession object.