org.nuxeo.ecm.core.storage.sql.jdbc

Class JDBCMapper

java.lang.Object

org.nuxeo.ecm.core.storage.sql.jdbc.JDBCConnection

org.nuxeo.ecm.core.storage.sql.jdbc.JDBCRowMapper

org.nuxeo.ecm.core.storage.sql.jdbc.JDBCMapper

All Implemented Interfaces:

XAResource, Mapper, RowMapper

public class JDBCMapper
extends JDBCRowMapper
implements Mapper

A JDBCMapper maps objects to and from a JDBC database. It is specific to a given database connection, as it computes statements.

The JDBCMapper does the mapping according to the policy defined by a Model, and generates SQL statements recorded in the SQLInfo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	JDBCMapper.BiFunctionSQLException<T,U,R>
protected class	JDBCMapper.CursorResult

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.storage.sql.Mapper

Mapper.Identification

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.storage.sql.RowMapper

RowMapper.CopyResult, RowMapper.IdWithTypes, RowMapper.NodeInfo, RowMapper.RowBatch, RowMapper.RowUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	clusteringEnabled
protected static Map<String,JDBCMapper.CursorResult>	cursorResults
protected static String	NOSCROLL_ID
protected TableUpgrader	tableUpgrader
static String	TEST_UPGRADE
static String	TEST_UPGRADE_LAST_CONTRIBUTOR
static String	TEST_UPGRADE_LOCKS
static String	TEST_UPGRADE_SYS_CHANGE_TOKEN
static String	TEST_UPGRADE_VERSIONS
static Map<String,Serializable>	testProps

Fields inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.JDBCRowMapper

COLLECTION_DELETE_BEFORE_APPEND_PROP, DEBUG_MAX_TREE, UPDATE_BATCH_SIZE

Fields inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.JDBCConnection

connection, countExecutes, dialect, executeCount, logger, model, setClientInfo, sqlInfo, supportsBatchUpdates, xaresource

Fields inherited from interface org.nuxeo.ecm.core.storage.sql.Mapper

CLOSE, GET_IDENTIFICATION

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
JDBCMapper(Model model, Session.PathResolver pathResolver, SQLInfo sqlInfo, ClusterInvalidator clusterInvalidator, RepositoryImpl repository) Creates a new Mapper.

Method Summary

Modifier and Type	Method and Description
protected void	checkForTimedoutScroll()
void	commit(Xid xid, boolean onePhase)
protected String	computeDistinctDocuments(String query, boolean distinctDocuments)
void	connect(boolean noSharing)
void	createClusterNode(Serializable nodeId) Informs the cluster that this node exists.
void	createDatabase(String ddlMode) Creates the necessary structures in the database.
protected void	createTables(String ddlMode)
protected ScrollResult	defaultScroll(String query)
protected void	deleteClusterInvals(Serializable nodeId)
void	disconnect()
void	end(Xid xid, int flags)
protected QueryMaker	findQueryMaker(String queryType)
protected static Set<String>	findTableNames(DatabaseMetaData metadata, String schemaName) Finds uppercase table names.
void	forget(Xid xid)
Set<Serializable>	getAncestorsIds(Collection<Serializable> ids) Gets the ids for all the ancestors of the given row ids.
protected Set<Serializable>	getAncestorsIdsIterative(Collection<Serializable> ids) Uses iterative parentid selection.
Invalidations	getClusterInvalidations(Serializable nodeId) Gets the invalidations from other cluster nodes.
int	getClusterNodeIdType()
Lock	getLock(Serializable id) Gets the lock state of a document.
Serializable	getRootId(String repositoryId) Gets the root id for a given repository, if registered.
protected String	getTableName(String origName)
int	getTableSize(String tableName)
int	getTransactionTimeout()
void	insertClusterInvalidations(Serializable nodeId, Invalidations invalidations) Inserts the invalidation rows for the other cluster nodes.
boolean	isConnected()
boolean	isSameRM(XAResource xares)
protected static String	join(Collection<String> strings, char sep)
void	markReferencedBinaries() Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
int	prepare(Xid xid)
protected void	prepareUserReadAcls(QueryFilter queryFilter)
PartialList<Serializable>	query(String query, String queryType, QueryFilter queryFilter, boolean countTotal) Makes a NXQL query to the database.
PartialList<Serializable>	query(String query, String queryType, QueryFilter queryFilter, long countUpTo) Makes a NXQL query to the database.
IterableQueryResult	queryAndFetch(String query, String queryType, QueryFilter queryFilter, boolean distinctDocuments, Object... params) Makes a query to the database and returns an iterable (which must be closed when done).
PartialList<Map<String,Serializable>>	queryProjection(String query, String queryType, QueryFilter queryFilter, boolean distinctDocuments, long countUpTo, Object... params) Makes a query to the database.
protected <T> PartialList<T>	queryProjection(String query, String queryType, QueryFilter queryFilter, long countUpTo, JDBCMapper.BiFunctionSQLException<SQLInfo.SQLInfoSelect,ResultSet,T> extractor, Object... params)
void	rebuildReadAcls()
Xid[]	recover(int flag)
protected void	registerCursor(String scrollId, PreparedStatement ps, ResultSet rs, int batchSize, int keepAliveSeconds)
void	removeClusterNode(Serializable nodeId) Removes this node from the cluster.
Lock	removeLock(Serializable id, String owner, boolean force) Removes a lock from a document.
ScrollResult	scroll(String scrollId) Get the next batch of result, the scrollId is part of the previous ScrollResult response.
ScrollResult	scroll(String query, int batchSize, int keepAliveSeconds) Executes the given query and returns the first batch of results, next batch must be requested within the keepAliveSeconds delay.
protected ScrollResult	scrollSearch(String query, int batchSize, int keepAliveSeconds)
Lock	setLock(Serializable id, Lock lock) Sets a lock on a document.
void	setRootId(Serializable repositoryId, Serializable id) Records the newly generated root id for a given repository.
int	setToPreparedStatement(PreparedStatement ps, int i, Serializable object)
boolean	setTransactionTimeout(int seconds)
void	start(Xid xid, int flags)
protected static String	systemToString(Object o)
protected boolean	unregisterCursor(String scrollId)
void	updateReadAcls()
protected void	upgradeTable(String tableKey, List<Column> addedColumns, String ddlMode, SQLStatement.ListCollector ddlCollector)

Methods inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.JDBCRowMapper

cleanupDeletedRows, clearCache, copy, copyHier, copyHierRecursive, copyRows, deleteRows, deleteRowsDirect, deleteRowsSoft, doSoftDeleteRows, generateNewId, getBinaryFulltext, getCacheSize, getChildrenIdsWithTypes, getChildrenNodeInfos, getCollectionIO, getDescendantsInfo, getDescendantsInfoIterative, getSelectRows, insertCollectionRows, insertSimpleRows, newIdArray, read, readCollectionArrays, readCollectionRowArray, readSelectionRows, readSelectionsIds, readSimpleRow, readSimpleRows, receiveInvalidations, remove, rollback, sendInvalidations, setToPreparedStatementIdArray, updateCollectionRows, updateSimpleRows, updateSimpleRowWithValues, write, writeCreates, writeDeletes, writeUpdates

Methods inherited from class org.nuxeo.ecm.core.storage.sql.jdbc.JDBCConnection

checkConcurrentUpdate, close, closeConnections, countExecute, getDataSourceName, getIdentification, getRepositoryName, openBaseConnection, openConnections

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.storage.sql.Mapper

cleanupDeletedRows, close, getIdentification

Methods inherited from interface org.nuxeo.ecm.core.storage.sql.RowMapper

clearCache, copy, generateNewId, getBinaryFulltext, getCacheSize, getDescendantsInfo, read, readCollectionRowArray, readSelectionRows, readSelectionsIds, readSimpleRow, receiveInvalidations, remove, rollback, sendInvalidations, write

Methods inherited from interface javax.transaction.xa.XAResource

rollback

Field Detail

testProps

public static Map<String,Serializable> testProps

cursorResults

protected static Map<String,JDBCMapper.CursorResult> cursorResults

TEST_UPGRADE

public static final String TEST_UPGRADE

See Also:

Constant Field Values

TEST_UPGRADE_VERSIONS

public static final String TEST_UPGRADE_VERSIONS

See Also:

Constant Field Values

TEST_UPGRADE_LAST_CONTRIBUTOR

public static final String TEST_UPGRADE_LAST_CONTRIBUTOR

See Also:

Constant Field Values

TEST_UPGRADE_LOCKS

public static final String TEST_UPGRADE_LOCKS

See Also:

Constant Field Values

TEST_UPGRADE_SYS_CHANGE_TOKEN

public static final String TEST_UPGRADE_SYS_CHANGE_TOKEN

See Also:

Constant Field Values

tableUpgrader

protected TableUpgrader tableUpgrader

clusteringEnabled

protected boolean clusteringEnabled

NOSCROLL_ID

protected static final String NOSCROLL_ID

See Also:

Constant Field Values

Constructor Detail

JDBCMapper

public JDBCMapper(Model model,
                  Session.PathResolver pathResolver,
                  SQLInfo sqlInfo,
                  ClusterInvalidator clusterInvalidator,
                  RepositoryImpl repository)

Creates a new Mapper.

Parameters:

model - the model

pathResolver - the path resolver (used for startswith queries)

sqlInfo - the sql info

clusterInvalidator - the cluster invalidator

repository - the repository

Method Detail

getTableSize

public int getTableSize(String tableName)

Specified by:

getTableSize in interface Mapper

createDatabase

public void createDatabase(String ddlMode)

Description copied from interface: Mapper

Creates the necessary structures in the database.

Specified by:

createDatabase in interface Mapper

Parameters:

ddlMode - the DDL execution mode

getTableName

protected String getTableName(String origName)

createTables

protected void createTables(String ddlMode)
                     throws SQLException

Throws:

SQLException

upgradeTable

protected void upgradeTable(String tableKey,
                            List<Column> addedColumns,
                            String ddlMode,
                            SQLStatement.ListCollector ddlCollector)
                     throws SQLException

Throws:

SQLException

findTableNames

protected static Set<String> findTableNames(DatabaseMetaData metadata,
                                            String schemaName)
                                     throws SQLException

Finds uppercase table names.

Throws:

SQLException

getClusterNodeIdType

public int getClusterNodeIdType()

Specified by:

getClusterNodeIdType in interface Mapper

createClusterNode

public void createClusterNode(Serializable nodeId)

Description copied from interface: Mapper

Informs the cluster that this node exists.

Specified by:

createClusterNode in interface Mapper

removeClusterNode

public void removeClusterNode(Serializable nodeId)

Description copied from interface: Mapper

Removes this node from the cluster.

Specified by:

removeClusterNode in interface Mapper

deleteClusterInvals

protected void deleteClusterInvals(Serializable nodeId)
                            throws SQLException

Throws:

SQLException

insertClusterInvalidations

public void insertClusterInvalidations(Serializable nodeId,
                                       Invalidations invalidations)

Description copied from interface: Mapper

Inserts the invalidation rows for the other cluster nodes.

Specified by:

insertClusterInvalidations in interface Mapper

join

protected static String join(Collection<String> strings,
                             char sep)

getClusterInvalidations

public Invalidations getClusterInvalidations(Serializable nodeId)

Description copied from interface: Mapper

Gets the invalidations from other cluster nodes.

Specified by:

getClusterInvalidations in interface Mapper

getRootId

public Serializable getRootId(String repositoryId)

Description copied from interface: Mapper

Gets the root id for a given repository, if registered.

Specified by:

getRootId in interface Mapper

Parameters:

repositoryId - the repository id

Returns:

the root id, or null if not found

setRootId

public void setRootId(Serializable repositoryId,
                      Serializable id)

Description copied from interface: Mapper

Records the newly generated root id for a given repository.

Specified by:

setRootId in interface Mapper

Parameters:

repositoryId - the repository id, usually 0

id - the root id

findQueryMaker

protected QueryMaker findQueryMaker(String queryType)

prepareUserReadAcls

protected void prepareUserReadAcls(QueryFilter queryFilter)

query

public PartialList<Serializable> query(String query,
                                       String queryType,
                                       QueryFilter queryFilter,
                                       boolean countTotal)

Description copied from interface: Mapper

Makes a NXQL query to the database.

Specified by:

query in interface Mapper

Parameters:

query - the query

queryType - the query type

queryFilter - the query filter

countTotal - if true, count the total size without limit/offset

Returns:

the list of matching document ids

query

public PartialList<Serializable> query(String query,
                                       String queryType,
                                       QueryFilter queryFilter,
                                       long countUpTo)

Description copied from interface: Mapper

Makes a NXQL query to the database.

Specified by:

query in interface Mapper

Parameters:

query - the query

queryType - the query type

queryFilter - the query filter

countUpTo - if -1, count the total size without offset/limit.
If 0, don't count the total size.
If n, count the total number if there are less than n documents otherwise set the size to -1.

Returns:

the list of matching document ids

queryAndFetch

public IterableQueryResult queryAndFetch(String query,
                                         String queryType,
                                         QueryFilter queryFilter,
                                         boolean distinctDocuments,
                                         Object... params)

Description copied from interface: Mapper

Makes a query to the database and returns an iterable (which must be closed when done).

Specified by:

queryAndFetch in interface Mapper

Parameters:

query - the query

queryType - the query type

queryFilter - the query filter

distinctDocuments - if true then a maximum of one row per document will be returned

params - optional query-type-dependent parameters

Returns:

an iterable, which must be closed when done

queryProjection

public PartialList<Map<String,Serializable>> queryProjection(String query,
                                                             String queryType,
                                                             QueryFilter queryFilter,
                                                             boolean distinctDocuments,
                                                             long countUpTo,
                                                             Object... params)

Description copied from interface: Mapper

Makes a query to the database.

Specified by:

queryProjection in interface Mapper

Parameters:

query - the query

queryType - the query type

queryFilter - the query filter

distinctDocuments - if true then a maximum of one row per document will be returned

countUpTo - if -1, also count the total size without offset/limit.
If 0, don't count the total size.
If n, count the total number if there are less than n documents otherwise set the size to -1.

params - optional query-type-dependent parameters

Returns:

a projection

computeDistinctDocuments

protected String computeDistinctDocuments(String query,
                                          boolean distinctDocuments)

queryProjection

protected <T> PartialList<T> queryProjection(String query,
                                             String queryType,
                                             QueryFilter queryFilter,
                                             long countUpTo,
                                             JDBCMapper.BiFunctionSQLException<SQLInfo.SQLInfoSelect,ResultSet,T> extractor,
                                             Object... params)

setToPreparedStatement

public int setToPreparedStatement(PreparedStatement ps,
                                  int i,
                                  Serializable object)
                           throws SQLException

Throws:

SQLException

scroll

public ScrollResult scroll(String query,
                           int batchSize,
                           int keepAliveSeconds)

Description copied from interface: Mapper

Executes the given query and returns the first batch of results, next batch must be requested within the keepAliveSeconds delay.

Specified by:

scroll in interface Mapper

checkForTimedoutScroll

protected void checkForTimedoutScroll()

scrollSearch

protected ScrollResult scrollSearch(String query,
                                    int batchSize,
                                    int keepAliveSeconds)

registerCursor

protected void registerCursor(String scrollId,
                              PreparedStatement ps,
                              ResultSet rs,
                              int batchSize,
                              int keepAliveSeconds)

unregisterCursor

protected boolean unregisterCursor(String scrollId)

defaultScroll

protected ScrollResult defaultScroll(String query)

scroll

public ScrollResult scroll(String scrollId)

Description copied from interface: Mapper

Get the next batch of result, the scrollId is part of the previous ScrollResult response.

Specified by:

scroll in interface Mapper

getAncestorsIds

public Set<Serializable> getAncestorsIds(Collection<Serializable> ids)

Description copied from interface: Mapper

Gets the ids for all the ancestors of the given row ids.

Specified by:

getAncestorsIds in interface Mapper

Parameters:

ids - the ids

Returns:

the set of ancestor ids

getAncestorsIdsIterative

protected Set<Serializable> getAncestorsIdsIterative(Collection<Serializable> ids)

Uses iterative parentid selection.

updateReadAcls

public void updateReadAcls()

Specified by:

updateReadAcls in interface Mapper

rebuildReadAcls

public void rebuildReadAcls()

Specified by:

rebuildReadAcls in interface Mapper

getLock

public Lock getLock(Serializable id)

Description copied from interface: Mapper

Gets the lock state of a document.

If the document does not exist, null is returned.

Specified by:

getLock in interface Mapper

Parameters:

id - the document id

Returns:

the existing lock, or null when there is no lock

setLock

public Lock setLock(Serializable id,
                    Lock lock)

Description copied from interface: Mapper

Sets a lock on a document.

If the document is already locked, returns its existing lock status (there is no re-locking, Mapper.removeLock(java.io.Serializable, java.lang.String, boolean) must be called first).

Specified by:

setLock in interface Mapper

Parameters:

id - the document id

lock - the lock object to set

Returns:

null if locking succeeded, or the existing lock if locking failed, or a

removeLock

public Lock removeLock(Serializable id,
                       String owner,
                       boolean force)

Description copied from interface: Mapper

Removes a lock from a document.

The previous lock is returned.

If owner is null then the lock is unconditionally removed.

If owner is not null, it must match the existing lock owner for the lock to be removed. If it doesn't match, the returned lock will return true for Lock.getFailed().

Specified by:

removeLock in interface Mapper

Parameters:

id - the document id

owner - the owner to check, or null for no check

force - true to just do the remove and not return the previous lock

Returns:

the previous lock

markReferencedBinaries

public void markReferencedBinaries()

Description copied from interface: Mapper

Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.

Specified by:

markReferencedBinaries in interface Mapper

systemToString

protected static String systemToString(Object o)

start

public void start(Xid xid,
                  int flags)
           throws XAException

Specified by:

start in interface XAResource

Throws:

XAException

end

public void end(Xid xid,
                int flags)
         throws XAException

Specified by:

end in interface XAResource

Throws:

XAException

prepare

public int prepare(Xid xid)
            throws XAException

Specified by:

prepare in interface XAResource

Throws:

XAException

commit

public void commit(Xid xid,
                   boolean onePhase)
            throws XAException

Specified by:

commit in interface XAResource

Throws:

XAException

forget

public void forget(Xid xid)
            throws XAException

Specified by:

forget in interface XAResource

Throws:

XAException

recover

public Xid[] recover(int flag)
              throws XAException

Specified by:

recover in interface XAResource

Throws:

XAException

setTransactionTimeout

public boolean setTransactionTimeout(int seconds)
                              throws XAException

Specified by:

setTransactionTimeout in interface XAResource

Throws:

XAException

getTransactionTimeout

public int getTransactionTimeout()
                          throws XAException

Specified by:

getTransactionTimeout in interface XAResource

Throws:

XAException

isSameRM

public boolean isSameRM(XAResource xares)
                 throws XAException

Specified by:

isSameRM in interface XAResource

Throws:

XAException

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Mapper

connect

public void connect(boolean noSharing)

Specified by:

connect in interface Mapper

disconnect

public void disconnect()

Specified by:

disconnect in interface Mapper