com.atomikos.icatch

Class Extent

java.lang.Object

com.atomikos.icatch.Extent

public class Extent
extends java.lang.Object

The extent carries the information about the 'size' of a propagation after it returns: the directly and indirectly invoked servers, and the orphan detection information for those. This interface is a system interface; it should not be handled by application level code (besides shipping it around via toString()). This class (and its parsing) represent the minimum information required for transactions to work across remoting calls. All values are required. In addition, we are liberal in parsing: any additional, unknown values are ignored - so future releases can add extra, optional properties and still work with installations of this release.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION Major version indicator.

Constructor Summary

Constructors

Constructor and Description
Extent()
Extent(java.lang.String parentTransactionId)

Method Summary

Modifier and Type	Method and Description
void	add(Extent extent) Merges another extent into this one.
void	add(Participant participant, int count) Adds a participant to the extent.
void	addRemoteParticipants(java.util.Map<java.lang.String,java.lang.Integer> participants)
java.lang.String	getParentTransactionId()
java.util.Stack<Participant>	getParticipants()
java.util.Map<java.lang.String,java.lang.Integer>	getRemoteParticipants()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

Major version indicator. Only change this for future releases that add incompatible changes such as adding/removing required properties and/or changing the semantics of existing properties. As long as optional properties are added/removed, the version can stay the same.

See Also:

Constant Field Values

Constructor Detail

Extent

public Extent()

Extent

public Extent(java.lang.String parentTransactionId)

Method Detail

getParentTransactionId

public java.lang.String getParentTransactionId()

addRemoteParticipants

public void addRemoteParticipants(java.util.Map<java.lang.String,java.lang.Integer> participants)
                           throws java.lang.IllegalStateException,
                                  SysException

Throws:

java.lang.IllegalStateException

SysException

getRemoteParticipants

public java.util.Map<java.lang.String,java.lang.Integer> getRemoteParticipants()

Returns:

Map Mapping URIs of remote participants (directly or indirectly invoked) to Integer counts that represent the number of invocations detected by each participant.

getParticipants

public java.util.Stack<Participant> getParticipants()

Returns:

Stack A stack of direct participants. Direct participants are those that need to be added to the client TM's two-phase commit set. NOTE: If a participant occurs in the direct participant set, it will also be part of the remote set.

add

public void add(Participant participant,
                int count)
         throws SysException,
                java.lang.IllegalStateException

Adds a participant to the extent. This method is called at the server side, in order to add the work done to the two-phase commit set of the calling (client) side, as well as to make sure that orphan information is propagated through the system.

Parameters:

participant - This instance will be added to the indirect as well as to the direct participant set.

count - The number of invocations detected by the adding client.

Throws:

java.lang.IllegalStateException - If no longer allowed.

SysException

add

public void add(Extent extent)
         throws java.lang.IllegalStateException,
                SysException

Merges another extent into this one.

Parameters:

extent - The extent to add.

Throws:

java.lang.IllegalStateException - If no longer allowed.

SysException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object