/*
* Copyright 2000-2008, Atomikos (http://www.atomikos.com)
*
* This code ("Atomikos TransactionsEssentials"), by itself,
* is being distributed under the
* Apache License, Version 2.0 ("License"), a copy of which may be found at
* http://www.atomikos.com/licenses/apache-license-2.0.txt .
* You may not use this file except in compliance with the License.
*
* While the License grants certain patent license rights,
* those patent license rights only extend to the use of
* Atomikos TransactionsEssentials by itself.
*
* This code (Atomikos TransactionsEssentials) contains certain interfaces
* in package (namespace) com.atomikos.icatch
* (including com.atomikos.icatch.Participant) which, if implemented, may
* infringe one or more patents held by Atomikos.
* It should be appreciated that you may NOT implement such interfaces;
* licensing to implement these interfaces must be obtained separately from Atomikos.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
package com.atomikos.icatch.imp;
import com.atomikos.icatch.HeurCommitException;
import com.atomikos.icatch.HeurHazardException;
import com.atomikos.icatch.HeurMixedException;
import com.atomikos.icatch.HeurRollbackException;
import com.atomikos.icatch.HeuristicMessage;
import com.atomikos.icatch.Participant;
import com.atomikos.icatch.RollbackException;
import com.atomikos.icatch.StringHeuristicMessage;
import com.atomikos.icatch.SysException;
/**
*
*
* A participant to add in case setRollbackOnly is called. This participant will
* never allow commit.
*/
public class RollbackOnlyParticipant implements Participant
{
private StringHeuristicMessage msg_;
// the message to return in exception
public RollbackOnlyParticipant ( StringHeuristicMessage msg )
{
msg_ = msg;
}
/**
* @see Participant
*/
public boolean recover () throws SysException
{
// by default: does nothing
return true;
}
/**
* @see Participant
*/
public void setCascadeList ( java.util.Dictionary allParticipants )
throws SysException
{
// nothing by default
}
/**
* @see Participant
*/
public void setGlobalSiblingCount ( int count )
{
// default does nothing
}
/**
* @see Participant
*/
public int prepare () throws RollbackException, HeurHazardException,
HeurMixedException, SysException
{
// prepare MUST fail: rollback only!
throw new RollbackException ( msg_.toString () );
}
/**
* @see Participant
*/
public HeuristicMessage[] commit ( boolean onePhase )
throws HeurRollbackException, HeurHazardException,
HeurMixedException, RollbackException, SysException
{
// if onePhase then this method will be called;
// make sure rollback is indicated.
throw new RollbackException ( msg_.toString () );
}
/**
* @see Participant
*/
public HeuristicMessage[] rollback () throws HeurCommitException,
HeurMixedException, HeurHazardException, SysException
{
return getHeuristicMessages ();
}
/**
* @see Participant
*/
public void forget ()
{
// nothing to do
}
/**
* @see Participant
*/
public HeuristicMessage[] getHeuristicMessages ()
{
HeuristicMessage[] ret = new HeuristicMessage[1];
ret[0] = msg_;
return ret;
}
/**
* @see com.atomikos.icatch.Participant#getURI()
*/
public String getURI ()
{
return null;
}
}