TxAssociation.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2006, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. 
 * See the copyright.txt in the distribution for a full listing 
 * of individual contributors.
 * This copyrighted material is made available to anyone wishing to use,
 * modify, copy, or redistribute it subject to the terms and conditions
 * of the GNU Lesser General Public License, v. 2.1.
 * This program is distributed in the hope that it will be useful, but WITHOUT A
 * 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,
 * v.2.1 along with this distribution; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301, USA.
 * 
 * (C) 2005-2006,
 * @author JBoss Inc.
 */
/*
 * Copyright (C) 2001, 2002,
 *
 * Hewlett-Packard Arjuna Labs,
 * Newcastle upon Tyne,
 * Tyne and Wear,
 * UK.
 *
 * $Id: TxAssociation.java 2342 2006-03-30 13:06:17Z  $
 */

package com.arjuna.ats.jts.extensions;

import org.omg.CORBA.SystemException;

import com.arjuna.ats.internal.jts.ControlWrapper;

/**
 * Instances of these classes are informed whenever a
 * transaction is begun/suspended/resumed/ended.
 * The instance can control whether it wants to be informed
 * about all transactions, or just subtransactions.
 *
 * @author Mark Little (mark_little@hp.com)
 * @version $Id: TxAssociation.java 2342 2006-03-30 13:06:17Z  $
 * @since JTS 2.0.
 */

public interface TxAssociation
{
 
    /*
     * Since one instance could mark the transaction as rollback
     * we could inform subsequent instances. We don't at present.
     */

    public void begin (ControlWrapper tx) throws SystemException;
    public void commit (ControlWrapper tx) throws SystemException;
    public void rollback (ControlWrapper tx) throws SystemException;
    public void suspend (ControlWrapper tx) throws SystemException;
    public void resume (ControlWrapper tx) throws SystemException;

    public String name ();
 
    /*
     * We could impose some ordering constraints
     * on instances, such that users have the capability
     * of specifying how they are invoked, e.g., A before
     * B. It would affect performance of adding, but if
     * that does not happen frequently it probably doesn't
     * matter.
     */
 
}