/*
 * Copyright (C) 2003-2007 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see<http://www.gnu.org/licenses/>.
 */
package org.exoplatform.services.transaction;

import javax.transaction.RollbackException;
import javax.transaction.SystemException;
import javax.transaction.TransactionManager;
import javax.transaction.UserTransaction;
import javax.transaction.xa.Xid;

/**
 * Created by The eXo Platform SAS.<br/> The transaction service
 * 
 * @author <a href="mailto:gennady.azarenkov@exoplatform.com">Gennady
 *         Azarenkov</a>
 * @version $Id: $
 */

public interface TransactionService {

  /**
   * @return TransactionManager
   */
  TransactionManager getTransactionManager();

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

  /**
   * @return default timeout in seconds
   */
  int getDefaultTimeout();

  /**
   * sets timeout in seconds
   * 
   * @param seconds
   * @throws SystemException
   */
  void setTransactionTimeout(int seconds) throws SystemException;

  /**
   * enlists XA resource in transaction manager
   * 
   * @param xares XAResource
   * @throws RollbackException
   * @throws SystemException
   */
  void enlistResource(ExoResource xares) throws RollbackException, SystemException;

  /**
   * delists XA resource from transaction manager
   * 
   * @param xares XAResource
   * @throws RollbackException
   * @throws SystemException
   */
  void delistResource(ExoResource xares) throws RollbackException, SystemException;

  /**
   * creates unique XA transaction identifier
   * 
   * @return Xid
   */
  Xid createXid();

}