View Javadoc
1   /*
2    *    Copyright 2009-2021 the original author or authors.
3    *
4    *    Licensed under the Apache License, Version 2.0 (the "License");
5    *    you may not use this file except in compliance with the License.
6    *    You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *    Unless required by applicable law or agreed to in writing, software
11   *    distributed under the License is distributed on an "AS IS" BASIS,
12   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *    See the License for the specific language governing permissions and
14   *    limitations under the License.
15   */
16  package org.apache.ibatis.transaction;
17  
18  import java.sql.Connection;
19  import java.util.Properties;
20  
21  import javax.sql.DataSource;
22  
23  import org.apache.ibatis.session.TransactionIsolationLevel;
24  
25  /**
26   * Creates {@link Transaction} instances.
27   *
28   * @author Clinton Begin
29   */
30  public interface TransactionFactory {
31  
32    /**
33     * Sets transaction factory custom properties.
34     * @param props
35     *          the new properties
36     */
37    default void setProperties(Properties props) {
38      // NOP
39    }
40  
41    /**
42     * Creates a {@link Transaction} out of an existing connection.
43     * @param conn Existing database connection
44     * @return Transaction
45     * @since 3.1.0
46     */
47    Transaction newTransaction(Connection conn);
48  
49    /**
50     * Creates a {@link Transaction} out of a datasource.
51     * @param dataSource DataSource to take the connection from
52     * @param level Desired isolation level
53     * @param autoCommit Desired autocommit
54     * @return Transaction
55     * @since 3.1.0
56     */
57    Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
58  
59  }