/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tomcat.dbcp.dbcp2.managed;

import java.sql.Connection;
import java.sql.SQLException;

import org.apache.tomcat.dbcp.dbcp2.ConnectionFactory;

/**
 * XAConnectionFactory is an extension of ConnectionFactory used to create connections in a transaction managed
 * environment. The XAConnectionFactory operates like a normal ConnectionFactory except a TransactionRegistry is
 * provided from which the XAResource for a connection can be obtained. This allows the existing DBCP pool code to work
 * with XAConnections and gives the ManagedConnection a way to enlist a connection in the transaction.
 *
 * @since 2.0
 */
public interface XAConnectionFactory extends ConnectionFactory {

    /**
     * Creates a new {@link Connection} in an implementation specific fashion.
     * <p>
     * An implementation can assume that the caller of this will wrap the connection in a proxy that protects access to
     * the setAutoCommit, commit and rollback when enrolled in a XA transaction.
     * </p>
     *
     * @return a new {@link Connection}
     * @throws SQLException if a database error occurs creating the connection
     */
    @Override
    Connection createConnection() throws SQLException;

    /**
     * Gets the TransactionRegistry for this connection factory which contains the XAResource for every connection
     * created by this factory.
     *
     * @return the transaction registry for this connection factory
     */
    TransactionRegistry getTransactionRegistry();
}
