Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.atomikos.icatch.imp
Class RollbackOnlyParticipant

    java.lang.Object
      com.atomikos.icatch.imp.RollbackOnlyParticipant

All Implemented Interfaces:
  Participant, Serializable

    public class RollbackOnlyParticipant

extends Object
implements Participant

A participant to add in case setRollbackOnly is called. This participant will never allow commit.

See Also:
  Serialized Form

Field Summary

Fields inherited from interface com.atomikos.icatch.Participant
`READ_ONLY`

Constructor Summary
`RollbackOnlyParticipant(StringHeuristicMessage msg)`

Method Summary
`HeuristicMessage[]` | `commit(boolean onePhase)` Commits the participant's work.
`void` | `forget()` Indicates that a heuristic participant can forget about its work.
`HeuristicMessage[]` | `getHeuristicMessages()`
`String` | `getURI()`
`int` | `prepare()` Prepares the participant.
`boolean` | `recover()` Called by the transaction manager (TM) at recovery time, and this should reconstruct the internal state.
`HeuristicMessage[]` | `rollback()` Rollback of the participant's work.
`void` | `setCascadeList(Dictionary allParticipants)` For cascading 2PC, this method sets the information needed to cascade.
`void` | `setGlobalSiblingCount(int count)` Set by the root coordinator: the total no of siblings detected.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### RollbackOnlyParticipant

    public RollbackOnlyParticipant(StringHeuristicMessage msg)

Method Detail

### recover

    public boolean recover()
                    throws SysException

  Description copied from interface: `Participant`
  Called by the transaction manager (TM) at recovery time, and this should reconstruct the internal state.

  Specified by:
    `recover` in interface `Participant`
  Returns:
    boolean False if the instance could not be recovered. It is up to the transaction manager to determine the severity of this case.
  Throws:
    `SysException`
  See Also:
    `Participant`

### setCascadeList

    public void setCascadeList(Dictionary allParticipants)
                        throws SysException

  Description copied from interface: `Participant`
  For cascading 2PC, this method sets the information needed to cascade. This method is relevant only for transaction monitors; leave empty otherwise!

  Specified by:
    `setCascadeList` in interface `Participant`
  Parameters:
    `allParticipants` - The information needed by the transaction monitor.
  Throws:
    `SysException`
  See Also:
    `Participant`

### setGlobalSiblingCount

    public void setGlobalSiblingCount(int count)

  Description copied from interface: `Participant`
  Set by the root coordinator: the total no of siblings detected. This method is relevant only for transaction monitors; leave empty otherwise!

  Specified by:
    `setGlobalSiblingCount` in interface `Participant`
  Parameters:
    `count` - The global count.
  See Also:
    `Participant`

### prepare

    public int prepare()
                throws RollbackException,
                       HeurHazardException,
                       HeurMixedException,
                       SysException

  Description copied from interface: `Participant`
  Prepares the participant. Any locks for this participant's work should be recoverable (either saved to an external file OR be part of the instance's non-transient state so that they can be flushed into the transaction manager's log).

  Specified by:
    `prepare` in interface `Participant`
  Returns:
    int READ_ONLY if no second round is needed. Participants that return this value on prepare will not be called by commit or rollback afterwards.
  Throws:
    `RollbackException` - For a NO vote. This indicates that the participant has already rolled back (or marked for rollback) the work on behalf of this participant.
    `HeurHazardException` - On possible conflicts. This happens for remote participants instances, in case of communication failures.
    `HeurMixedException` - If some subordinate participants voted YES, timed out and committed heuristically whereas afterwards some NO votes where received.
    `SysException`
  See Also:
    `Participant`

### commit

    public HeuristicMessage[] commit(boolean onePhase)
                              throws HeurRollbackException,
                                     HeurHazardException,
                                     HeurMixedException,
                                     RollbackException,
                                     SysException

  Description copied from interface: `Participant`
  Commits the participant's work. NOTE: custom participant implementations should preferably be made for the server's local VM (e.g., it is better not to do this over RMI). Also, they should rely on the transaction manager for heuristic timeout (and NOT decide to terminate heuristically themselves). In that case, implementations never need to throw any of the heuristic exceptions of this method.

  Specified by:
    `commit` in interface `Participant`
  Parameters:
    `onePhase` - If true, one-phase commit is being started. If the participant has received a prepare call earlier, then it should throw a SysException here.
  Returns:
    HeuristicMessage[] An array of messages, null if none.
  Throws:
    `HeurHazardException` - On possible conflicts.
    `RollbackException` - In case of one-phase commit, and the transaction has been rolled back at the time commit is called.
    `SysException`
    `HeurRollbackException`
    `HeurMixedException`
  See Also:
    `Participant`

### rollback

    public HeuristicMessage[] rollback()
                                throws HeurCommitException,
                                       HeurMixedException,
                                       HeurHazardException,
                                       SysException

  Description copied from interface: `Participant`
  Rollback of the participant's work. NOTE: custom participant implementations should preferably be made for the server's local VM (e.g., it is better not to do this over RMI). Also, they should rely on the icatch transaction manager for heuristic timeout (and NOT decide to terminate heuristically themselves). In that case, implementations never need to throw any of the heuristic exceptions of this method.

  Specified by:
    `rollback` in interface `Participant`
  Returns:
    HeuristicMessage[] An array of messages, null if none.
  Throws:
    `HeurCommitException` - If the participant committed.
    `HeurMixedException` - If part of the work was rolled back.
    `HeurHazardException` - If the participant's final state is unsure.
    `SysException`
  See Also:
    `Participant`

### forget

    public void forget()

  Description copied from interface: `Participant`
  Indicates that a heuristic participant can forget about its work. If implementations rely on the transaction manager to decide when to do heuristics (rather then deciding in the participant implementation), then leave this method empty.

  Specified by:
    `forget` in interface `Participant`
  See Also:
    `Participant`

### getHeuristicMessages

    public HeuristicMessage[] getHeuristicMessages()

  Specified by:
    `getHeuristicMessages` in interface `Participant`
  Returns:
    HeuristicMessage[] An array of heuristic messages, or null if none.
  See Also:
    `Participant`

### getURI

    public String getURI()

  Specified by:
    `getURI` in interface `Participant`
  Returns:
    String The unique URI for this remote participant, or null for local instances.
  See Also:
    `Participant.getURI()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2012. All Rights Reserved.