1 /*
2 * Copyright 2006-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.mybatis.generator.api;
17
18 import java.sql.Connection;
19 import java.sql.SQLException;
20 import java.util.Properties;
21
22 public interface ConnectionFactory {
23
24 /**
25 * Should return a connection to the database in use for this context.
26 * The generator will call this method only one time for each context.
27 * The generator will close the connection.
28 *
29 * @return the connection
30 *
31 * @throws SQLException
32 * if there is some error obtaining the connection
33 */
34 Connection getConnection() throws SQLException;
35
36 /**
37 * Adds properties for this instance from any properties configured in the
38 * ConnectionFactory.
39 *
40 * <p>This method will be called before any of the get methods.
41 *
42 * @param properties
43 * All properties from the configuration
44 */
45 void addConfigurationProperties(Properties properties);
46 }