1 /*
2 * Copyright 2009-2023 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 * https://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 *
35 * @param props
36 * the new properties
37 */
38 default void setProperties(Properties props) {
39 // NOP
40 }
41
42 /**
43 * Creates a {@link Transaction} out of an existing connection.
44 *
45 * @param conn
46 * Existing database connection
47 *
48 * @return Transaction
49 *
50 * @since 3.1.0
51 */
52 Transaction newTransaction(Connection conn);
53
54 /**
55 * Creates a {@link Transaction} out of a datasource.
56 *
57 * @param dataSource
58 * DataSource to take the connection from
59 * @param level
60 * Desired isolation level
61 * @param autoCommit
62 * Desired autocommit
63 *
64 * @return Transaction
65 *
66 * @since 3.1.0
67 */
68 Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
69
70 }