1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.dbcp2.datasources;
19
20 import java.sql.SQLException;
21
22 import javax.sql.PooledConnection;
23
24 /**
25 * Methods to manage PoolableConnections and the connection pools that source them.
26 *
27 * @since 2.0
28 */
29 interface PooledConnectionManager {
30
31 /**
32 * Closes the connection pool associated with the given user.
33 *
34 * @param userName
35 * user name.
36 * @throws SQLException
37 * if an error occurs closing idle connections in the pool.
38 */
39 void closePool(String userName) throws SQLException;
40
41 /**
42 * Closes the PooledConnection and remove it from the connection pool to which it belongs, adjusting pool counters.
43 *
44 * @param pc
45 * PooledConnection to be invalidated.
46 * @throws SQLException
47 * if an SQL error occurs closing the connection.
48 */
49 void invalidate(PooledConnection pc) throws SQLException;
50
51 /**
52 * Sets the database password used when creating connections.
53 *
54 * @param password password used when authenticating to the database.
55 * @since 2.14.0
56 */
57 default void setPassword(final char[] password) {
58 setPassword(String.copyValueOf(password));
59 }
60
61 /**
62 * Sets the database password used when creating connections.
63 *
64 * @param password
65 * password used when authenticating to the database.
66 */
67 void setPassword(String password);
68
69 }