com.atomikos.datasource

Interface RecoverableResource

All Known Subinterfaces:

TransactionalResource

public interface RecoverableResource

A Recoverable Resource is the abstraction of a resource that supports recoverable work (i.e., that supports Participant instances). A recoverable resource is invoked at recovery time by the transaction core.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the resource for shutdown.
String	getName() Gets the name of the resource.
boolean	hasPendingParticipantsFromLastRecoveryScan()
boolean	isClosed() Tests if the resource is closed.
boolean	isSameRM(RecoverableResource res) Tests if a resource is the same as another one.
boolean	recover(long startOfRecoveryScan, Collection<PendingTransactionRecord> expiredCommittingCoordinators, Collection<PendingTransactionRecord> indoubtForeignCoordinatorsToKeep) Instructs the resource to recover.
void	setRecoveryService(RecoveryService recoveryService) Initializes this resource with the recovery service.

Method Detail

setRecoveryService

void setRecoveryService(RecoveryService recoveryService)
                 throws ResourceException

Initializes this resource with the recovery service. This method is called by the transaction service during intialization of the transaction service or when the resource is added, whichever comes last. If the resource wants to recover, it should subsequently ask the recoveryService to do so.

Parameters:

recoveryService - The recovery service. This instance can be used by the resource to ask recovery from the transaction engine.

Throws:

ResourceException - On errors.

close

void close()
    throws ResourceException

Closes the resource for shutdown. This notifies the resource that it is no longer needed.

Throws:

ResourceException

getName

String getName()

Gets the name of the resource. Names should be unique within one TM domain.

Returns:

String The name.

isSameRM

boolean isSameRM(RecoverableResource res)
          throws ResourceException

Tests if a resource is the same as another one.

Throws:

ResourceException

isClosed

boolean isClosed()

Tests if the resource is closed.

Returns:

boolean True if the resource is closed.

recover

boolean recover(long startOfRecoveryScan,
                Collection<PendingTransactionRecord> expiredCommittingCoordinators,
                Collection<PendingTransactionRecord> indoubtForeignCoordinatorsToKeep)

Instructs the resource to recover. The following summarizes the expected behavior of the resource concerning its participant state:

		IN_DOUBT participant	IN_DOUBT participant expired by max_timeout
1	No PendingTransactionRecord for coordinator	Wait for COMMITTING record	Do presumed abort
2	Expired COMMITTING PendingTransactionRecord for coordinator	Replay commit
3	Foreign IN_DOUBT PendingTransactionRecord for coordinator	Wait for remote recovery to resolve into 1 or 2 at a later invocation

Parameters:

startOfRecoveryScan -

expiredCommittingCoordinators -

indoubtForeignCoordinatorsToKeep -

Returns:

True if this resource has no more participants for the supplied expiredCommittingCoordinators.

hasPendingParticipantsFromLastRecoveryScan

boolean hasPendingParticipantsFromLastRecoveryScan()

Returns:

True if this resource has pending participants from the last recovery scan.