JTAUserTransactionLifecycleService.java

/*
 * JBoss, a division of Red Hat
 * Copyright 2012, Red Hat Middleware, LLC, and individual
 * contributors as indicated by the @authors tag. See the
 * copyright.txt 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.gatein.common.transaction;

import javax.transaction.UserTransaction;


/**
 * Service provides methods for managing lifecycle of JTA transaction
 *
 * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
 */
public interface JTAUserTransactionLifecycleService {

    /**
     * @return instance of UserTransaction
     */
    UserTransaction getUserTransaction();

    /**
     * Commit or Rollback JTA transaction according to it's current status
     */
    void finishJTATransaction();

    /**
     * Starts JTA transaction if not already started
     */
    void beginJTATransaction();

    /**
     * Register listener to perform some operations during transaction lifecycle
     *
     * @param listener to be registered
     */
    void registerListener(JTAUserTransactionLifecycleListener listener);
}