org.jahia.services.content.impl.jackrabbit

Class JahiaDatabaseJournal

java.lang.Object

org.apache.jackrabbit.core.journal.AbstractJournal

org.jahia.services.content.impl.jackrabbit.JahiaAbstractJournal

org.jahia.services.content.impl.jackrabbit.JahiaDatabaseJournal

All Implemented Interfaces:

org.apache.jackrabbit.core.journal.Journal, org.apache.jackrabbit.core.util.db.DatabaseAware

Direct Known Subclasses:

JahiaMSSqlDatabaseJournal, JahiaOracleDatabaseJournal

public class JahiaDatabaseJournal
extends JahiaAbstractJournal
implements org.apache.jackrabbit.core.util.db.DatabaseAware

JahiaDatabaseJournal is a copy of DatabaseJournal, but extends JahiaAbstractJournal to use lockAndSync timeouts

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JahiaDatabaseJournal.DatabaseRevision This class manages the local revision of the cluster node.
class	JahiaDatabaseJournal.RevisionTableJanitor Class for maintaining the revision table.

Field Summary

Fields

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

Fields inherited from class org.jahia.services.content.impl.jackrabbit.JahiaAbstractJournal

DEFAULT_MAX_LOCK_TIME, MAX_LOCK_TIME_INT, MAX_LOCK_TIME_LONG, RETRY_COUNT

Constructor Summary

Constructors

Constructor and Description
JahiaDatabaseJournal() Default constructor

Method Summary

Modifier and Type	Method and Description
protected void	append(org.apache.jackrabbit.core.journal.AppendRecord record, InputStream in, int length) We have already saved away the revision for this record.
protected void	appending(org.apache.jackrabbit.core.journal.AppendRecord record) Save away the locked revision inside the newly appended record.
protected void	buildSQLStatements() Builds the SQL statements.
void	close()
protected org.apache.jackrabbit.core.util.db.CheckSchemaOperation	createCheckSchemaOperation() This method is called from init(String, NamespaceResolver) after the createConnectionHelper(DataSource) method, and returns a default CheckSchemaOperation.
protected org.apache.jackrabbit.core.util.db.ConnectionHelper	createConnectionHelper(DataSource dataSrc) This method is called from the init(String, NamespaceResolver) method of this class and returns a ConnectionHelper instance which is assigned to the conHelper field.
protected void	doLock() This journal is locked by incrementing the current value in the table named GLOBAL_REVISION, which effectively write-locks this table.
protected void	doSync(long startRevision, boolean startup) Synchronize contents from journal.
protected void	doUnlock(boolean successful)
String	getDatabaseType() Get the database type.
String	getDataSourceName()
String	getDriver() Bean getters
org.apache.jackrabbit.core.journal.InstanceRevision	getInstanceRevision()
boolean	getJanitorEnabled()
int	getJanitorFirstRunHourOfDay()
int	getJanitorSleep()
protected long	getLockedRevision()
String	getPassword()
org.apache.jackrabbit.core.journal.RecordIterator	getRecords()
org.apache.jackrabbit.core.journal.RecordIterator	getRecords(long startRevision)
String	getSchema() Deprecated. This method is deprecated; getDatabaseType() should be used instead.
String	getSchemaObjectPrefix()
String	getUrl()
String	getUser()
protected void	init() Completes initialization of this database journal.
void	init(String id, org.apache.jackrabbit.spi.commons.namespace.NamespaceResolver resolver)
protected void	initInstanceRevisionAndJanitor() Initialize the instance revision manager and the janitor thread.
boolean	isSchemaCheckEnabled()
void	setConnectionFactory(org.apache.jackrabbit.core.util.db.ConnectionFactory connnectionFactory)
void	setDatabaseType(String databaseType) Set the database type.
void	setDataSourceName(String dataSourceName)
void	setDriver(String driver) Bean setters
void	setJanitorEnabled(boolean enabled)
void	setJanitorFirstRunHourOfDay(int hourOfDay)
void	setJanitorSleep(int sleep)
void	setPassword(String password)
void	setSchema(String databaseType) Deprecated. This method is deprecated; setDatabaseType(java.lang.String) should be used instead.
void	setSchemaCheckEnabled(boolean enabled)
void	setSchemaObjectPrefix(String schemaObjectPrefix)
void	setUrl(String url)
void	setUser(String user)

Methods inherited from class org.jahia.services.content.impl.jackrabbit.JahiaAbstractJournal

doSync, doSync, getMaxLockedSyncTime, lockAndSync, register, setInternalVersionManager, setMaxLockedSyncTime, sync, unlock, unregister

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

createProducer, getConsumer, getId, getNamePathResolver, getProducer, getRepositoryHome, getResolver, getRevision, setRepositoryHome, setRevision, syncAgainOnNewRecords

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JANITOR_SLEEP

public static final int DEFAULT_JANITOR_SLEEP

See Also:

Constant Field Values

selectRevisionsStmtSQL

protected String selectRevisionsStmtSQL

SQL statement returning all revisions within a range.

updateGlobalStmtSQL

protected String updateGlobalStmtSQL

SQL statement updating the global revision.

selectGlobalStmtSQL

protected String selectGlobalStmtSQL

SQL statement returning the global revision.

insertRevisionStmtSQL

protected String insertRevisionStmtSQL

SQL statement appending a new record.

selectMinLocalRevisionStmtSQL

protected String selectMinLocalRevisionStmtSQL

SQL statement returning the minimum of the local revisions.

cleanRevisionStmtSQL

protected String cleanRevisionStmtSQL

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

getLocalRevisionStmtSQL

protected String getLocalRevisionStmtSQL

SQL statement returning the local revision of this cluster node.

insertLocalRevisionStmtSQL

protected String insertLocalRevisionStmtSQL

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

updateLocalRevisionStmtSQL

protected String updateLocalRevisionStmtSQL

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

schemaObjectPrefix

protected String schemaObjectPrefix

Schema object prefix, bean property.

Constructor Detail

JahiaDatabaseJournal

public JahiaDatabaseJournal()

Default constructor

Method Detail

setConnectionFactory

public void setConnectionFactory(org.apache.jackrabbit.core.util.db.ConnectionFactory connnectionFactory)

Specified by:

setConnectionFactory in interface org.apache.jackrabbit.core.util.db.DatabaseAware

init

public void init(String id,
                 org.apache.jackrabbit.spi.commons.namespace.NamespaceResolver resolver)
          throws org.apache.jackrabbit.core.journal.JournalException

Specified by:

init in interface org.apache.jackrabbit.core.journal.Journal

Overrides:

init in class org.apache.jackrabbit.core.journal.AbstractJournal

Throws:

org.apache.jackrabbit.core.journal.JournalException

createConnectionHelper

protected org.apache.jackrabbit.core.util.db.ConnectionHelper createConnectionHelper(DataSource dataSrc)
                                                                              throws Exception

This method is called from the init(String, NamespaceResolver) method of this class and returns a ConnectionHelper instance which is assigned to the conHelper field. Subclasses may override it to return a specialized connection helper.

Parameters:

dataSrc - the DataSource of this persistence manager

Returns:

a ConnectionHelper

Throws:

Exception - on error

createCheckSchemaOperation

protected org.apache.jackrabbit.core.util.db.CheckSchemaOperation createCheckSchemaOperation()

This method is called from init(String, NamespaceResolver) after the createConnectionHelper(DataSource) method, and returns a default CheckSchemaOperation. Subclasses can overrride this implementation to get a customized implementation.

Returns:

a new CheckSchemaOperation instance

init

protected void init()
             throws org.apache.jackrabbit.core.journal.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 database type. Should be overridden by subclasses that use a different way to create a connection and therefore require other arguments.

Throws:

org.apache.jackrabbit.core.journal.JournalException - if initialization fails

initInstanceRevisionAndJanitor

protected void initInstanceRevisionAndJanitor()
                                       throws org.apache.jackrabbit.core.journal.JournalException

Initialize the instance revision manager and the janitor thread.

Throws:

org.apache.jackrabbit.core.journal.JournalException - on error

getInstanceRevision

public org.apache.jackrabbit.core.journal.InstanceRevision getInstanceRevision()
                                                                        throws org.apache.jackrabbit.core.journal.JournalException

Specified by:

getInstanceRevision in interface org.apache.jackrabbit.core.journal.Journal

Throws:

org.apache.jackrabbit.core.journal.JournalException

getRecords

public org.apache.jackrabbit.core.journal.RecordIterator getRecords(long startRevision)
                                                             throws org.apache.jackrabbit.core.journal.JournalException

Specified by:

getRecords in interface org.apache.jackrabbit.core.journal.Journal

Throws:

org.apache.jackrabbit.core.journal.JournalException

getRecords

public org.apache.jackrabbit.core.journal.RecordIterator getRecords()
                                                             throws org.apache.jackrabbit.core.journal.JournalException

Specified by:

getRecords in interface org.apache.jackrabbit.core.journal.Journal

Throws:

org.apache.jackrabbit.core.journal.JournalException

doSync

protected void doSync(long startRevision,
                      boolean startup)
               throws org.apache.jackrabbit.core.journal.JournalException

Synchronize contents from journal. May be overridden by subclasses. Do the initial sync in batchMode, since some databases (PSQL) when not in transactional mode, load all results in memory which causes out of memory. See JCR-2832

Overrides:

doSync in class org.apache.jackrabbit.core.journal.AbstractJournal

Parameters:

startRevision - start point (exclusive)

startup - indicates if the cluster node is syncing on startup or does a normal sync.

Throws:

org.apache.jackrabbit.core.journal.JournalException - if an error occurs

doLock

protected void doLock()
               throws org.apache.jackrabbit.core.journal.JournalException

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 org.apache.jackrabbit.core.journal.AbstractJournal

Throws:

org.apache.jackrabbit.core.journal.JournalException

doUnlock

protected void doUnlock(boolean successful)

Specified by:

doUnlock in class org.apache.jackrabbit.core.journal.AbstractJournal

appending

protected void appending(org.apache.jackrabbit.core.journal.AppendRecord record)

Save away the locked revision inside the newly appended record.

Overrides:

appending in class org.apache.jackrabbit.core.journal.AbstractJournal

append

protected void append(org.apache.jackrabbit.core.journal.AppendRecord record,
                      InputStream in,
                      int length)
               throws org.apache.jackrabbit.core.journal.JournalException

We have already saved away the revision for this record.

Specified by:

append in class org.apache.jackrabbit.core.journal.AbstractJournal

Throws:

org.apache.jackrabbit.core.journal.JournalException

close

public void close()

Specified by:

close in interface org.apache.jackrabbit.core.journal.Journal

buildSQLStatements

protected void buildSQLStatements()

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

getDriver

public String getDriver()

Bean getters

getUrl

public String getUrl()

getDatabaseType

public String getDatabaseType()

Get the database type.

Returns:

the database type

getSchema

@Deprecated
public String getSchema()

Deprecated. This method is deprecated; getDatabaseType() should be used instead.

Get the database type.

Returns:

the database type

getSchemaObjectPrefix

public String getSchemaObjectPrefix()

getUser

public String getUser()

getPassword

public String getPassword()

getJanitorEnabled

public boolean getJanitorEnabled()

getJanitorSleep

public int getJanitorSleep()

getJanitorFirstRunHourOfDay

public int getJanitorFirstRunHourOfDay()

setDriver

public void setDriver(String driver)

Bean setters

setUrl

public void setUrl(String url)

setDatabaseType

public void setDatabaseType(String databaseType)

Set the database type.

Parameters:

databaseType - the database type

setSchema

@Deprecated
public void setSchema(String databaseType)

Deprecated. This method is deprecated; setDatabaseType(java.lang.String) should be used instead.

Set the database type.

Parameters:

databaseType - the database type

setSchemaObjectPrefix

public void setSchemaObjectPrefix(String schemaObjectPrefix)

setUser

public void setUser(String user)

setPassword

public void setPassword(String password)

setJanitorEnabled

public void setJanitorEnabled(boolean enabled)

setJanitorSleep

public void setJanitorSleep(int sleep)

setJanitorFirstRunHourOfDay

public void setJanitorFirstRunHourOfDay(int hourOfDay)

getDataSourceName

public String getDataSourceName()

setDataSourceName

public void setDataSourceName(String dataSourceName)

isSchemaCheckEnabled

public final boolean isSchemaCheckEnabled()

Returns:

whether the schema check is enabled

setSchemaCheckEnabled

public final void setSchemaCheckEnabled(boolean enabled)

Parameters:

enabled - set whether the schema check is enabled

getLockedRevision

protected long getLockedRevision()

Specified by:

getLockedRevision in class JahiaAbstractJournal