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.transaction.AbortParticipant;
022import org.jpos.transaction.Context;
023import org.jpos.util.FrozenLogEvent;
024import org.jpos.util.Log;
025import org.jpos.util.LogEvent;
026import org.jpos.util.Logger;
027
028import java.io.Serializable;
029
030/**
031 * Diagnostic transaction participant that logs the {@link Context} at every
032 * lifecycle phase, useful for tracing TM behaviour during development.
033 */
034public class Debug extends Log implements AbortParticipant {
035    /** Default constructor; no instance state to initialise. */
036    public Debug() {}
037    public int prepare (long id, Serializable o) {
038        if (o instanceof Context ctx) {
039            ctx.log("Debug::prepare");
040        }
041        Logger.log (createEvent ("prepare", id, (Context) o));
042        return PREPARED | READONLY;
043    }
044    public void commit (long id, Serializable o) { 
045        Logger.log (createEvent ("commit", id, (Context) o));
046    }
047    public void abort  (long id, Serializable o) { 
048        Logger.log (createEvent ("abort", id, (Context) o));
049    }
050    public int prepareForAbort (long id, Serializable o) { 
051        Logger.log (createEvent ("prepare-for-abort", id, (Context) o));
052        return PREPARED | READONLY;
053    }
054    private LogEvent createEvent (String action, long id, Context ctx) {
055        LogEvent evt = createLogEvent (action);
056        evt.addMessage ("<id>" + id + "</id>");
057        evt.addMessage (ctx);
058        return new FrozenLogEvent(evt);
059    }
060}