org.nuxeo.ecm.core.storage.sql

Class SoftRefCachingMapper

java.lang.Object

org.nuxeo.ecm.core.storage.sql.SoftRefCachingRowMapper

org.nuxeo.ecm.core.storage.sql.SoftRefCachingMapper

All Implemented Interfaces:

XAResource, CachingMapper, Mapper, RowMapper

public class SoftRefCachingMapper
extends SoftRefCachingRowMapper
implements CachingMapper

A Mapper that uses a SoftRefCachingRowMapper 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.SoftRefCachingRowMapper

cacheQueue

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

Method Summary

Methods

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()
String	createClusterNode() Informs the cluster that this node exists.
void	createDatabase() 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(String nodeId) Gets the invalidations from other cluster nodes.
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 cachePropagator, Map<String,String> properties) Initialize the caching mapper instance
void	insertClusterInvalidations(Invalidations invalidations, String nodeId) Inserts the invalidation rows for the other cluster nodes.
boolean	isConnected()
boolean	isSameRM(XAResource xares)
void	markReferencedBinaries(BinaryGarbageCollector gc) Marks the binaries referenced by this mapper with the referenced binary garbage collector.
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, Object... params) Makes a query to the database and returns an iterable (which must be closed when done).
void	rebuildReadAcls()
Xid[]	recover(int flag)
void	removeClusterNode() Removes this node from the cluster.
Lock	removeLock(Serializable id, String owner, boolean force) Removes a lock from a document.
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.SoftRefCachingRowMapper

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

Methods inherited from class java.lang.Object

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

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

clearCache, copy, generateNewId, getBinaryFulltext, getCacheSize, read, readCollectionRowArray, readSelectionRows, 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

SoftRefCachingMapper

public SoftRefCachingMapper()

Method Detail

initialize

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

Description copied from interface: CachingMapper

Initialize the caching mapper instance

Specified by:

initialize in interface CachingMapper

getIdentification

public Mapper.Identification getIdentification()
                                        throws StorageException

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

Throws:

StorageException - when initial connection failed (for a NetMapper)

close

public void close()
           throws StorageException

Specified by:

close in interface Mapper

Overrides:

close in class SoftRefCachingRowMapper

Throws:

StorageException

getTableSize

public int getTableSize(String tableName)
                 throws StorageException

Specified by:

getTableSize in interface Mapper

Throws:

StorageException

createDatabase

public void createDatabase()
                    throws StorageException

Description copied from interface: Mapper

Creates the necessary structures in the database.

Specified by:

createDatabase in interface Mapper

Throws:

StorageException

getRootId

public Serializable getRootId(String repositoryId)
                       throws StorageException

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

Throws:

StorageException

setRootId

public void setRootId(Serializable repositoryId,
             Serializable id)
               throws StorageException

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

Throws:

StorageException

query

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

Description copied from interface: Mapper

Makes a NXQL query to the database.

Specified by:

query in interface Mapper

Parameters:

query - the query

queryFilter - the query filter

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

Returns:

the list of matching document ids

Throws:

StorageException

query

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

Description copied from interface: Mapper

Makes a NXQL query to the database.

Specified by:

query in interface Mapper

Parameters:

query - the query

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

Throws:

StorageException

queryAndFetch

public IterableQueryResult queryAndFetch(String query,
                                String queryType,
                                QueryFilter queryFilter,
                                Object... params)
                                  throws StorageException

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

params - optional query-type-dependent parameters

Returns:

an iterable, which must be closed when done

Throws:

StorageException

getAncestorsIds

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

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

Throws:

StorageException

updateReadAcls

public void updateReadAcls()
                    throws StorageException

Specified by:

updateReadAcls in interface Mapper

Throws:

StorageException

rebuildReadAcls

public void rebuildReadAcls()
                     throws StorageException

Specified by:

rebuildReadAcls in interface Mapper

Throws:

StorageException

createClusterNode

public String createClusterNode()
                         throws StorageException

Description copied from interface: Mapper

Informs the cluster that this node exists.

Specified by:

createClusterNode in interface Mapper

Returns:

the cluster node id, if relevant for this database

Throws:

StorageException

removeClusterNode

public void removeClusterNode()
                       throws StorageException

Description copied from interface: Mapper

Removes this node from the cluster.

Specified by:

removeClusterNode in interface Mapper

Throws:

StorageException

insertClusterInvalidations

public void insertClusterInvalidations(Invalidations invalidations,
                              String nodeId)
                                throws StorageException

Description copied from interface: Mapper

Inserts the invalidation rows for the other cluster nodes.

Specified by:

insertClusterInvalidations in interface Mapper

Throws:

StorageException

getClusterInvalidations

public Invalidations getClusterInvalidations(String nodeId)
                                      throws StorageException

Description copied from interface: Mapper

Gets the invalidations from other cluster nodes.

Specified by:

getClusterInvalidations in interface Mapper

Throws:

StorageException

getLock

public Lock getLock(Serializable id)
             throws StorageException

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

Throws:

StorageException

setLock

public Lock setLock(Serializable id,
           Lock lock)
             throws StorageException

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

Throws:

StorageException

removeLock

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

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

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

Returns:

the previous lock

Throws:

StorageException

markReferencedBinaries

public void markReferencedBinaries(BinaryGarbageCollector gc)
                            throws StorageException

Description copied from interface: Mapper

Marks the binaries referenced by this mapper with the referenced binary garbage collector.

Specified by:

markReferencedBinaries in interface Mapper

Parameters:

gc - the binary garbage collector

Throws:

StorageException

cleanupDeletedRows

public int cleanupDeletedRows(int max,
                     Calendar beforeTime)
                       throws StorageException

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

Throws:

StorageException

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()
             throws StorageException

Specified by:

connect in interface Mapper

Throws:

StorageException

disconnect

public void disconnect()

Specified by:

disconnect in interface Mapper