/*
* JBoss, Home of Professional Open Source.
* Copyright 2013, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.test.xts.wsat.service;
import com.arjuna.wst.Aborted;
import com.arjuna.wst.Durable2PCParticipant;
import com.arjuna.wst.ReadOnly;
import com.arjuna.wst.SystemException;
import com.arjuna.wst.Vote;
import com.arjuna.wst.WrongStateException;
import com.arjuna.wst.Prepared;
import org.jboss.as.test.xts.util.EventLog;
import org.jboss.as.test.xts.util.EventLogEvent;
import org.jboss.as.test.xts.util.ServiceCommand;
import org.jboss.logging.Logger;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A WS-T Atomic Transaction durable participant.
*/
public class ATDurableParticipant implements Durable2PCParticipant, Serializable {
private static final Logger log = Logger.getLogger(ATDurableParticipant.class);
private static final long serialVersionUID = 1L;
// Is participant already enlisted to transaction?
private static Map<String, List<ATDurableParticipant>> activeParticipants = new HashMap<String, List<ATDurableParticipant>>();
private String transactionId;
private String eventLogName;
// Service command which define behaving of the participant
private ServiceCommand[] serviceCommands;
// Where to log participant activity
private EventLog eventLog;
/**
* Creates a new participant for this transaction. Participants and transaction instances have a one-to-one mapping.
*
* @param serviceCommands service commands for interrupting of the processing
* @param eventLogName name for event log - differentiate calls on the same web service/creating participant
* @param eventLog event log that info about processing will be put into
* @param transactionId transaction id works for logging active participants
*/
public ATDurableParticipant(ServiceCommand[] serviceCommands, String eventLogName, EventLog eventLog, String transactionId) {
this.serviceCommands = serviceCommands;
this.eventLog = eventLog;
this.eventLogName = eventLogName;
addParticipant(transactionId);
}
/**
* Invokes the volatile prepare step of the business logic.
*
* @return in dependence of command passed to constructor @see{ServiceCommand}
* @throws com.arjuna.wst.WrongStateException
* @throws com.arjuna.wst.SystemException
*/
@Override
// TODO: added option for System Exception would be thrown?
public Vote prepare() throws WrongStateException, SystemException {
eventLog.addEvent(eventLogName, EventLogEvent.PREPARE);
log.infof("[AT SERVICE] Durable participant prepare() - logged: %s", EventLogEvent.PREPARE);
if(ServiceCommand.isPresent(ServiceCommand.VOTE_ROLLBACK, serviceCommands)) {
log.trace("[AT SERVICE] Durable participant prepare(): " + Aborted.class.getSimpleName());
return new Aborted();
} else if(ServiceCommand.isPresent(ServiceCommand.VOTE_READONLY_DURABLE, serviceCommands)) {
log.trace("[AT SERVICE] Durable participant prepare(): " + ReadOnly.class.getSimpleName());
return new ReadOnly();
} else {
log.trace("[AT SERVICE] Durable participant prepare(): " + Prepared.class.getSimpleName());
return new Prepared();
}
}
/**
* Invokes the volatile commit step of the business logic.
* All participants voted 'prepared', so coordinator tells the volatile participant that commit has been done.
*
* @throws com.arjuna.wst.WrongStateException
* @throws com.arjuna.wst.SystemException
*/
@Override
public void commit() throws WrongStateException, SystemException {
eventLog.addEvent(eventLogName, EventLogEvent.COMMIT);
log.trace("[AT SERVICE] Durable participant commit() - logged: " + EventLogEvent.COMMIT);
activeParticipants.remove(transactionId);
}
/**
* Invokes the volatile rollback operation on the business logic.
* One or more participants voted 'aborted' or a failure occurred, so coordinator tells the volatile participant that rollback has been done.
*
* @throws com.arjuna.wst.WrongStateException
* @throws com.arjuna.wst.SystemException
*/
@Override
public void rollback() throws WrongStateException, SystemException {
eventLog.addEvent(eventLogName, EventLogEvent.ROLLBACK);
log.trace("[AT SERVICE] Durable participant rollback() - logged: " + EventLogEvent.ROLLBACK);
activeParticipants.remove(transactionId);
}
@SuppressWarnings("deprecation")
@Override
public void unknown() throws SystemException {
eventLog.addEvent(eventLogName, EventLogEvent.UNKNOWN);
log.trace("[AT SERVICE] Durable participant unknown() - logged: " + EventLogEvent.UNKNOWN);
}
/**
* This should not happen for volatile participant.
*/
@Override
public void error() throws SystemException {
eventLog.addEvent(eventLogName, EventLogEvent.ERROR);
log.trace("[AT SERVICE] Durable participant error() - logged: " + EventLogEvent.ERROR);
}
// --- helper methods ---
private void addParticipant(String transactionId) {
if(activeParticipants.containsKey(transactionId)) {
if(activeParticipants.get(transactionId).contains(this)) {
throw new RuntimeException(this.getClass().getName() + " can't be enlisted to transaction " + transactionId + " because it already is enlisted.");
}
activeParticipants.get(transactionId).add(this);
} else {
List<ATDurableParticipant> participants = new ArrayList<ATDurableParticipant>();
participants.add(this);
activeParticipants.put(transactionId, participants);
}
}
}