|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Mapper
A Mapper
maps Row
s to and from the database.
Nested Class Summary | |
---|---|
static class |
Mapper.Identification
Identifiers assigned by a server to identify a client mapper and its repository. |
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 | |
---|---|
static String |
CLOSE
|
static String |
GET_IDENTIFICATION
|
Fields inherited from interface javax.transaction.xa.XAResource |
---|
TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY |
Method Summary | |
---|---|
void |
close()
|
void |
createClusterNode()
Informs the cluster that this node exists. |
void |
createDatabase()
Creates the necessary structures in the database. |
Set<Serializable> |
getAncestorsIds(Collection<Serializable> ids)
Gets the ids for all the ancestors of the given row ids. |
Invalidations |
getClusterInvalidations()
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(Serializable repositoryId)
Gets the root id for a given repository, if registered. |
int |
getTableSize(String tableName)
|
void |
insertClusterInvalidations(Invalidations invalidations)
Inserts the invalidation rows for the other cluster nodes. |
void |
markReferencedBinaries(BinaryGarbageCollector gc)
Marks the binaries referenced by this mapper with the referenced binary garbage collector. |
PartialList<Serializable> |
query(String query,
String queryType,
QueryFilter queryFilter,
boolean countTotal)
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()
|
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. |
void |
updateReadAcls()
|
Methods inherited from interface org.nuxeo.ecm.core.storage.sql.RowMapper |
---|
clearCache, copy, isClusterReconnecting, read, readCollectionRowArray, readSelectionRows, readSimpleRow, receiveInvalidations, remove, rollback, sendInvalidations, write |
Methods inherited from interface javax.transaction.xa.XAResource |
---|
commit, end, forget, getTransactionTimeout, isSameRM, prepare, recover, rollback, setTransactionTimeout, start |
Field Detail |
---|
static final String GET_IDENTIFICATION
static final String CLOSE
Method Detail |
---|
Mapper.Identification getIdentification() throws StorageException
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.
StorageException
- when initial connection failed (for a NetMapper)void close() throws StorageException
StorageException
int getTableSize(String tableName) throws StorageException
StorageException
void createDatabase() throws StorageException
StorageException
Serializable getRootId(Serializable repositoryId) throws StorageException
repositoryId
- the repository id, usually 0
StorageException
void setRootId(Serializable repositoryId, Serializable id) throws StorageException
repositoryId
- the repository id, usually 0id
- the root id
StorageException
PartialList<Serializable> query(String query, String queryType, QueryFilter queryFilter, boolean countTotal) throws StorageException
query
- the queryquery
- the query typequeryFilter
- the query filtercountTotal
- if true
, count the total size without
limit/offset
StorageException
IterableQueryResult queryAndFetch(String query, String queryType, QueryFilter queryFilter, Object... params) throws StorageException
query
- the queryqueryType
- the query typequeryFilter
- the query filterparams
- optional query-type-dependent parameters
StorageException
Set<Serializable> getAncestorsIds(Collection<Serializable> ids) throws StorageException
ids
- the ids
StorageException
void updateReadAcls() throws StorageException
StorageException
void rebuildReadAcls() throws StorageException
StorageException
void createClusterNode() throws StorageException
StorageException
void removeClusterNode() throws StorageException
StorageException
void insertClusterInvalidations(Invalidations invalidations) throws StorageException
StorageException
Invalidations getClusterInvalidations() throws StorageException
StorageException
Lock getLock(Serializable id) throws StorageException
If the document does not exist, null
is returned.
id
- the document id
null
when there is no lock
StorageException
Lock setLock(Serializable id, Lock lock) throws StorageException
If the document is already locked, returns its existing lock status
(there is no re-locking, removeLock(java.io.Serializable, java.lang.String, boolean)
must be called first).
id
- the document idlock
- the lock object to set
null
if locking succeeded, or the existing lock if
locking failed, or a
StorageException
Lock removeLock(Serializable id, String owner, boolean force) throws StorageException
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()
.
id
- the document idthe
- owner to check, or null
for no checkforce
- true
to just do the remove and not return the
previous lock
StorageException
void markReferencedBinaries(BinaryGarbageCollector gc) throws StorageException
gc
- the binary garbage collector
StorageException
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |