org.nuxeo.ecm.core.storage.sql

Class UnifiedCachingMapper

java.lang.Object

org.nuxeo.ecm.core.storage.sql.UnifiedCachingRowMapper

org.nuxeo.ecm.core.storage.sql.UnifiedCachingMapper

All Implemented Interfaces:

XAResource, CachingMapper, Mapper, RowMapper

public class UnifiedCachingMapper
extends UnifiedCachingRowMapper
implements CachingMapper

A Mapper that uses a UnifiedCachingRowMapper for row-related operation, and delegates to the Mapper for others.

Nested Class Summary

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
Mapper	mapper The Mapper to which operations are delegated.

Fields inherited from class org.nuxeo.ecm.core.storage.sql.UnifiedCachingRowMapper

cacheGetTimer, cacheHitCount, isXA, registry, sorGetTimer, sorRows

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
UnifiedCachingMapper()

Method Summary

Modifier and Type	Method and Description
int	cleanupDeletedRows(int max, Calendar beforeTime) Cleans up (hard-delete) any rows that have been soft-deleted in the database.
void	close()
void	commit(Xid xid, boolean onePhase)
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.
void	disconnect()
void	end(Xid xid, int flags)
void	forget(Xid xid)
Set<Serializable>	getAncestorsIds(Collection<Serializable> ids) Gets the ids for all the ancestors of the given row ids.
Invalidations	getClusterInvalidations(Serializable nodeId) Gets the invalidations from other cluster nodes.
int	getClusterNodeIdType()
Mapper.Identification	getIdentification() Returns the repository id and mapper id assigned.
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.
int	getTableSize(String tableName)
int	getTransactionTimeout()
void	initialize(String repositoryName, Model model, Mapper mapper, InvalidationsPropagator invalidationsPropagator, Map<String,String> properties) Initialize the caching mapper instance
void	insertClusterInvalidations(Serializable nodeId, Invalidations invalidations) Inserts the invalidation rows for the other cluster nodes.
boolean	isConnected()
boolean	isSameRM(XAResource xares)
void	markReferencedBinaries() Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
int	prepare(Xid xid)
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.
void	rebuildReadAcls()
Xid[]	recover(int flag)
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 results containing id of documents, 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 containing id of documents, next batch must be requested within the keepAliveSeconds delay.
ScrollResult	scroll(String query, QueryFilter queryFilter, int batchSize, int keepAliveSeconds) Executes the given query and returns the first batch of results containing id of documents, next batch must be requested within the keepAliveSeconds delay.
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.
boolean	setTransactionTimeout(int seconds)
void	start(Xid xid, int flags)
void	updateReadAcls()

Methods inherited from class org.nuxeo.ecm.core.storage.sql.UnifiedCachingRowMapper

cacheGet, cachePut, cachePutAbsent, cachePutAbsentIfNull, cachePutAbsentIfRowId, cacheRemove, clearCache, copy, ehCacheGet, ehCacheGetSize, ehCachePut, ehCacheRemove, ehCacheRemoveAll, generateNewId, getBinaryFulltext, getCacheSize, getDescendantsInfo, hasTransaction, initialize, isAbsent, read, readCollectionRowArray, readSelectionRows, readSelectionsIds, readSimpleRow, receiveInvalidations, remove, rollback, sendInvalidations, setMetrics, sortACLRows, useEhCache, write

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.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

mapper

public Mapper mapper

The Mapper to which operations are delegated.

Constructor Detail

UnifiedCachingMapper

public UnifiedCachingMapper()

Method Detail

initialize

public void initialize(String repositoryName,
                       Model model,
                       Mapper mapper,
                       InvalidationsPropagator invalidationsPropagator,
                       Map<String,String> properties)

Description copied from interface: CachingMapper

Initialize the caching mapper instance

Specified by:

initialize in interface CachingMapper

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 containing id of documents, next batch must be requested within the keepAliveSeconds delay.

Specified by:

scroll in interface Mapper

scroll

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

Description copied from interface: Mapper

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

Specified by:

scroll in interface Mapper

scroll

public ScrollResult scroll(String scrollId)

Description copied from interface: Mapper

Get the next batch of results containing id of documents, the scrollId is part of the previous ScrollResult response.

Specified by:

scroll in interface Mapper

getIdentification

public Mapper.Identification getIdentification()

Description copied from interface: Mapper

Returns the repository id and mapper id assigned.

This is used in remote stateless mode to be able to identify to which mapper an incoming connection is targeted, and from which repository instance.

Specified by:

getIdentification in interface Mapper

Returns:

the repository and mapper identification

close

public void close()

Specified by:

close in interface Mapper

Overrides:

close in class UnifiedCachingRowMapper

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

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

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

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

updateReadAcls

public void updateReadAcls()

Specified by:

updateReadAcls in interface Mapper

rebuildReadAcls

public void rebuildReadAcls()

Specified by:

rebuildReadAcls in interface Mapper

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

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

getClusterInvalidations

public Invalidations getClusterInvalidations(Serializable nodeId)

Description copied from interface: Mapper

Gets the invalidations from other cluster nodes.

Specified by:

getClusterInvalidations 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

cleanupDeletedRows

public int cleanupDeletedRows(int max,
                              Calendar beforeTime)

Description copied from interface: Mapper

Cleans up (hard-delete) any rows that have been soft-deleted in the database.

Specified by:

cleanupDeletedRows in interface Mapper

Parameters:

max - the maximum number of rows to delete at a time

beforeTime - the maximum deletion time of the rows to delete

Returns:

the number of rows deleted

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