blob: 2f51666dc589b48aaf6dcf47e74930721308a971 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*-
* ============LICENSE_START=======================================================
* ONAP : APPC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Copyright (C) 2017 Amdocs
* =============================================================================
* Licensed 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.
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
* ============LICENSE_END=========================================================
*/
package org.onap.appc.dao.util.api;
import org.onap.appc.dao.util.exception.DBConnectionPoolException;
import org.onap.appc.dao.util.exception.DataAccessException;
import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Map;
/**
* This class is the interface of DBConnectionPool.
* <p>
* Below is an example of how to query an entry from database.
* Inject AppcDatabaseConnectionPool bean by the blueprint first
* for example,
* {@code
* <reference id="AppcMysqlDBConnectionPoolService" availability="mandatory"
* activation="eager" interface="org.onap.appc.dao.util.api.DBConnectionPoolService" />
* }
* <p>
* Then, query the data and close ResultSet, Statement, Connection.
* <blockquote><pre>
* {@code
* private AppcDatabaseConnectionPool pool;
* public void setAppcDatabaseConnectionPool(AppcDatabaseConnectionPool pool){
* this.pool = pool;
* }
* public queryAppcDatabase(AppcDatabaseConnectionPool pool){
* Connection connection = null;
* try {
* connection = pool.getConnection();
* } catch (DBConnectionPoolException e) {
* e.printStackTrace();
* }
* Connection conn = null;
* Statement stmt = null;
* ResultSet rs = null;
* try {
* stmt = connection.createStatement();
* rs = stmt.executeQuery("select * from appcctl.transactions");
* System.out.println("# of entries in db:");
* int numcols = rs.getMetaData().getColumnCount();
* System.out.println(pool.getDataSourceStatus());
* }catch (SQLException e) {
* e.printStackTrace();
* } finally {
* try {
* pool.close(rs, stmt, conn);
* } catch (DataAccessException e) {
* e.printStackTrace();
* }
* }
* }
* }
* <p>
* </pre></blockquote>
*/
public interface DBConnectionPoolService {
/**
* Get a jdbc connection
*
* @return connection {@link Connection}
* @throws DBConnectionPoolException - if a {@link Connection} cannot be return.
*/
Connection getConnection() throws DBConnectionPoolException;
/**
* Get Data source status
*
* @return map
*/
Map<String, Integer> getDataSourceStatus();
}
|
