001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.transaction.participant;
020
021import org.jpos.core.Configurable;
022import org.jpos.core.Configuration;
023import org.jpos.transaction.AbortParticipant;
024import org.jpos.transaction.Context;
025
026import java.io.Serializable;
027
028/**
029 * Diagnostic transaction participant that records a configurable trace label
030 * at each lifecycle phase via {@link Context#checkPoint(String)}.
031 */
032public class Trace implements AbortParticipant, Configurable {
033    /** Creates the participant; configuration is supplied via {@link #setConfiguration(Configuration)}. */
034    public Trace() {}
035    String trace;
036    public int prepare (long id, Serializable o) {
037        Context ctx = (Context) o;
038        ctx.checkPoint ("prepare:" + trace);
039        return PREPARED | READONLY;
040    }
041    public void commit (long id, Serializable o) { 
042        Context ctx = (Context) o;
043        ctx.checkPoint ("commit:" + trace);
044    }
045    public void abort  (long id, Serializable o) { 
046        Context ctx = (Context) o;
047        ctx.checkPoint ("abort:" + trace);
048    }
049    public int prepareForAbort (long id, Serializable o) { 
050        Context ctx = (Context) o;
051        ctx.checkPoint ("prepareForAbort:" + trace);
052        return PREPARED | READONLY;
053    }
054    public void setConfiguration (Configuration cfg) {
055        this.trace = cfg.get ("trace", this.getClass().getName());
056    }
057}
058