AbstractTransactionContext
, GlobalTransactionContext
, LocalTransactionContext
public interface TransactionContext
XAResourceImpl
.Modifier and Type | Method | Description |
---|---|---|
void |
addTxSynchronizable(TxSynchronizable synchronizable) |
Register a listener which wants to synchronize its state to the state of the
transaction.
|
void |
close() |
Closes all Connections.
|
void |
commit() |
Commits all changes and closes the transaction releasing all locks on all
objects.
|
void |
create(ClassMolder molder,
java.lang.Object object,
OID depended) |
Creates a new object in persistent storage.
|
void |
delete(java.lang.Object object) |
Deletes the object from persistent storage.
|
void |
expireCache(ClassMolder molder,
Identity identity) |
Expire object from the cache.
|
java.lang.Object |
fetch(ClassMolder molder,
Identity identity,
AccessMode suggestedAccessMode) |
|
java.lang.ClassLoader |
getClassLoader() |
Get the current application ClassLoader.
|
java.sql.Connection |
getConnection(LockEngine engine) |
Return an open connection for the specified engine.
|
DbMetaInfo |
getConnectionInfo(LockEngine engine) |
Returns meta-data related to the RDBMS used.
|
Database |
getDatabase() |
|
int |
getLockTimeout() |
Returns the timeout waiting to acquire a lock.
|
NamedNativeQuery |
getNamedNativeQuery(ClassMolder molder,
java.lang.String name) |
Returns a NamedNativeQuery instance query based upon a named query as defined in the
mapping file.
|
java.lang.String |
getNamedQuery(ClassMolder molder,
java.lang.String name) |
Creates an OQL query based upon a named query as defined in the
mapping file.
|
int |
getStatus() |
Returns the status of this transaction.
|
int |
getTransactionTimeout() |
Returns the timeout of this transaction.
|
ObjectLock |
getWaitOnLock() |
Returns the lock which this transaction attempts to acquire.
|
boolean |
isAutoStore() |
Deprecated.
Please use the 'cascading' attribute of the field mapping instead.
|
boolean |
isCached(ClassMolder molder,
java.lang.Class cls,
Identity identity) |
|
boolean |
isCreated(java.lang.Object object) |
Returns true if the object is marked as created in this transaction.
|
boolean |
isDeleted(java.lang.Object object) |
Returns true if and only if the specified object is loaded or created in this
transaction and is deleted.
|
boolean |
isDeletedByOID(OID oid) |
|
boolean |
isDepended(OID master,
java.lang.Object dependent) |
|
boolean |
isLocked(java.lang.Class cls,
Identity identity,
LockEngine lockEngine) |
Returns true if the object given is locked.
|
boolean |
isOpen() |
Returns true if the transaction is open.
|
boolean |
isPersistent(java.lang.Object object) |
Returns true if the object is persistent in this transaction.
|
boolean |
isReadOnly(java.lang.Object object) |
Check to see whether this transaction considers an object to have been marked
read-only.
|
boolean |
isRecorded(java.lang.Object object) |
Returns true if the object has been previously queried/loaded/updated/created in
this transaction.
|
boolean |
isUpdateCacheNeeded(java.lang.Object object) |
Retrieves the state of the object in this transaction.
|
boolean |
isUpdatePersistNeeded(java.lang.Object object) |
Retrieves the state of the object in this transaction.
|
java.util.Iterator |
iterateReadWriteObjectsInTransaction() |
Expose an enumeration of the commited object entries to allow TxSynchronizable
to iterate through the objects.
|
java.lang.Object |
load(Identity identity,
ProposedEntity proposedObject,
AccessMode suggestedAccessMode) |
Load an object for use within the transaction.
|
java.lang.Object |
load(Identity identity,
ProposedEntity proposedObject,
AccessMode suggestedAccessMode,
QueryResults results) |
Load an object for use within the transaction.
|
void |
markCreate(ClassMolder molder,
java.lang.Object object,
OID rootObjectOID) |
Walk a data object tree starting from the specified object, and mark all
objects to be created.
|
void |
markModified(java.lang.Object object,
boolean updatePersist,
boolean updateCache) |
|
boolean |
markUpdate(ClassMolder molder,
java.lang.Object object,
OID depended) |
Update a new object in persistent storage and returns the object's OID.
|
boolean |
prepare() |
Prepares the transaction prior to committing it.
|
QueryResults |
query(LockEngine engine,
PersistenceQuery query,
AccessMode accessMode,
boolean scrollable) |
Perform a query using the query mechanism with the specified access mode.
|
void |
removeTxSynchronizable(TxSynchronizable synchronizable) |
Unregister a listener which wants to synchronize its state to the state of the
transaction.
|
void |
rollback() |
Rolls back all changes and closes the transaction releasing all locks on
all objects.
|
void |
setAutoStore(boolean autoStore) |
Deprecated.
Please use the 'cascading' attribute of the field mapping instead.
|
void |
setCallback(CallbackInterceptor callback) |
Overrides the default callback interceptor by a custom interceptor for this
database source.
|
void |
setInstanceFactory(InstanceFactory factory) |
Overrides the default instance factory by a custom one for this database
source.
|
void |
setLockTimeout(int timeout) |
Sets the timeout waiting to acquire a lock.
|
void |
setStatus(int status) |
Sets the status of the current transaction to the given one.
|
void |
setTransactionTimeout(int timeout) |
Sets the timeout of this transaction.
|
void |
setWaitOnLock(ObjectLock lock) |
Indicates which lock this transaction is waiting for.
|
void |
update(ClassMolder molder,
java.lang.Object object,
OID depended) |
Update a new object in persistent storage and returns the object's OID.
|
void |
writeLock(java.lang.Object object,
int timeout) |
Acquire a write lock on the object.
|
void addTxSynchronizable(TxSynchronizable synchronizable)
synchronizable
- The TxSynchronizable implementation to register.void removeTxSynchronizable(TxSynchronizable synchronizable)
synchronizable
- The TxSynchronizable implementation to unregister.void setAutoStore(boolean autoStore)
autoStore
- When set to true
autoStore will be enabled.boolean isAutoStore()
true
if autoStore option is enabled.void setCallback(CallbackInterceptor callback)
The interceptor is a callback that notifies data objects on persistent state events.
If callback interceptor is not overriden, events will be sent to data object that implements the org.exolab.castor.jdo.Persistent interface.
callback
- The callback interceptor, disabled if null.void setInstanceFactory(InstanceFactory factory)
The factory is used to obatain a new instance of data object when it is needed during loading.
factory
- The instanceFactory to be used, disable if null.void setTransactionTimeout(int timeout)
timeout
- The timeout for this transaction in seconds.int getTransactionTimeout()
void setLockTimeout(int timeout)
timeout
- The timeout waiting to acquire a lock in seconds.int getLockTimeout()
void setStatus(int status)
status
- The status to set for this transaction.int getStatus()
void setWaitOnLock(ObjectLock lock)
ObjectLock
before entering the temporary lock-acquire state.lock
- The lock which this transaction attempts to acquireObjectLock getWaitOnLock()
java.sql.Connection getConnection(LockEngine engine) throws PersistenceException
engine
- The persistence engine.PersistenceException
- An error occured talking to the persistence engine.DbMetaInfo getConnectionInfo(LockEngine engine) throws PersistenceException
engine
- LockEngine instance used.PersistenceException
- An error occured talking to the persistence engine.java.lang.Object fetch(ClassMolder molder, Identity identity, AccessMode suggestedAccessMode) throws PersistenceException
PersistenceException
java.lang.Object load(Identity identity, ProposedEntity proposedObject, AccessMode suggestedAccessMode) throws PersistenceException
This method is similar to fetch(org.exolab.castor.persist.ClassMolder, org.exolab.castor.persist.spi.Identity, org.exolab.castor.mapping.AccessMode)
except that it will load the object
only once within a transaction and always return the same instance.
If the object is loaded for read-only then no lock is acquired and updates to the object are not reflected at commit time. If the object is loaded for read-write then a read lock is acquired (unless timeout or deadlock detected) and the object is stored at commit time. The object is then considered persistent and may be deleted or upgraded to write lock. If the object is loaded for exclusive access then a write lock is acquired and the object is synchronized with the persistent copy.
Attempting to load the object twice in the same transaction, once with exclusive lock and once with read-write lock will result in an exception.
identity
- The object's identity.proposedObject
- The object to fetch (single instance per transaction).suggestedAccessMode
- The access mode (see AccessMode
) the values
in persistent storage.PersistenceException
- Timeout or deadlock occured attempting to acquire
lock on object. The object was not found in persistent storage. An error
reported by the persistence engine.java.lang.Object load(Identity identity, ProposedEntity proposedObject, AccessMode suggestedAccessMode, QueryResults results) throws PersistenceException
In addition to load(Identity,ProposedEntity,AccessMode)
a QueryResults can be specified.
identity
- The object's identity.proposedObject
- The object to fetch (single instance per transaction).suggestedAccessMode
- The access mode (see AccessMode
) the values
in persistent storage.results
- The QueryResult that the data to be loaded from.PersistenceException
- Timeout or deadlock occured attempting to acquire
lock on object. The object was not found in persistent storage. An error
reported by the persistence engine.QueryResults query(LockEngine engine, PersistenceQuery query, AccessMode accessMode, boolean scrollable) throws PersistenceException
engine
- The persistence engine.query
- A query against the persistence engine.accessMode
- The access mode.scrollable
- The db cursor mode.PersistenceException
- An error reported by the persistence engine or
an invalid query.void markCreate(ClassMolder molder, java.lang.Object object, OID rootObjectOID) throws PersistenceException
molder
- The class persistence molder.object
- The object to persist.rootObjectOID
- The OID of the root object to start walking.PersistenceException
- An object with this identity already exists in
persistent storage. The class is not persistent capable. An error
reported by the persistence engine.void create(ClassMolder molder, java.lang.Object object, OID depended) throws PersistenceException
molder
- The molder of the creating class.object
- The object to persist.depended
- The master object's OID if exist.PersistenceException
- An object with this identity already exists in
persistent storage. The class is not persistent capable. An error
reported by the persistence engine.boolean markUpdate(ClassMolder molder, java.lang.Object object, OID depended) throws PersistenceException
Update will also mark objects to be created if the TIMESTAMP equals to NO_TIMESTAMP.
molder
- The object's molder.object
- The object to persist.depended
- The master objects of the specified object to be created if
exisit.PersistenceException
- An object with this identity already exists in
persistent storage. The class is not persistent capable. Dirty checking
mechanism may immediately report that the object was modified in the
database during the long transaction. An error reported by the
persistence engine.void update(ClassMolder molder, java.lang.Object object, OID depended) throws PersistenceException
Update will also mark objects to be created if the TIMESTAMP equals to NO_TIMESTAMP.
molder
- The object's molder.object
- The object to persist.depended
- The master objects of the specified object to be created if
exisit.PersistenceException
- An object with this identity already exists in
persistent storage. The class is not persistent capable. Dirty checking
mechanism may immediately report that the object was modified in the
database during the long transaction. An error reported by the persistence
engine.void delete(java.lang.Object object) throws PersistenceException
object
- The object to delete from persistent storage.PersistenceException
- The object has not been queried or created in this
transaction. Timeout or deadlock occured attempting to acquire lock on
object. An error reported by the persistence engine.void writeLock(java.lang.Object object, int timeout) throws PersistenceException
object
- The object to lock.timeout
- Timeout waiting to acquire lock, specified in seconds, zero
for no waiting, negative to use the default timeout for this transaction.PersistenceException
- The object has not been queried or created in this
transaction. Timeout or deadlock occured attempting to acquire lock on
object. An error reported by the persistence engine.void markModified(java.lang.Object object, boolean updatePersist, boolean updateCache)
boolean prepare() throws TransactionAbortedException
TransactionAbortedException
- The transaction has been aborted due to
inconsistency, duplicate object identity, error with the persistence
engine or any other reason.void commit() throws TransactionAbortedException
prepare()
has returned successfully. Throws an IllegalStateException
when called without calling prepare()
first.TransactionAbortedException
- The transaction has been aborted due to
inconsistency, duplicate object identity, error with the persistence
engine or any other reason.void rollback()
void close() throws TransactionAbortedException
TransactionAbortedException
- The transaction has been aborted due to
inconsistency, duplicate object identity, error with the persistence
engine or any other reason.java.util.Iterator iterateReadWriteObjectsInTransaction()
boolean isCreated(java.lang.Object object)
object
- The object to test the state of in this transaction.true
if the object is marked as created within this
transaction.boolean isUpdateCacheNeeded(java.lang.Object object)
object
- The object to test the state of in this transaction.true
if the object is recorded in this transaction with
the requested state.boolean isUpdatePersistNeeded(java.lang.Object object)
object
- The object to test the state of in this transaction.true
if the object is recorded in this transaction with
the requested state.boolean isPersistent(java.lang.Object object)
object
- The object.true
if persistent in transaction.boolean isRecorded(java.lang.Object object)
object
- The object to investigate.true
if recorded in this transaction.boolean isDepended(OID master, java.lang.Object dependent)
boolean isOpen()
true
if the transaction is open.boolean isDeleted(java.lang.Object object)
object
- The object to test the state of in this transaction.true
if the object is deleted.boolean isDeletedByOID(OID oid)
boolean isReadOnly(java.lang.Object object)
object
- The object to test for read-only statustrue
if the object is marked read-only in this transaction;
otherwise, false
.boolean isCached(ClassMolder molder, java.lang.Class cls, Identity identity) throws PersistenceException
PersistenceException
void expireCache(ClassMolder molder, Identity identity) throws PersistenceException
molder
- The class persistence molder.identity
- The object's identity.PersistenceException
- If identity is null or any problem that happens
during expiration of cache values.java.lang.ClassLoader getClassLoader()
null
if none
has been providedDatabase getDatabase()
boolean isLocked(java.lang.Class cls, Identity identity, LockEngine lockEngine)
cls
- Class instance of the object to be investigated.identity
- Identity of the object to be investigated.lockEngine
- Current LcokEngine instancejava.lang.String getNamedQuery(ClassMolder molder, java.lang.String name) throws QueryException
molder
- Specific class molder.name
- Name of the (named) query to create.QueryException
- If the named query can not be foundNamedNativeQuery getNamedNativeQuery(ClassMolder molder, java.lang.String name) throws QueryException
molder
- Specific class molder.name
- Name of the (named) query to create.QueryException
- If the named query can not be found.Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com