summaryrefslogtreecommitdiffstats
path: root/sandbox/event/modules/implementation-data-xml/src/main/java/org/apache/tuscany/sca/implementation/data/jdbc/JDBCHelper.java
blob: 265f2507177eabc728c3d84714117214425b9b14 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.    
 */

package org.apache.tuscany.sca.implementation.data.jdbc;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Properties;

import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;

import org.apache.tuscany.das.rdb.exception.DataSourceInitializationException;
import org.apache.tuscany.sca.data.engine.config.ConnectionInfo;

/**
 * JDBC Helper
 *    - JDBC Connection utility methods
 *    - JDBC Resource cleanup methods
 *    
 * @version $Rev$ $Date$
 */
public class JDBCHelper {
    
    /**
     * protected constructor
     */
    protected JDBCHelper() {
        
    }

    /**
     * 
     * @param connectionInfo
     * @return
     */
    public static Connection getConnection(ConnectionInfo connectionInfo) {
        if (connectionInfo.getDataSource() == null && connectionInfo.getConnectionProperties() == null) {
            throw new IllegalArgumentException("Not enough information to create Database Connection.");
        }
        
        if(connectionInfo.getDataSource() != null && connectionInfo.getConnectionProperties() != null) {
            throw new IllegalArgumentException("Use either dataSource or ConnectionProperties. Can't use both !");            
        }
        
        if(connectionInfo.getDataSource() != null) {
            return getDataSourceConnection(connectionInfo);
        } else {
            return getDriverManagerConnection(connectionInfo);
        }
    }

    /**
     * Initializes a DB connection on a managed environment (e.g inside Tomcat)
     * 
     * @param connectionInfo
     * @return
     */
    private static Connection getDataSourceConnection(ConnectionInfo connectionInfo) {
        Connection connection = null;

        InitialContext ctx;
        try {
            ctx = new InitialContext();
        } catch (NamingException e) {
            throw new RuntimeException(e);
        }
        try {
            DataSource ds = (DataSource) ctx.lookup(connectionInfo.getDataSource());
            try {
                connection = ds.getConnection();
                if (connection == null) {
                    throw new RuntimeException("Could not obtain a Connection from DataSource");
                }
                connection.setAutoCommit(false);
            } catch (SQLException e) {
                throw new RuntimeException(e);
            }
        } catch (NamingException e) {
            throw new RuntimeException(e);
        }
        
        return connection;
    }

    /**
     * Initialize a DB connection on a J2SE environment
     * For more info, see http://java.sun.com/j2se/1.3/docs/guide/jdbc/getstart/drivermanager.html
     * 
     * @param connectionInfo
     * @return
     */
    private static Connection getDriverManagerConnection(ConnectionInfo connectionInfo) {
        Connection connection = null;

        if (connectionInfo.getConnectionProperties() == null) {
            throw new RuntimeException("No existing context and no connection properties");
        }

        if (connectionInfo.getConnectionProperties().getDriverClass() == null) {
            throw new RuntimeException("No jdbc driver class specified!");
        }

        try {
            Properties p = System.getProperties();
            p.put("derby.system.home", "target");
            
            //initialize driver and register it with DriverManager
            Class.forName(connectionInfo.getConnectionProperties().getDriverClass());

            //prepare to initialize connection
            String databaseUrl = connectionInfo.getConnectionProperties().getDatabaseURL();
            String userName = connectionInfo.getConnectionProperties().getUsername();
            String userPassword = connectionInfo.getConnectionProperties().getPassword();
            int loginTimeout = connectionInfo.getConnectionProperties().getLoginTimeout();

            DriverManager.setLoginTimeout(loginTimeout);
            if( (userName == null || userName.length() ==0) && (userPassword == null || userPassword.length()==0) ){
                //no username or password supplied
                connection = DriverManager.getConnection(databaseUrl);
            }else{
                connection = DriverManager.getConnection(databaseUrl, userName, userPassword);
            }

            if(connection == null){
                throw new DataSourceInitializationException("Error initializing connection : null");
            }
            
            //FIXME we should make this flexible, we can't autocommit when participating in transactions
            connection.setAutoCommit(true);
            
        }catch(ClassNotFoundException cnf){
            throw new DataSourceInitializationException("JDBC Driver '" + connectionInfo.getConnectionProperties().getDriverClass() + "' not found", cnf);
        }catch(SQLException sqle){
            throw new DataSourceInitializationException(sqle.getMessage(), sqle);
        }
        
        return connection;
    }
    
    /**
     * Cleanup and close all JDBC resources in the proper order and ignoring erros
     * @param connection The connection to be closed
     * @param queryStatement The statement to be closed
     * @param resultSet The ResultSet to be closed
     */
    public static void cleanupResources(Connection connection, PreparedStatement queryStatement, ResultSet resultSet) {
        cleanupResultSet(resultSet);
        cleanupPreparedStatement(queryStatement);
        cleanupConnection(connection);
    }

    /**
     * Proper cleanup the ResultSet
     * @param resultSet
     */
    private static void cleanupResultSet(ResultSet resultSet) {
        if (resultSet != null) {
            try {
                resultSet.close();
            } catch (SQLException e) {
                // We should log the error. Since we're trying to close, we don't re-throw.
            }
        }
    }

    /**
     * Proper cleanup the prepared statement
     * @param queryStatement
     */
    private static void cleanupPreparedStatement(PreparedStatement queryStatement) {
        if (queryStatement != null) {
            try {
                queryStatement.close();
            } catch (SQLException e) {
                // We should log the error. Since we're trying to close, we don't re-throw.
            }
        }
    }

    /**
     * proper cleanup the connection
     * @param connection
     */
    private static void cleanupConnection(Connection connection) {
        if (connection != null) {
            try {
                connection.close();
            } catch (SQLException e) {
                // We should log the error. Since we're trying to close, we don't re-throw.
            }
        }
    }    

}