org.apache.jackrabbit.core.persistence.bundle
Class BundleDbPersistenceManager

java.lang.Object
  org.apache.jackrabbit.core.persistence.bundle.AbstractBundlePersistenceManager
      org.apache.jackrabbit.core.persistence.bundle.BundleDbPersistenceManager

All Implemented Interfaces:

CachingPersistenceManager, IterablePersistenceManager, PersistenceManager

Direct Known Subclasses:

DerbyPersistenceManager, H2PersistenceManager, MSSqlPersistenceManager, MySqlPersistenceManager, OraclePersistenceManager, PostgreSQLPersistenceManager

public class BundleDbPersistenceManager
extends AbstractBundlePersistenceManager

This is a generic persistence manager that stores the NodePropBundles in a database.

Configuration:

• <param name="bundleCacheSize" value="8"/>
• <param name="consistencyCheck" value="false"/>
• <param name="consistencyFix" value="false"/>
• <param name="minBlobSize" value="4096"/>
• <param name="driver" value=""/>
• <param name="url" value=""/>
• <param name="user" value=""/>
• <param name="password" value=""/>
• <param name="schema" value=""/>
• <param name="schemaObjectPrefix" value=""/>
• <param name="errorHandling" value=""/>
• <param name="blockOnConnectionLoss" value="false"/>

Nested Class Summary

protected static interface	BundleDbPersistenceManager.CloseableBLOBStore Helper interface for closeable stores
protected class	BundleDbPersistenceManager.DbBlobStore Implementation of a blob store that stores the data inside the database
protected class	BundleDbPersistenceManager.FSBlobStore own implementation of the filesystem blob store that uses a different blob-id scheme.

Field Summary

protected BundleBinding	binding the bundle binding
protected BundleDbPersistenceManager.CloseableBLOBStore	blobStore file system where BLOB data is stored
protected boolean	blockOnConnectionLoss indicates whether to block if the database connection is lost
protected java.lang.String	bundleDeleteSQL
protected java.lang.String	bundleInsertSQL
protected java.lang.String	bundleSelectAllIdsFromSQL
protected java.lang.String	bundleSelectAllIdsSQL
protected java.lang.String	bundleSelectSQL
protected java.lang.String	bundleUpdateSQL
protected ConnectionRecoveryManager	connectionManager The class that manages statement execution and recovery from connection loss.
protected boolean	consistencyCheck flag indicating if a consistency check should be issued during startup
protected boolean	consistencyFix flag indicating if the consistency check should attempt to fix issues
protected java.lang.String	driver the jdbc driver name
protected ErrorHandling	errorHandling flag for error handling
protected boolean	externalBLOBs indicates if uses (filesystem) blob store
protected static int	INITIAL_BUFFER_SIZE initial size of buffer used to serialize objects
protected boolean	initialized flag indicating if this manager was initialized
protected java.lang.String	nodeReferenceDeleteSQL
protected java.lang.String	nodeReferenceInsertSQL
protected java.lang.String	nodeReferenceSelectSQL
protected java.lang.String	nodeReferenceUpdateSQL
protected java.lang.String	password the jdbc password
protected java.lang.String	schema the schema identifier
static java.lang.String	SCHEMA_OBJECT_PREFIX_VARIABLE the variable for the schema prefix
protected java.lang.String	schemaObjectPrefix the prefix for the database objects
static int	SM_BINARY_KEYS storage model modifier: binary keys
static int	SM_LONGLONG_KEYS storage model modifier: longlong keys
protected java.lang.String	url the jdbc url string
protected java.lang.String	user the jdbc user

Fields inherited from class org.apache.jackrabbit.core.persistence.bundle.AbstractBundlePersistenceManager

context, NODEFILENAME, NODEREFSFILENAME, RES_NAME_INDEX, RES_NS_INDEX

Constructor Summary

BundleDbPersistenceManager()

Method Summary

protected void	buildSQLStatements() Initializes the SQL strings.
protected void	checkBundleConsistency(NodeId id, NodePropBundle bundle, boolean fix, java.util.Collection modifications) Checks a single bundle for inconsistencies, ie.
void	checkConsistency(java.lang.String[] uuids, boolean recursive, boolean fix) This implementation does nothing.
protected void	checkSchema() Checks if the required schema objects exist and creates them if they don't exist yet.
protected boolean	checkTablesExist() Checks if the database table exist.
protected boolean	checkTablesWithUser() Indicates if the user name should be included when retrieving the tables during checkTablesExist().
void	close() Closes the persistence manager.
protected void	closeResultSet(java.sql.ResultSet rs) Closes the result set
protected void	closeStatement(java.sql.PreparedStatement stmt) closes the statement
protected BundleDbPersistenceManager.CloseableBLOBStore	createBlobStore() Creates a suitable blobstore
protected BundleDbPersistenceManager.CloseableBLOBStore	createDBBlobStore(PMContext context) Creates a blob store that uses the database.
protected DbNameIndex	createDbNameIndex() Returns a new instance of a DbNameIndex.
protected BundleDbPersistenceManager.CloseableBLOBStore	createLocalFSBlobStore(PMContext context) Creates a blob store that is based on a local fs.
protected java.lang.Object[]	createParams(UUID uuid, java.lang.Object p, boolean before) Creates a parameter array for an SQL statement that needs (i) a UUID, and (2) another parameter.
protected java.lang.String	createSchemaSQL(java.lang.String sql) Creates an SQL statement for schema creation by variable substitution.
void	destroy(NodeReferences refs) Deletes the node references from the underlying system.
protected void	destroyBundle(NodePropBundle bundle) Deletes the bundle from the underlying system.
boolean	exists(NodeReferencesId targetId) Checks whether references of the identified target node exist.
protected boolean	existsBundle(NodeId id) Checks if a bundle exists in the underlying system.
NodeIdIterator	getAllNodeIds(NodeId bigger, int maxCount) Get all node ids.
protected BundleBinding	getBinding() Returns the bundle binding that is used for serializing the bundles.
java.lang.String	getBlockOnConnectionLoss()
java.lang.String	getConsistencyCheck() Checks if consistency check is enabled.
java.lang.String	getConsistencyFix() Checks if consistency fix is enabled.
java.lang.String	getDriver() Returns the class name of the JDBC driver.
java.lang.String	getErrorHandling() Returns the error handling configuration of this manager
protected java.lang.Object[]	getKey(UUID uuid) Constructs a parameter list for a PreparedStatement for the given UUID.
java.lang.String	getMinBlobSize() Returns the minimum blob size in bytes.
StringIndex	getNameIndex() Returns the local name index
java.lang.String	getPassword() Returns the configured password that is used to establish JDBC connections.
java.lang.String	getSchema() Returns the configured schema identifier.
java.lang.String	getSchemaObjectPrefix() Returns the configured schema object prefix.
int	getStorageModel() returns the storage model
java.lang.String	getUrl() Returns the configured JDBC connection url.
java.lang.String	getUser() Returns the configured user that is used to establish JDBC connections.
void	init(PMContext context) Initializes the persistence manager.
boolean	isExternalBLOBs() Returns if uses external (filesystem) blob store.
NodeReferences	load(NodeReferencesId targetId) Load the persistent members of a node references object.
protected NodePropBundle	loadBundle(NodeId id) Loads a bundle from the underlying system.
protected NodePropBundle	loadBundle(NodeId id, boolean checkBeforeLoading) Loads a bundle from the underlying system and optionally performs a check on the bundle first.
protected void	logException(java.lang.String message, java.sql.SQLException e) logs an sql exception
protected void	prepareSchemaObjectPrefix() Makes sure that schemaObjectPrefix does only consist of characters that are allowed in names on the target database.
protected void	resetStatement(java.sql.PreparedStatement stmt) Resets the given PreparedStatement by clearing the parameters and warnings contained.
void	setBlockOnConnectionLoss(java.lang.String block)
void	setConsistencyCheck(java.lang.String consistencyCheck) Defines if a consistency check is to be performed on initialization.
void	setConsistencyFix(java.lang.String consistencyFix) Defines if the consistency check should attempt to fix issues that it finds.
void	setDriver(java.lang.String driver) Sets the class name of the JDBC driver.
void	setErrorHandling(java.lang.String errorHandling) Sets the error handling behaviour of this manager.
void	setExternalBLOBs(boolean externalBLOBs) Sets the flag for external (filesystem) blob store usage.
protected int	setKey(java.sql.PreparedStatement stmt, UUID uuid, int pos) Sets the key parameters to the prepared statement, starting at pos and returns the number of key parameters + pos.
void	setMinBlobSize(java.lang.String minBlobSize) Sets the minimum blob size.
void	setPassword(java.lang.String password) Sets the password that will be used to establish JDBC connections.
void	setSchema(java.lang.String schema) Sets the schema identifier.
void	setSchemaObjectPrefix(java.lang.String schemaObjectPrefix) Sets the schema object prefix.
void	setUrl(java.lang.String url) Sets the JDBC connection URL.
void	setUser(java.lang.String user) Sets the user name that will be used to establish JDBC connections.
void	store(ChangeLog changeLog) Right now, this iterates over all items in the changelog and calls the individual methods that handle single item states or node references objects.
void	store(NodeReferences refs) Stores a node references to the underlying system.
protected void	storeBundle(NodePropBundle bundle) Stores a bundle to the underlying system.
java.lang.String	toString()
boolean	useDbBlobStore() Returns true if the blobs are stored in the DB.
boolean	useLocalFsBlobStore() Returns true if the blobs are stored in the local fs.

Methods inherited from class org.apache.jackrabbit.core.persistence.bundle.AbstractBundlePersistenceManager

buildBlobFilePath, buildNodeFilePath, buildNodeFolderPath, buildNodeReferencesFilePath, buildPropFilePath, createNew, createNew, evictBundle, exists, exists, getBundleCacheSize, getNsIndex, load, load, onExternalUpdate, setBundleCacheSize

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_OBJECT_PREFIX_VARIABLE

public static final java.lang.String SCHEMA_OBJECT_PREFIX_VARIABLE

the variable for the schema prefix

See Also:

Constant Field Values

SM_BINARY_KEYS

public static final int SM_BINARY_KEYS

storage model modifier: binary keys

See Also:

Constant Field Values

SM_LONGLONG_KEYS

public static final int SM_LONGLONG_KEYS

storage model modifier: longlong keys

See Also:

Constant Field Values

initialized

protected boolean initialized

flag indicating if this manager was initialized

driver

protected java.lang.String driver

the jdbc driver name

url

protected java.lang.String url

the jdbc url string

user

protected java.lang.String user

the jdbc user

password

protected java.lang.String password

the jdbc password

schema

protected java.lang.String schema

the schema identifier

schemaObjectPrefix

protected java.lang.String schemaObjectPrefix

the prefix for the database objects

consistencyCheck

protected boolean consistencyCheck

flag indicating if a consistency check should be issued during startup

consistencyFix

protected boolean consistencyFix

flag indicating if the consistency check should attempt to fix issues

INITIAL_BUFFER_SIZE

protected static final int INITIAL_BUFFER_SIZE

initial size of buffer used to serialize objects

See Also:

Constant Field Values

externalBLOBs

protected boolean externalBLOBs

indicates if uses (filesystem) blob store

blockOnConnectionLoss

protected boolean blockOnConnectionLoss

indicates whether to block if the database connection is lost

connectionManager

protected ConnectionRecoveryManager connectionManager

The class that manages statement execution and recovery from connection loss.

bundleInsertSQL

protected java.lang.String bundleInsertSQL

bundleUpdateSQL

protected java.lang.String bundleUpdateSQL

bundleSelectSQL

protected java.lang.String bundleSelectSQL

bundleDeleteSQL

protected java.lang.String bundleDeleteSQL

bundleSelectAllIdsFromSQL

protected java.lang.String bundleSelectAllIdsFromSQL

bundleSelectAllIdsSQL

protected java.lang.String bundleSelectAllIdsSQL

nodeReferenceInsertSQL

protected java.lang.String nodeReferenceInsertSQL

nodeReferenceUpdateSQL

protected java.lang.String nodeReferenceUpdateSQL

nodeReferenceSelectSQL

protected java.lang.String nodeReferenceSelectSQL

nodeReferenceDeleteSQL

protected java.lang.String nodeReferenceDeleteSQL

blobStore

protected BundleDbPersistenceManager.CloseableBLOBStore blobStore

file system where BLOB data is stored

errorHandling

protected ErrorHandling errorHandling

flag for error handling

binding

protected BundleBinding binding

the bundle binding

Constructor Detail

BundleDbPersistenceManager

public BundleDbPersistenceManager()

Method Detail

getUrl

public java.lang.String getUrl()

Returns the configured JDBC connection url.

Returns:

the configured JDBC connection url.

setUrl

public void setUrl(java.lang.String url)

Sets the JDBC connection URL. The connection can be created using a JNDI Data Source as well. To do that, the driver class name must reference a javax.naming.Context class (for example javax.naming.InitialContext), and the URL must be the JNDI URL (for example java:comp/env/jdbc/Test).

Parameters:

url - the url to set.

getUser

public java.lang.String getUser()

Returns the configured user that is used to establish JDBC connections.

Returns:

the JDBC user.

setUser

public void setUser(java.lang.String user)

Sets the user name that will be used to establish JDBC connections.

Parameters:

user - the user name.

getPassword

public java.lang.String getPassword()

Returns the configured password that is used to establish JDBC connections.

Returns:

the password.

setPassword

public void setPassword(java.lang.String password)

Sets the password that will be used to establish JDBC connections.

Parameters:

password - the password for the connection

getDriver

public java.lang.String getDriver()

Returns the class name of the JDBC driver.

Returns:

the class name of the JDBC driver.

setDriver

public void setDriver(java.lang.String driver)

Sets the class name of the JDBC driver. The driver class will be loaded during init in order to assure the existence. If no driver is specified, the default driver for the database is used.

Parameters:

driver - the class name of the driver

getSchemaObjectPrefix

public java.lang.String getSchemaObjectPrefix()

Returns the configured schema object prefix.

Returns:

the configured schema object prefix.

setSchemaObjectPrefix

public void setSchemaObjectPrefix(java.lang.String schemaObjectPrefix)

Sets the schema object prefix. This string is used to prefix all schema objects, like tables and indexes. this is useful, if several persistence managers use the same database.

Parameters:

schemaObjectPrefix - the prefix for schema objects.

getSchema

public java.lang.String getSchema()

Returns the configured schema identifier.

Returns:

the schema identifier.

setSchema

public void setSchema(java.lang.String schema)

Sets the schema identifier. This identifier is used to load and execute the respective .ddl resource in order to create the required schema objects.

Parameters:

schema - the schema identifier.

isExternalBLOBs

public boolean isExternalBLOBs()

Returns if uses external (filesystem) blob store.

Returns:

if uses external (filesystem) blob store.

setExternalBLOBs

public void setExternalBLOBs(boolean externalBLOBs)

Sets the flag for external (filesystem) blob store usage.

Parameters:

externalBLOBs - a value of "true" indicates that an external blob store is to be used.

getConsistencyCheck

public java.lang.String getConsistencyCheck()

Checks if consistency check is enabled.

Returns:

true if consistency check is enabled.

setConsistencyCheck

public void setConsistencyCheck(java.lang.String consistencyCheck)

Defines if a consistency check is to be performed on initialization.

Parameters:

consistencyCheck - the consistency check flag.

getConsistencyFix

public java.lang.String getConsistencyFix()

Checks if consistency fix is enabled.

Returns:

true if consistency fix is enabled.

setConsistencyFix

public void setConsistencyFix(java.lang.String consistencyFix)

Defines if the consistency check should attempt to fix issues that it finds.

Parameters:

consistencyFix - the consistency fix flag.

getMinBlobSize

public java.lang.String getMinBlobSize()

Returns the minimum blob size in bytes.

Returns:

the minimum blob size in bytes.

setMinBlobSize

public void setMinBlobSize(java.lang.String minBlobSize)

Sets the minimum blob size. This size defines the threshold of which size a property is included in the bundle or is stored in the blob store.

Parameters:

minBlobSize - the minimum blob size in bytes.

setErrorHandling

public void setErrorHandling(java.lang.String errorHandling)

Sets the error handling behaviour of this manager. See ErrorHandling for details about the flags.

Parameters:

errorHandling - the error handling flags

getErrorHandling

public java.lang.String getErrorHandling()

Returns the error handling configuration of this manager

Returns:

the error handling configuration of this manager

setBlockOnConnectionLoss

public void setBlockOnConnectionLoss(java.lang.String block)

getBlockOnConnectionLoss

public java.lang.String getBlockOnConnectionLoss()

useDbBlobStore

public boolean useDbBlobStore()

Returns true if the blobs are stored in the DB.

Returns:

true if the blobs are stored in the DB.

useLocalFsBlobStore

public boolean useLocalFsBlobStore()

Returns true if the blobs are stored in the local fs.

Returns:

true if the blobs are stored in the local fs.

checkSchema

protected void checkSchema()
                    throws java.sql.SQLException,
                           javax.jcr.RepositoryException

Checks if the required schema objects exist and creates them if they don't exist yet.

Throws:

java.sql.SQLException - if an SQL error occurs.

javax.jcr.RepositoryException - if an 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

checkTablesExist

protected boolean checkTablesExist()
                            throws java.sql.SQLException,
                                   javax.jcr.RepositoryException

Checks if the database table exist.

Returns:

true if the tables exist; false otherwise.

Throws:

java.sql.SQLException - if a database error occurs.

javax.jcr.RepositoryException - if a repository exception occurs.

checkTablesWithUser

protected boolean checkTablesWithUser()

Indicates if the user name should be included when retrieving the tables during checkTablesExist().

Please note that this currently only needs to be changed for oracle based persistence managers.

Returns:

false

store

public void store(ChangeLog changeLog)
           throws ItemStateException

Right now, this iterates over all items in the changelog and calls the individual methods that handle single item states or node references objects. Properly implemented, this method should ensure that changes are either written completely to the underlying persistence layer, or not at all. Atomically saves the given set of changes. Basically wraps a JDBC transaction around super.store().

Specified by:

store in interface PersistenceManager

Overrides:

store in class AbstractBundlePersistenceManager

Parameters:

changeLog - change log containing states that were changed

Throws:

ItemStateException - if the changes could not be saved

init

public void init(PMContext context)
          throws java.lang.Exception

Initializes the persistence manager. The persistence manager is permanently bound to the given context, and any required external resources are acquired.

An appropriate exception is thrown if the persistence manager initialization fails for whatever reason. In this case the state of the persistence manager is undefined and the instance should be discarded. Initializes the internal structures of this abstract persistence manager.

Specified by:

init in interface PersistenceManager

Overrides:

init in class AbstractBundlePersistenceManager

Parameters:

context - persistence manager context

Throws:

java.lang.Exception - if the persistence manager initialization failed

getBinding

protected BundleBinding getBinding()

Returns the bundle binding that is used for serializing the bundles.

Specified by:

getBinding in class AbstractBundlePersistenceManager

Returns:

the bundle binding

createBlobStore

protected BundleDbPersistenceManager.CloseableBLOBStore createBlobStore()
                                                                 throws java.lang.Exception

Creates a suitable blobstore

Returns:

a blobstore

Throws:

java.lang.Exception - if an unspecified error occurs

getNameIndex

public StringIndex getNameIndex()

Returns the local name index

Overrides:

getNameIndex in class AbstractBundlePersistenceManager

Returns:

the local name index

Throws:

java.lang.IllegalStateException - if an error occurs.

createDbNameIndex

protected DbNameIndex createDbNameIndex()
                                 throws java.sql.SQLException

Returns a new instance of a DbNameIndex.

Returns:

a new instance of a DbNameIndex.

Throws:

java.sql.SQLException - if an SQL error occurs.

getStorageModel

public int getStorageModel()

returns the storage model

Returns:

the storage model

createLocalFSBlobStore

protected BundleDbPersistenceManager.CloseableBLOBStore createLocalFSBlobStore(PMContext context)
                                                                        throws java.lang.Exception

Creates a blob store that is based on a local fs. This is called by init if useLocalFsBlobStore() returns true.

Parameters:

context - the persistence manager context

Returns:

a blob store

Throws:

java.lang.Exception - if an error occurs.

createDBBlobStore

protected BundleDbPersistenceManager.CloseableBLOBStore createDBBlobStore(PMContext context)
                                                                   throws java.lang.Exception

Creates a blob store that uses the database. This is called by init if useDbBlobStore() returns true.

Parameters:

context - the persistence manager context

Returns:

a blob store

Throws:

java.lang.Exception - if an error occurs.

checkBundleConsistency

protected void checkBundleConsistency(NodeId id,
                                      NodePropBundle bundle,
                                      boolean fix,
                                      java.util.Collection modifications)

Checks a single bundle for inconsistencies, ie. inexistent child nodes and inexistent parents.

Parameters:

id - node id for the bundle to check

bundle - the bundle to check

fix - if true, repair things that can be repaired

modifications - if fix == true, collect the repaired bundles here

checkConsistency

public void checkConsistency(java.lang.String[] uuids,
                             boolean recursive,
                             boolean fix)

This implementation does nothing. Perform a consistency check of the data. An example are non-existent nodes referenced in a child node entry. The existence of this feature and the scope of the implementation can vary in different PersistenceManager implementations.

Specified by:

checkConsistency in interface PersistenceManager

Overrides:

checkConsistency in class AbstractBundlePersistenceManager

Parameters:

uuids - list of UUIDs of nodes to be checked. if null, all nodes will be checked

recursive - if true, the tree(s) below the given node(s) will be traversed and checked as well

fix - if true, any problems found that can be repaired will be repaired. if false, no data will be modified, instead all inconsistencies will only get logged

prepareSchemaObjectPrefix

protected void prepareSchemaObjectPrefix()
                                  throws java.lang.Exception

Makes sure that schemaObjectPrefix does only consist of characters that are allowed in names on the target database. Illegal characters will be escaped as necessary.

Throws:

java.lang.Exception - if an error occurs

close

public void close()
           throws java.lang.Exception

Closes the persistence manager. The consistency of the persistent storage is guaranteed and all acquired resources are released. It is an error to invoke any methods on a closed persistence manager, and implementations are free to enforce this constraint by throwing IllegalStateExceptions in such cases.

An appropriate exception is thrown if the persistence manager could not be closed properly. In this case the state of the persistence manager is undefined and the instance should be discarded. Closes the persistence manager, release acquired resourecs.

Specified by:

close in interface PersistenceManager

Overrides:

close in class AbstractBundlePersistenceManager

Throws:

java.lang.Exception - if the persistence manager failed to close properly

setKey

protected int setKey(java.sql.PreparedStatement stmt,
                     UUID uuid,
                     int pos)
              throws java.sql.SQLException

Sets the key parameters to the prepared statement, starting at pos and returns the number of key parameters + pos.

Parameters:

stmt - the statement

uuid - the uuid of the key

pos - the position of the key parameter

Returns:

the number of key parameters + pos

Throws:

java.sql.SQLException - if an SQL error occurs.

getKey

protected java.lang.Object[] getKey(UUID uuid)

Constructs a parameter list for a PreparedStatement for the given UUID.

Parameters:

uuid - the uuid

Returns:

a list of Objects

createParams

protected java.lang.Object[] createParams(UUID uuid,
                                          java.lang.Object p,
                                          boolean before)

Creates a parameter array for an SQL statement that needs (i) a UUID, and (2) another parameter.

Parameters:

uuid - the UUID

p - the other parameter

before - whether the other parameter should be before the uuid parameter

Returns:

an Object array that represents the parameters

getAllNodeIds

public NodeIdIterator getAllNodeIds(NodeId bigger,
                                    int maxCount)
                             throws ItemStateException,
                                    javax.jcr.RepositoryException

Get all node ids. A typical application will call this method multiple times, where 'after' is the last row read. The maxCount parameter defines the maximum number of node ids returned, 0 meaning no limit. The order of the node ids is specific for the given persistent manager. Items that are added concurrently may not be included.

Parameters:

bigger - the lower limit, or null for no limit.

maxCount - the maximum number of node ids to return, or 0 for no limit.

Returns:

an iterator of all bundles.

Throws:

ItemStateException - if an error while loading occurs.

javax.jcr.RepositoryException - if a repository exception occurs

loadBundle

protected NodePropBundle loadBundle(NodeId id)
                             throws ItemStateException

Loads a bundle from the underlying system.

Specified by:

loadBundle in class AbstractBundlePersistenceManager

Parameters:

id - the node id of the bundle

Returns:

the loaded bundle or null if the bundle does not exist.

Throws:

ItemStateException - if an error while loading occurs.

loadBundle

protected NodePropBundle loadBundle(NodeId id,
                                    boolean checkBeforeLoading)
                             throws ItemStateException

Loads a bundle from the underlying system and optionally performs a check on the bundle first.

Parameters:

id - the node id of the bundle

checkBeforeLoading - check the bundle before loading it and log detailed information about it (slower)

Returns:

the loaded bundle or null if the bundle does not exist.

Throws:

ItemStateException - if an error while loading occurs.

existsBundle

protected boolean existsBundle(NodeId id)
                        throws ItemStateException

Checks if a bundle exists in the underlying system.

Specified by:

existsBundle in class AbstractBundlePersistenceManager

Parameters:

id - the node id of the bundle

Returns:

true if the bundle exists; false otherwise.

Throws:

ItemStateException - if an error while checking occurs.

storeBundle

protected void storeBundle(NodePropBundle bundle)
                    throws ItemStateException

Stores a bundle to the underlying system.

Specified by:

storeBundle in class AbstractBundlePersistenceManager

Parameters:

bundle - the bundle to store

Throws:

ItemStateException - if an error while storing occurs.

destroyBundle

protected void destroyBundle(NodePropBundle bundle)
                      throws ItemStateException

Deletes the bundle from the underlying system.

Specified by:

destroyBundle in class AbstractBundlePersistenceManager

Parameters:

bundle - the bundle to destroy

Throws:

ItemStateException - if an error while destroying occurs.

load

public NodeReferences load(NodeReferencesId targetId)
                    throws NoSuchItemStateException,
                           ItemStateException

Load the persistent members of a node references object.

Specified by:

load in interface PersistenceManager

Specified by:

load in class AbstractBundlePersistenceManager

Parameters:

targetId - reference target node id

Throws:

NoSuchItemStateException - if the target node does not exist

ItemStateException - if another error occurs

store

public void store(NodeReferences refs)
           throws ItemStateException

Stores a node references to the underlying system. This method uses shared PreparedStatements, which must be used strictly sequentially. Because this method synchronizes on the persistence manager instance, there is no need to synchronize on the shared statement. If the method would not be synchronized, the shared statement must be synchronized.

Specified by:

store in class AbstractBundlePersistenceManager

Parameters:

refs - the node references to store.

Throws:

ItemStateException - if an error while storing occurs.

destroy

public void destroy(NodeReferences refs)
             throws ItemStateException

Deletes the node references from the underlying system.

Specified by:

destroy in class AbstractBundlePersistenceManager

Parameters:

refs - the node references to destroy.

Throws:

ItemStateException - if an error while destroying occurs.

exists

public boolean exists(NodeReferencesId targetId)
               throws ItemStateException

Checks whether references of the identified target node exist.

Parameters:

targetId - target node id

Returns:

true if the references exist, false otherwise

Throws:

ItemStateException - on persistence manager errors

resetStatement

protected void resetStatement(java.sql.PreparedStatement stmt)

Resets the given PreparedStatement by clearing the parameters and warnings contained.

Parameters:

stmt - The PreparedStatement to reset. If null this method does nothing.

closeResultSet

protected void closeResultSet(java.sql.ResultSet rs)

Closes the result set

Parameters:

rs - the result set

closeStatement

protected void closeStatement(java.sql.PreparedStatement stmt)

closes the statement

Parameters:

stmt - the statement

logException

protected void logException(java.lang.String message,
                            java.sql.SQLException e)

logs an sql exception

Parameters:

message - the message

e - the exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

buildSQLStatements

protected void buildSQLStatements()

Initializes the SQL strings.