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;
020
021import java.io.Serializable;
022
023/**
024 * 2 phase commit participant
025 * @author apr
026 * @since 1.4.7
027 */
028public interface TransactionParticipant extends TransactionConstants {
029    /**
030     * Called by TransactionManager in preparation for a transaction
031     * @param id the Transaction identifier
032     * @param context transaction context
033     * @return PREPARED or ABORTED (| NO_JOIN | READONLY)
034     */
035    int  prepare(long id, Serializable context);
036
037    /**
038     * Called by TransactionManager upon transaction commit.
039     * Warning: implementation should be able to handle multiple calls
040     * with the same transaction id (rare crash recovery)
041     *
042     * @param id the Transaction identifier
043     * @param context transaction context
044     */
045    default void commit(long id, Serializable context) { }
046
047    /**
048     * Called by TransactionManager upon transaction commit.
049     * Warning: implementation should be able to handle multiple calls
050     * with the same transaction id (rare crash recovery)
051     *
052     * @param id the Transaction identifier
053     * @param context transaction context
054     */
055    default void abort(long id, Serializable context) { }
056}