org.apache.jackrabbit.core.journal
Class DatabaseJournal

java.lang.Object
  org.apache.jackrabbit.core.journal.AbstractJournal
      org.apache.jackrabbit.core.journal.DatabaseJournal

All Implemented Interfaces:

Journal

Direct Known Subclasses:

JNDIDatabaseJournal, MSSqlDatabaseJournal, OracleDatabaseJournal

public class DatabaseJournal
extends AbstractJournal

Database-based journal implementation. Stores records inside a database table named JOURNAL, whereas the table GLOBAL_REVISION contains the highest available revision number. These tables are located inside the schema specified in schemaObjectPrefix.

It is configured through the following properties:

• driver: the JDBC driver class name to use; this is a required property with no default value
• url: the JDBC connection url; this is a required property with no default value
• schema: the schema to be used; if not specified, this is the second field inside the JDBC connection url, delimeted by colons
• schemaObjectPrefix: the schema object prefix to be used; defaults to an empty string
• user: username to specify when connecting
• password: password to specify when connecting
• reconnectDelayMs: number of milliseconds to wait before trying to reconnect to the database.
• janitorEnabled: specifies whether the clean-up thread for the journal table is enabled (default = false)
• janitorSleep: specifies the sleep time of the clean-up thread in seconds (only useful when the clean-up thread is enabled, default = 24 * 60 * 60, which equals 24 hours)
• janitorFirstRunHourOfDay: specifies the hour at which the clean-up thread initiates its first run (default = 3 which means 3:00 at night)

JNDI can be used to get the connection. In this case, use the javax.naming.InitialContext as the driver, and the JNDI name as the URL. If the user and password are configured in the JNDI resource, they should not be configured here. Example JNDI settings:

 <param name="driver" value="javax.naming.InitialContext" />
 <param name="url" value="java:comp/env/jdbc/Test" />
 

*

Nested Class Summary

class	DatabaseJournal.DatabaseRevision This class manages the local revision of the cluster node.
class	DatabaseJournal.RevisionTableJanitor Class for maintaining the revision table.

Field Summary

protected java.lang.String	cleanRevisionStmtSQL SQL statement removing a set of revisions with from the journal table.
protected java.lang.String	getLocalRevisionStmtSQL SQL statement returning the local revision of this cluster node.
protected java.lang.String	insertLocalRevisionStmtSQL SQL statement for inserting the local revision of this cluster node.
protected java.lang.String	insertRevisionStmtSQL SQL statement appending a new record.
protected java.lang.String	schemaObjectPrefix Schema object prefix, bean property.
protected java.lang.String	selectGlobalStmtSQL SQL statement returning the global revision.
protected java.lang.String	selectMinLocalRevisionStmtSQL SQL statement returning the minimum of the local revisions.
protected java.lang.String	selectRevisionsStmtSQL SQL statement returning all revisions within a range.
protected java.lang.String	updateGlobalStmtSQL SQL statement updating the global revision.
protected java.lang.String	updateLocalRevisionStmtSQL SQL statement for updating the local revision of this cluster node.

Constructor Summary

DatabaseJournal()

Method Summary

protected void	append(AppendRecord record, java.io.InputStream in, int length) Append a record backed by a file.
protected void	appending(AppendRecord record) Notification method called by an appended record at creation time.
protected void	buildSQLStatements() Builds the SQL statements.
void	close() Close this journal.
protected java.lang.String	createSchemaSQL(java.lang.String sql) Creates an SQL statement for schema creation by variable substitution.
protected void	doLock() Lock the journal revision.
protected void	doUnlock(boolean successful) Unlock the journal revision.
protected java.sql.Connection	getConnection() Creates a new database connection.
java.lang.String	getDriver() Bean getters
InstanceRevision	getInstanceRevision() Gets the instance that manages the cluster node's local revision.
boolean	getJanitorEnabled()
int	getJanitorFirstRunHourOfDay()
int	getJanitorSleep()
java.lang.String	getPassword()
long	getReconnectDelayMs()
protected RecordIterator	getRecords(long startRevision) Return an iterator over all records after the specified revision.
java.lang.String	getSchema()
java.lang.String	getSchemaObjectPrefix()
java.lang.String	getUrl()
java.lang.String	getUser()
protected void	init() Completes initialization of this database journal.
void	init(java.lang.String id, NamespaceResolver resolver) Initialize journal.
protected void	initInstanceRevisionAndJanitor() Initialize the instance revision manager and the janitor thread.
void	setDriver(java.lang.String driver) Bean setters
void	setJanitorEnabled(boolean enabled)
void	setJanitorFirstRunHourOfDay(int hourOfDay)
void	setJanitorSleep(int sleep)
void	setPassword(java.lang.String password)
void	setReconnectDelayMs(long reconnectDelayMs)
void	setSchema(java.lang.String schema)
void	setSchemaObjectPrefix(java.lang.String schemaObjectPrefix)
void	setUrl(java.lang.String url)
void	setUser(java.lang.String user)
protected boolean	tableExists(java.sql.DatabaseMetaData metaData, java.lang.String tableName) Checks whether the required table(s) exist in the schema.

Methods inherited from class org.apache.jackrabbit.core.journal.AbstractJournal

createProducer, doSync, getConsumer, getId, getNamePathResolver, getProducer, getRepositoryHome, getResolver, getRevision, lockAndSync, register, setRepositoryHome, setRevision, sync, unlock, unregister

Methods inherited from class java.lang.Object

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

Field Detail

selectRevisionsStmtSQL

protected java.lang.String selectRevisionsStmtSQL

SQL statement returning all revisions within a range.

updateGlobalStmtSQL

protected java.lang.String updateGlobalStmtSQL

SQL statement updating the global revision.

selectGlobalStmtSQL

protected java.lang.String selectGlobalStmtSQL

SQL statement returning the global revision.

insertRevisionStmtSQL

protected java.lang.String insertRevisionStmtSQL

SQL statement appending a new record.

selectMinLocalRevisionStmtSQL

protected java.lang.String selectMinLocalRevisionStmtSQL

SQL statement returning the minimum of the local revisions.

cleanRevisionStmtSQL

protected java.lang.String cleanRevisionStmtSQL

SQL statement removing a set of revisions with from the journal table.

getLocalRevisionStmtSQL

protected java.lang.String getLocalRevisionStmtSQL

SQL statement returning the local revision of this cluster node.

insertLocalRevisionStmtSQL

protected java.lang.String insertLocalRevisionStmtSQL

SQL statement for inserting the local revision of this cluster node.

updateLocalRevisionStmtSQL

protected java.lang.String updateLocalRevisionStmtSQL

SQL statement for updating the local revision of this cluster node.

schemaObjectPrefix

protected java.lang.String schemaObjectPrefix

Schema object prefix, bean property.

Constructor Detail

DatabaseJournal

public DatabaseJournal()

Method Detail

init

public void init(java.lang.String id,
                 NamespaceResolver resolver)
          throws JournalException

Initialize journal.

Specified by:

init in interface Journal

Overrides:

init in class AbstractJournal

Parameters:

id - id this journal should use to write its own records

resolver - resolver used when reading/writing records

Throws:

JournalException - if an error occurs

init

protected void init()
             throws JournalException

Completes initialization of this database journal. Base implementation checks whether the required bean properties driver and url have been specified and optionally deduces a valid schema. Should be overridden by subclasses that use a different way to create a connection and therefore require other arguments.

Throws:

JournalException - if initialization fails

See Also:

getConnection()

initInstanceRevisionAndJanitor

protected void initInstanceRevisionAndJanitor()
                                       throws java.lang.Exception

Initialize the instance revision manager and the janitor thread.

Throws:

JournalException - on error

java.lang.Exception

getInstanceRevision

public InstanceRevision getInstanceRevision()
                                     throws JournalException

Description copied from interface: Journal

Gets the instance that manages the cluster node's local revision.

Returns:

the InstanceRevision manager

Throws:

JournalException - on error

getConnection

protected java.sql.Connection getConnection()
                                     throws java.sql.SQLException,
                                            JournalException

Creates a new database connection. This method is called inside #init(String, org.apache.jackrabbit.name.NamespaceResolver) or when a connection has been dropped and must be reacquired. Base implementation uses java.sql.DriverManager to get the connection. May be overridden by subclasses.

Returns:

new connection

Throws:

JournalException - if the driver could not be loaded

java.sql.SQLException - if the connection could not be established

See Also:

init()

getRecords

protected RecordIterator getRecords(long startRevision)
                             throws JournalException

Return an iterator over all records after the specified revision. Subclass responsibility.

Specified by:

getRecords in class AbstractJournal

Parameters:

startRevision - start point (exlusive)

Throws:

JournalException - if an error occurs

doLock

protected void doLock()
               throws JournalException

Lock the journal revision. Subclass responsibility.

This journal is locked by incrementing the current value in the table named GLOBAL_REVISION, which effectively write-locks this table. The updated value is then saved away and remembered in the appended record, because a save may entail multiple appends (JCR-884).

Specified by:

doLock in class AbstractJournal

Throws:

JournalException - if an error occurs

doUnlock

protected void doUnlock(boolean successful)

Unlock the journal revision. Subclass responsibility.

Specified by:

doUnlock in class AbstractJournal

Parameters:

successful - flag indicating whether the update process was successful

appending

protected void appending(AppendRecord record)

Notification method called by an appended record at creation time. May be overridden by subclasses to save some context information inside the appended record.

Save away the locked revision inside the newly appended record.

Overrides:

appending in class AbstractJournal

Parameters:

record - record that was appended

append

protected void append(AppendRecord record,
                      java.io.InputStream in,
                      int length)
               throws JournalException

Append a record backed by a file. On exit, the new revision must have been set inside the appended record. Subclass responsibility.

We have already saved away the revision for this record.

Specified by:

append in class AbstractJournal

Parameters:

record - record to append

in - input stream

length - number of bytes in input stream

Throws:

JournalException - if an error occurs

close

public void close()

Close this journal. This should release any resources still held by this journal.

tableExists

protected boolean tableExists(java.sql.DatabaseMetaData metaData,
                              java.lang.String tableName)
                       throws java.sql.SQLException

Checks whether the required table(s) exist in the schema. May be overridden by subclasses to allow different table names.

Parameters:

metaData - database meta data

Returns:

true if the schema exists

Throws:

java.sql.SQLException - if an SQL error occurs

createSchemaSQL

protected java.lang.String createSchemaSQL(java.lang.String sql)

Creates an SQL statement for schema creation by variable substitution.

Parameters:

sql - a SQL string which may contain variables to substitute

Returns:

a valid SQL string

buildSQLStatements

protected void buildSQLStatements()

Builds the SQL statements. May be overridden by subclasses to allow different table and/or column names.

getDriver

public java.lang.String getDriver()

Bean getters

getUrl

public java.lang.String getUrl()

getSchema

public java.lang.String getSchema()

getSchemaObjectPrefix

public java.lang.String getSchemaObjectPrefix()

getUser

public java.lang.String getUser()

getPassword

public java.lang.String getPassword()

getReconnectDelayMs

public long getReconnectDelayMs()

getJanitorEnabled

public boolean getJanitorEnabled()

getJanitorSleep

public int getJanitorSleep()

getJanitorFirstRunHourOfDay

public int getJanitorFirstRunHourOfDay()

setDriver

public void setDriver(java.lang.String driver)

Bean setters

setUrl

public void setUrl(java.lang.String url)

setSchema

public void setSchema(java.lang.String schema)

setSchemaObjectPrefix

public void setSchemaObjectPrefix(java.lang.String schemaObjectPrefix)

setUser

public void setUser(java.lang.String user)

setPassword

public void setPassword(java.lang.String password)

setReconnectDelayMs

public void setReconnectDelayMs(long reconnectDelayMs)

setJanitorEnabled

public void setJanitorEnabled(boolean enabled)

setJanitorSleep

public void setJanitorSleep(int sleep)

setJanitorFirstRunHourOfDay

public void setJanitorFirstRunHourOfDay(int hourOfDay)