Package org.eclipse.rdf4j.repository.sparql

Class SPARQLRepository

java.lang.Object

org.eclipse.rdf4j.repository.base.AbstractRepository

org.eclipse.rdf4j.repository.sparql.SPARQLRepository

All Implemented Interfaces:

HttpClientDependent, SessionManagerDependent, Repository

public class SPARQLRepository
extends AbstractRepository
implements HttpClientDependent, SessionManagerDependent

A proxy class to access any SPARQL 1.1 endpoint.

Author:

James Leigh

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
SPARQLRepository(String endpointUrl)	Create a new SPARQLRepository using the supplied endpoint URL for queries and updates.
SPARQLRepository(String queryEndpointUrl, String updateEndpointUrl)	Create a new SPARQLRepository using the supplied query endpoint URL for queries, and the supplied update endpoint URL for updates.

Method Summary

Modifier and Type	Method	Description
protected SPARQLProtocolSession	createHTTPClient()	Deprecated. use createSPARQLProtocolSession() instead
protected SPARQLProtocolSession	createSPARQLProtocolSession()	Creates a new SPARQLProtocolSession object.
void	enableQuadMode(boolean flag)	Activate quad mode for this SPARQLRepository, i.e.
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()
Boolean	getPassThroughEnabled()	Retrieve the passThroughEnabled setting to be used for any newly created RepositoryConnections.
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	setPassThroughEnabled(Boolean passThroughEnabled)	Set the passThroughEnabled configuration.
void	setUsernameAndPassword(String username, String password)	Set the username and password to use for authenticating with the remote repository.
protected void	shutDownInternal()
String	toString()

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, wait, wait, wait

Constructor Detail

SPARQLRepository

public SPARQLRepository(String endpointUrl)

Create a new SPARQLRepository using the supplied endpoint URL for queries and updates.

Parameters:

endpointUrl - a SPARQL endpoint URL. May not be null.

SPARQLRepository

public SPARQLRepository(String queryEndpointUrl,
                        String updateEndpointUrl)

Create a new SPARQLRepository using the supplied query endpoint URL for queries, and the supplied update endpoint URL for updates.

Parameters:

queryEndpointUrl - a SPARQL endpoint URL for queries. May not be null.

updateEndpointUrl - a SPARQL endpoint URL for updates. May not be null.

Throws:

IllegalArgumentException - if one of the supplied endpoint URLs is null.

Method Detail

getHttpClientSessionManager

public HttpClientSessionManager getHttpClientSessionManager()

Specified by:

getHttpClientSessionManager in interface SessionManagerDependent

setHttpClientSessionManager

public void setHttpClientSessionManager(HttpClientSessionManager client)

Specified by:

setHttpClientSessionManager in interface SessionManagerDependent

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

createSPARQLProtocolSession

protected SPARQLProtocolSession createSPARQLProtocolSession()

Creates a new SPARQLProtocolSession object. The life-cycle of this is per-connection.

Returns:

a SPARQLProtocolSession object.

createHTTPClient

@Deprecated
protected SPARQLProtocolSession createHTTPClient()

Deprecated.

use createSPARQLProtocolSession() instead

getConnection

public RepositoryConnection getConnection()
                                   throws RepositoryException

Specified by:

getConnection in interface Repository

Throws:

RepositoryException

getDataDir

public File getDataDir()

Specified by:

getDataDir in interface Repository

getValueFactory

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

Specified by:

getValueFactory in interface Repository

initializeInternal

protected void initializeInternal()
                           throws RepositoryException

Specified by:

initializeInternal in class AbstractRepository

Throws:

RepositoryException

isWritable

public boolean isWritable()
                   throws RepositoryException

Specified by:

isWritable in interface Repository

Throws:

RepositoryException

setDataDir

public void setDataDir(File dataDir)

Specified by:

setDataDir in interface Repository

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.

shutDownInternal

protected void shutDownInternal()
                         throws RepositoryException

Specified by:

shutDownInternal in class AbstractRepository

Throws:

RepositoryException

toString

public String toString()

Overrides:

toString in class Object

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

enableQuadMode

public void enableQuadMode(boolean flag)

Activate quad mode for this SPARQLRepository, i.e. for retrieval of statements also retrieve the graph.

Note: the setting is only applied in newly created SPARQLConnections as the setting is an immutable configuration of a connection instance.

Parameters:

flag - flag to enable or disable the quad mode

See Also:

SPARQLConnection#getStatements(org.eclipse.rdf4j.model.Resource, org.eclipse.rdf4j.model.URI, org.eclipse.rdf4j.model.Value, boolean, org.eclipse.rdf4j.model.Resource...)

getPassThroughEnabled

public Boolean getPassThroughEnabled()

Retrieve the passThroughEnabled setting to be used for any newly created RepositoryConnections.

Returns:

the passThroughEnabled setting. May be null if not explicitly configured.

See Also:

SPARQLProtocolSession.isPassThroughEnabled()

setPassThroughEnabled

public void setPassThroughEnabled(Boolean passThroughEnabled)

Set the passThroughEnabled configuration. Changing this will influence behavior of any new RepositoryConnections, but not of existing ones.

Parameters:

passThroughEnabled - the passThroughEnabled to set

See Also:

SPARQLProtocolSession#setPassThroughEnabled()