org.jboss.forge.addon.resource.transaction

Interface ResourceTransaction

public interface ResourceTransaction

A ResourceTransaction manages changes to a group of Resource

Author:

George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() Starts a transaction.
void	commit() Applies every change in the Set returned by getChangeSet()
Set<ResourceEvent>	getChangeSet() The changes associated with this transaction.
int	getTransactionTimeout() Get the the duration in seconds after which this ResourceTransaction will time out and be automatically rolled back.
boolean	isStarted() Returns true if this transaction is started and was not already committed/rolled back
void	rollback() Discards this transaction and the associated changes with it
void	setTransactionTimeout(int seconds) Set the the duration in seconds after which this ResourceTransaction will time out and be automatically rolled back.

Method Detail

begin

void begin()
           throws ResourceTransactionException

Starts a transaction. Throws ResourceTransactionException if the transaction is already started

Throws:

ResourceTransactionException

commit

void commit()
            throws ResourceTransactionException

Applies every change in the Set returned by getChangeSet()

Throws:

ResourceTransactionException

rollback

void rollback()
              throws ResourceTransactionException

Discards this transaction and the associated changes with it

Throws:

ResourceTransactionException

isStarted

boolean isStarted()

Returns true if this transaction is started and was not already committed/rolled back

setTransactionTimeout

void setTransactionTimeout(int seconds)

Set the the duration in seconds after which this ResourceTransaction will time out and be automatically rolled back. (Timeout starts when begin() is called.) If an application has not called this method, the transaction service uses a default value for the transaction timeout.

Parameters:

seconds - The value of the timeout in seconds. If the value is zero, the transaction service restores the default value. If the value is negative a ResourceTransactionException is thrown.

getTransactionTimeout

int getTransactionTimeout()

Get the the duration in seconds after which this ResourceTransaction will time out and be automatically rolled back. If the value returned is zero, the system is using a default timeout value. (Timeout starts when begin() is called.)

getChangeSet

Set<ResourceEvent> getChangeSet()

The changes associated with this transaction.

Returns:

an immutable Set with the changes that were introduced so far