Class FedX

java.lang.Object

org.eclipse.rdf4j.sail.helpers.AbstractSail

org.eclipse.rdf4j.federated.FedX

All Implemented Interfaces:

RepositoryResolverClient, Sail

public class FedX
extends AbstractSail
implements RepositoryResolverClient

FedX serves as implementation of the federation layer. It implements RDF4J's Sail interface and can thus be used as a normal repository in a RDF4J environment. The federation layer enables transparent access to the underlying members as if they were a central repository.

For initialization of the federation and usage see FederationManager.

Author:

Andreas Schwarte

Field Summary

Fields inherited from class AbstractSail

connectionTimeOut, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_ITERATION_SYNC_THRESHOLD, initializationLock

Modifier and Type	Field	Description
protected long	connectionTimeOut	Connection timeout on shutdown (in ms).
protected static final long	DEFAULT_CONNECTION_TIMEOUT	Default connection timeout on shutdown: 20,000 milliseconds (20 seconds).
protected static final long	DEFAULT_ITERATION_SYNC_THRESHOLD	default value for the Iteration item sync threshold
protected final ReentrantReadWriteLock	initializationLock	Lock used to synchronize the initialization state of a sail.

Constructor Summary

Constructors

Constructor	Description
FedX(List<Endpoint> endpoints)

Method Summary

Modifier and Type	Method	Description
protected void	addMember(Endpoint endpoint)	Add a member to the federation (internal).
Supplier<CollectionFactory>	getCollectionFactory()	Gets a CollectionFactory that may be optimized for this store and may or may not use disk or other resources.
protected SailConnection	getConnectionInternal()	Returns a store-specific SailConnection object.
File	getDataDir()	Gets the Sail's data directory.
List<Endpoint>	getMembers()
ValueFactory	getValueFactory()	Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.
protected void	initializeInternal()	Do store-specific operations to initialize the store.
protected void	initializeMember(Endpoint member)
boolean	isWritable()	Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.
boolean	removeMember(Endpoint endpoint)	Remove a member from the federation (internal)
void	setDataDir(File dataDir)	Sets the data directory for the Sail.
void	setFederationContext(FederationContext federationContext)
void	setFederationEvaluationStrategy(FederationEvaluationStrategyFactory strategyFactory)
void	setRepositoryResolver(RepositoryResolver resolver)
void	setSchedulerFactory(SchedulerFactory schedulerFactory)	Set the SchedulerFactory.
void	setWriteStrategyFactory(WriteStrategyFactory writeStrategyFactory)
protected void	shutDownInternal()	Try to shut down all federation members.

Methods inherited from class AbstractSail

addSupportedIsolationLevel, connectionClosed, debugEnabled, getConnection, getDefaultIsolationLevel, getDefaultQueryEvaluationMode, getIterationCacheSyncThreshold, getSupportedIsolationLevels, init, isInitialized, isTrackResultSize, removeSupportedIsolationLevel, setConnectionTimeOut, setDefaultIsolationLevel, setDefaultQueryEvaluationMode, setIterationCacheSyncThreshold, setSupportedIsolationLevels, setSupportedIsolationLevels, setTrackResultSize, shutDown, toString

Modifier and Type	Method	Description
protected void	addSupportedIsolationLevel(IsolationLevels level)	Appends the provided IsolationLevels to the SAIL's list of supported isolation levels.
protected void	connectionClosed(SailConnection connection)	Signals to the store that the supplied connection has been closed; called by AbstractSailConnection.close().
protected static boolean	debugEnabled()
SailConnection	getConnection()	Opens a connection on the Sail which can be used to query and update data.
IsolationLevel	getDefaultIsolationLevel()	Retrieves the default IsolationLevel level on which transactions in this Sail operate.
QueryEvaluationMode	getDefaultQueryEvaluationMode()
long	getIterationCacheSyncThreshold()	Retrieves the currently configured threshold for syncing query evaluation iteration caches to disk.
List<IsolationLevel>	getSupportedIsolationLevels()	Retrieve the IsolationLevels supported by this SAIL, ordered by increasing complexity.
void	init()	Initializes the Sail.
protected boolean	isInitialized()	Checks whether the Sail has been initialized.
boolean	isTrackResultSize()	Returns the status of the result size tracking for the query plan.
protected void	removeSupportedIsolationLevel(IsolationLevel level)	Removes all occurrences of the provided IsolationLevels in the list of supported Isolation levels.
void	setConnectionTimeOut(long connectionTimeOut)	Set connection timeout on shutdown (in ms).
void	setDefaultIsolationLevel(IsolationLevel defaultIsolationLevel)	Sets the default IsolationLevel on which transactions in this Sail operate.
void	setDefaultQueryEvaluationMode(QueryEvaluationMode defaultQueryEvaluationMode)
void	setIterationCacheSyncThreshold(long iterationCacheSyncThreshold)	Set the threshold for syncing query evaluation iteration caches to disk.
protected void	setSupportedIsolationLevels(List<IsolationLevel> supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
protected void	setSupportedIsolationLevels(IsolationLevel... supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
void	setTrackResultSize(boolean trackResultSize)	Enable or disable results size tracking for the query plan.
void	shutDown()	Shuts down the Sail, giving it the opportunity to synchronize any stale data.
String	toString()

Methods inherited from class Object

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

Constructor Details

FedX

public FedX(List<Endpoint> endpoints)

Method Details

setFederationContext

public void setFederationContext(FederationContext federationContext)

setFederationEvaluationStrategy

public void setFederationEvaluationStrategy(FederationEvaluationStrategyFactory strategyFactory)

setSchedulerFactory

public void setSchedulerFactory(SchedulerFactory schedulerFactory)

Set the SchedulerFactory. Can only be done before initialization of the federation

Parameters:

schedulerFactory - the SchedulerFactory

setWriteStrategyFactory

public void setWriteStrategyFactory(WriteStrategyFactory writeStrategyFactory)

Parameters:

writeStrategyFactory - the WriteStrategyFactory

addMember

protected void addMember(Endpoint endpoint)

Add a member to the federation (internal).

If the federation is already initialized, the given endpoint is explicitly initialized as well.

Parameters:

endpoint -

removeMember

public boolean removeMember(Endpoint endpoint)

Remove a member from the federation (internal)

Parameters:

endpoint -

Returns:

whether the member was removed

getConnectionInternal

protected SailConnection getConnectionInternal()
                                        throws SailException

Description copied from class: AbstractSail

Returns a store-specific SailConnection object.

Specified by:

getConnectionInternal in class AbstractSail

Returns:

A connection to the store.

Throws:

SailException

getDataDir

public File getDataDir()

Description copied from interface: Sail

Gets the Sail's data directory.

Specified by:

getDataDir in interface Sail

Overrides:

getDataDir in class AbstractSail

See Also:

• Sail.setDataDir(File)

getValueFactory

public ValueFactory getValueFactory()

Description copied from interface: Sail

Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.

Specified by:

getValueFactory in interface Sail

Returns:

a ValueFactory object for this Sail object.

initializeInternal

protected void initializeInternal()
                           throws SailException

Description copied from class: AbstractSail

Do store-specific operations to initialize the store. The default implementation of this method does nothing.

Overrides:

initializeInternal in class AbstractSail

Throws:

SailException

initializeMember

protected void initializeMember(Endpoint member)
                         throws SailException

Throws:

SailException

isWritable

public boolean isWritable()
                   throws SailException

Description copied from interface: Sail

Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.

Specified by:

isWritable in interface Sail

Throws:

SailException

setDataDir

public void setDataDir(File dataDir)

Description copied from interface: Sail

Sets the data directory for the Sail. The Sail can use this directory for storage of data, parameters, etc. This directory must be set before the Sail is

invalid reference

initialized

.

Specified by:

setDataDir in interface Sail

Overrides:

setDataDir in class AbstractSail

shutDownInternal

protected void shutDownInternal()
                         throws SailException

Try to shut down all federation members.

Specified by:

shutDownInternal in class AbstractSail

Throws:

FedXException - if not all members could be shut down

SailException

getMembers

public List<Endpoint> getMembers()

Returns:

an unmodifiable view of the current members

setRepositoryResolver

public void setRepositoryResolver(RepositoryResolver resolver)

Specified by:

setRepositoryResolver in interface RepositoryResolverClient

getCollectionFactory

public Supplier<CollectionFactory> getCollectionFactory()

Description copied from interface: Sail

Gets a CollectionFactory that may be optimized for this store and may or may not use disk or other resources.

Specified by:

getCollectionFactory in interface Sail

Returns:

a CollectionFactory