com.bigdata.rdf.sail

Class SailBase

java.lang.Object

com.bigdata.rdf.sail.SailBase

All Implemented Interfaces:

org.openrdf.sail.Sail

Direct Known Subclasses:

BigdataSail

public abstract class SailBase
extends Object
implements org.openrdf.sail.Sail

SailBase is an abstract Sail implementation that takes care of common sail tasks, including proper closing of active connections and a grace period for active connections during shutdown of the store.

Author:

Herko ter Horst, jeen, Arjohn Kampman

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_TIMEOUT
protected long	connectionTimeOut Connection timeout on shutdown (in ms).
protected static long	DEFAULT_CONNECTION_TIMEOUT Default connection timeout on shutdown: 20,000 milliseconds.
protected ReentrantReadWriteLock	initializationLock Lock used to synchronize the initialization state of a sail.
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SailBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	connectionClosed(org.openrdf.sail.SailConnection connection) Signals to the store that the supplied connection has been closed; called by SailConnectionBase#close().
protected static boolean	debugEnabled()
org.openrdf.sail.SailConnection	getConnection()
protected abstract org.openrdf.sail.SailConnection	getConnectionInternal() Returns a store-specific SailConnection object.
File	getDataDir()
void	initialize()
protected void	initializeInternal() Do store-specific operations to initialize the store.
protected boolean	isInitialized() Checks whether the Sail has been initialized.
protected void	manageConnection(org.openrdf.sail.SailConnection cnxn)
void	setDataDir(File dataDir)
void	shutDown()
protected abstract void	shutDownInternal() Do store-specific operations to ensure proper shutdown of the store.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrdf.sail.Sail

getValueFactory, isWritable

Field Detail

CONNECTION_TIMEOUT

public static final String CONNECTION_TIMEOUT

DEFAULT_CONNECTION_TIMEOUT

protected static final long DEFAULT_CONNECTION_TIMEOUT

Default connection timeout on shutdown: 20,000 milliseconds.

logger

protected final org.slf4j.Logger logger

initializationLock

protected final ReentrantReadWriteLock initializationLock

Lock used to synchronize the initialization state of a sail.

• write lock: initialize(), shutDown()
• read lock: getConnection()

connectionTimeOut

protected volatile long connectionTimeOut

Connection timeout on shutdown (in ms). Defaults to DEFAULT_CONNECTION_TIMEOUT.

Constructor Detail

SailBase

public SailBase()

Method Detail

debugEnabled

protected static boolean debugEnabled()

manageConnection

protected void manageConnection(org.openrdf.sail.SailConnection cnxn)

setDataDir

public void setDataDir(File dataDir)

Specified by:

setDataDir in interface org.openrdf.sail.Sail

getDataDir

public File getDataDir()

Specified by:

getDataDir in interface org.openrdf.sail.Sail

toString

public String toString()

Overrides:

toString in class Object

isInitialized

protected boolean isInitialized()

Checks whether the Sail has been initialized. Sails are initialized from initialization until shutdown.

Returns:

true if the Sail has been initialized, false otherwise.

initialize

public void initialize()
                throws org.openrdf.sail.SailException

Specified by:

initialize in interface org.openrdf.sail.Sail

Throws:

org.openrdf.sail.SailException

initializeInternal

protected void initializeInternal()
                           throws org.openrdf.sail.SailException

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

Throws:

org.openrdf.sail.SailException

shutDown

public void shutDown()
              throws org.openrdf.sail.SailException

Specified by:

shutDown in interface org.openrdf.sail.Sail

Throws:

org.openrdf.sail.SailException

shutDownInternal

protected abstract void shutDownInternal()
                                  throws org.openrdf.sail.SailException

Do store-specific operations to ensure proper shutdown of the store.

Throws:

org.openrdf.sail.SailException

getConnection

public org.openrdf.sail.SailConnection getConnection()
                                              throws org.openrdf.sail.SailException

Specified by:

getConnection in interface org.openrdf.sail.Sail

Throws:

org.openrdf.sail.SailException

getConnectionInternal

protected abstract org.openrdf.sail.SailConnection getConnectionInternal()
                                                                  throws org.openrdf.sail.SailException

Returns a store-specific SailConnection object.

Returns:

A connection to the store.

Throws:

org.openrdf.sail.SailException

connectionClosed

protected void connectionClosed(org.openrdf.sail.SailConnection connection)

Signals to the store that the supplied connection has been closed; called by SailConnectionBase#close().

Parameters:

connection - The connection that has been closed.