Class RemoteRepositoryManager

java.lang.Object

org.eclipse.rdf4j.repository.manager.RepositoryManager

org.eclipse.rdf4j.repository.manager.RemoteRepositoryManager

All Implemented Interfaces:

HttpClientDependent, RepositoryResolver

public class RemoteRepositoryManager
extends RepositoryManager

A manager for Repositorys that reside on a remote server. This repository manager allows one to access repositories over HTTP similar to how local repositories are accessed using the LocalRepositoryManager.

Author:

Arjohn Kampman

Field Summary

Fields inherited from class RepositoryManager

initializedRepositories, logger, NAMESPACE, PROXIED_ID

Modifier and Type	Field	Description
protected Map<String, Repository>	initializedRepositories
protected final org.slf4j.Logger	logger
static final String	NAMESPACE	Deprecated. use CONFIG.Proxy instead.
static final IRI	PROXIED_ID	Deprecated, for removal: This API element is subject to removal in a future version. use CONFIG.Proxy.proxiedID instead.

Constructor Summary

Constructors

Constructor	Description
RemoteRepositoryManager(String serverURL)	Creates a new RepositoryManager that operates on the specified base directory.

Method Summary

Modifier and Type	Method	Description
void	addRepositoryConfig(RepositoryConfig config)	Adds or updates the configuration of a repository to the manager.
protected Repository	createRepository(String id)	Creates and initializes the repository with the specified ID.
Collection<RepositoryInfo>	getAllRepositoryInfos()	Retrieve meta information of all configured repositories.
RDF4JHttpClient	getHttpClient()	RDF4JHttpClient that has been assigned or has been used by this object.
static RemoteRepositoryManager	getInstance(String serverURL)	Creates an initialized RemoteRepositoryManager with the specified server URL.
static RemoteRepositoryManager	getInstance(String serverURL, String username, String password)	Creates an initialized RemoteRepositoryManager with the specified server URL and credentials.
URL	getLocation()	Gets the URL of the remote server, e.g.
RepositoryConfig	getRepositoryConfig(String id)
String	getServerURL()	Gets the URL of the remote server, e.g.
protected SharedHttpClientSessionManager	getSharedHttpClientSessionManager()
boolean	removeRepository(String repositoryID)	Removes the specified repository by deleting its configuration if such a configuration is present, and removing any persistent data associated with the repository.
void	setHttpClient(RDF4JHttpClient protocolSession)	Should be called before RepositoryManager.init().
void	setUsernameAndPassword(String username, String password)	Set the username and password for authenication with the remote server.
void	shutDown()	Shuts down all initialized repositories.

Methods inherited from class RepositoryManager

getAllRepositories, getAllRepositoryInfos, getAllUserRepositoryInfos, getInitializedRepositories, getInitializedRepositoryIDs, getModelFactory, getNewRepositoryID, getRepository, getRepositoryIDs, getRepositoryInfo, hasRepositoryConfig, init, isInitialized, isSafeToRemove, refresh, setInitializedRepositories, setModelFactory, updateInitializedRepositories

Modifier and Type	Method	Description
Collection<Repository>	getAllRepositories()	Returns all configured repositories.
Collection<RepositoryInfo>	getAllRepositoryInfos(boolean skipSystemRepo)	Deprecated. Use RepositoryManager.getAllRepositoryInfos() instead.
Collection<RepositoryInfo>	getAllUserRepositoryInfos()	Deprecated. Use RepositoryManager.getAllRepositoryInfos() instead.
Collection<Repository>	getInitializedRepositories()	Returns all initialized repositories.
Set<String>	getInitializedRepositoryIDs()	Returns all initialized repositories.
ModelFactory	getModelFactory()	Get the ModelFactory used for creating new Model objects in the manager.
String	getNewRepositoryID(String baseName)	Generates an ID for a new repository based on the specified base name.
Repository	getRepository(String identity)	Gets the repository that is known by the specified ID from this manager.
Set<String>	getRepositoryIDs()	Get the IDs of all available repositories.
RepositoryInfo	getRepositoryInfo(String id)	Gets the repository that is known by the specified ID from this manager.
boolean	hasRepositoryConfig(String repositoryID)
void	init()	Initializes the repository manager.
boolean	isInitialized()	Indicates if this RepositoryManager has been initialized.
boolean	isSafeToRemove(String repositoryID)	Checks on whether the given repository is referred to by a ProxyRepository configuration.
void	refresh()	Shuts down all initialized user repositories.
protected void	setInitializedRepositories(Map<String, Repository> nextInitializedRepositories)
void	setModelFactory(ModelFactory modelFactory)	Set the ModelFactory to use for creating new Model objects in the manager.
protected void	updateInitializedRepositories()

Methods inherited from class Object

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

Constructor Details

RemoteRepositoryManager

public RemoteRepositoryManager(String serverURL)

Creates a new RepositoryManager that operates on the specified base directory.

Parameters:

serverURL - The URL of the server.

Method Details

getInstance

public static RemoteRepositoryManager getInstance(String serverURL)
                                           throws RepositoryException

Creates an initialized RemoteRepositoryManager with the specified server URL.

Throws:

RepositoryException

getInstance

public static RemoteRepositoryManager getInstance(String serverURL,
 String username,
 String password)
                                           throws RepositoryException

Creates an initialized RemoteRepositoryManager with the specified server URL and credentials.

Throws:

RepositoryException

getSharedHttpClientSessionManager

protected SharedHttpClientSessionManager getSharedHttpClientSessionManager()

Returns:

Returns the SharedHttpClientSessionManager

getHttpClient

public RDF4JHttpClient getHttpClient()

Description copied from interface: HttpClientDependent

RDF4JHttpClient 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 whether RDF4JHttpClient was passed to or created by this object respectively.

Specified by:

getHttpClient in interface HttpClientDependent

Specified by:

getHttpClient in class RepositoryManager

Returns:

Returns the httpClient passed to Repository construction.

setHttpClient

public void setHttpClient(RDF4JHttpClient protocolSession)

Description copied from class: RepositoryManager

Should be called before RepositoryManager.init().

Specified by:

setHttpClient in interface HttpClientDependent

Specified by:

setHttpClient in class RepositoryManager

Parameters:

protocolSession - The httpClient to use for remote/service calls.

shutDown

public void shutDown()

Description copied from class: RepositoryManager

Shuts down all initialized repositories.

Overrides:

shutDown in class RepositoryManager

See Also:

• RepositoryManager.refresh()

setUsernameAndPassword

public void setUsernameAndPassword(String username,
 String password)

Set the username and password for authenication with the remote server.

Parameters:

username - the username

password - the password

getLocation

public URL getLocation()
                throws MalformedURLException

Gets the URL of the remote server, e.g. "http://localhost:8080/rdf4j-server/".

Specified by:

getLocation in class RepositoryManager

Throws:

MalformedURLException - If serverURL cannot be parsed

getServerURL

public String getServerURL()

Gets the URL of the remote server, e.g. "http://localhost:8080/rdf4j-server/".

createRepository

protected Repository createRepository(String id)
                               throws RepositoryConfigException,
RepositoryException

Creates and initializes the repository with the specified ID.

Specified by:

createRepository in class RepositoryManager

Parameters:

id - A repository ID.

Returns:

The created repository, or null if no such repository exists.

Throws:

RepositoryConfigException - If no repository could be created due to invalid or incomplete configuration data.

RepositoryException - If the repository could not be initialized.

getRepositoryConfig

public RepositoryConfig getRepositoryConfig(String id)
                                     throws RepositoryException

Specified by:

getRepositoryConfig in class RepositoryManager

Throws:

RepositoryException

getAllRepositoryInfos

public Collection<RepositoryInfo> getAllRepositoryInfos()
                                                 throws RepositoryException

Description copied from class: RepositoryManager

Retrieve meta information of all configured repositories.

Specified by:

getAllRepositoryInfos in class RepositoryManager

Returns:

a collection of RepositoryInfo objects

Throws:

RepositoryException - if the repository meta information could not be retrieved.

addRepositoryConfig

public void addRepositoryConfig(RepositoryConfig config)
                         throws RepositoryException,
RepositoryConfigException

Description copied from class: RepositoryManager

Adds or updates the configuration of a repository to the manager. The manager may already contain a configuration for a repository with the same ID as specified by config, in which case all previous configuration data for that repository will be cleared before the new configuration is added.

Specified by:

addRepositoryConfig in class RepositoryManager

Parameters:

config - The repository configuration that should be added to or updated in the manager.

Throws:

RepositoryException - If the manager failed to update.

RepositoryConfigException - If the manager doesn't know how to update a configuration due to inconsistent configuration data. For example, this happens when there are multiple existing configurations with the concerning ID.

removeRepository

public boolean removeRepository(String repositoryID)
                         throws RepositoryException,
RepositoryConfigException

Description copied from class: RepositoryManager

Removes the specified repository by deleting its configuration if such a configuration is present, and removing any persistent data associated with the repository. Returns true if the specified repository configuration was actually present. NB this operation can not be undone!

Overrides:

removeRepository in class RepositoryManager

Parameters:

repositoryID - The ID of the repository that needs to be removed.

Throws:

RepositoryException - If the manager failed to update the configuration.

RepositoryConfigException - If the manager doesn't know how to remove a repository due to inconsistent configuration data. For example, this can happen when there are multiple existing configurations with the concerning ID.