/*
 * The contents of this file are subject to the terms 
 * of the Common Development and Distribution License 
 * (the License).  You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the license at 
 * https://glassfish.dev.java.net/public/CDDLv1.0.html or
 * glassfish/bootstrap/legal/CDDLv1.0.txt.
 * See the License for the specific language governing 
 * permissions and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL 
 * Header Notice in each file and include the License file 
 * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
 * If applicable, add the following below the CDDL Header, 
 * with the fields enclosed by brackets [] replaced by
 * you own identifying information: 
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
 */

/*
 * Copyright 2004-2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

 package com.sun.jts.jta;
 
 import javax.transaction.xa.*;

 /**
  * This interface extends JTA XAResource interface and defines
  * new methods for thread association support and resource
  * initialization.
  */

public interface NativeXAResource extends XAResource {

    // added functionality for thread management

    /**
     *  Opens the RM for the calling thread (xa_open).
     */
     public void open() throws XAException;

    /**
     *  Closes the RM for the calling thread (xa_close).
     */
    public void close() throws XAException;

    /**
     * checks if the thread has opened (xa_open) the RM atleast once.
     *
     * @param thread the thread to be checked for resource initialization.
     *
     * @return true if the thread has opened the resource (RM) atleast once.
     */
    public boolean isInitialized(Thread thread);

    /**
     * enlist the JDBC connection in XA (needed to support MSSQLServer)
     * this should be called once per connection per transaction
     */
    public void enlistConnectionInXA();
}
