java/sql-dk/src/info/globalcode/sql/dk/DatabaseConnection.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 01 Jan 2014 02:56:08 +0100
branchv_0
changeset 108 d06d90b28217
parent 107 8189a4a28cd8
child 142 da1e38386d84
permissions -rw-r--r--
DB credentials can be CLI options + log warning: insecure
franta-hg@26
     1
/**
franta-hg@26
     2
 * SQL-DK
franta-hg@26
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@26
     4
 *
franta-hg@26
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@26
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@26
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@26
     8
 * (at your option) any later version.
franta-hg@26
     9
 *
franta-hg@26
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@26
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@26
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@26
    13
 * GNU General Public License for more details.
franta-hg@26
    14
 *
franta-hg@26
    15
 * You should have received a copy of the GNU General Public License
franta-hg@26
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@26
    17
 */
franta-hg@27
    18
package info.globalcode.sql.dk;
franta-hg@27
    19
franta-hg@29
    20
import info.globalcode.sql.dk.batch.Batch;
franta-hg@27
    21
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@106
    22
import info.globalcode.sql.dk.configuration.Properties;
franta-hg@107
    23
import info.globalcode.sql.dk.configuration.Property;
franta-hg@34
    24
import info.globalcode.sql.dk.formatting.ColumnsHeader;
franta-hg@29
    25
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@28
    26
import java.sql.Connection;
franta-hg@28
    27
import java.sql.DriverManager;
franta-hg@29
    28
import java.sql.PreparedStatement;
franta-hg@29
    29
import java.sql.ResultSet;
franta-hg@28
    30
import java.sql.SQLException;
franta-hg@86
    31
import java.sql.SQLWarning;
franta-hg@55
    32
import java.util.logging.Level;
franta-hg@55
    33
import java.util.logging.Logger;
franta-hg@26
    34
franta-hg@26
    35
/**
franta-hg@26
    36
 *
franta-hg@26
    37
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@26
    38
 */
franta-hg@42
    39
public class DatabaseConnection implements AutoCloseable {
franta-hg@26
    40
franta-hg@55
    41
	private static final Logger log = Logger.getLogger(DatabaseConnection.class.getName());
franta-hg@108
    42
	private static final String JDBC_PROPERTY_USER = "user";
franta-hg@108
    43
	public static final String JDBC_PROPERTY_PASSWORD = "password";
franta-hg@26
    44
	private DatabaseDefinition databaseDefinition;
franta-hg@28
    45
	private Connection connection;
franta-hg@106
    46
	private Properties properties;
franta-hg@26
    47
franta-hg@106
    48
	public DatabaseConnection(DatabaseDefinition databaseDefinition, Properties properties) throws SQLException {
franta-hg@26
    49
		this.databaseDefinition = databaseDefinition;
franta-hg@106
    50
		this.properties = properties;
franta-hg@28
    51
franta-hg@108
    52
		if (properties.hasProperty(JDBC_PROPERTY_PASSWORD)) {
franta-hg@108
    53
			log.log(Level.WARNING, "Passing DB password as CLI parameter is insecure!");
franta-hg@108
    54
		}
franta-hg@108
    55
franta-hg@107
    56
		Properties credentials = new Properties();
franta-hg@108
    57
		credentials.add(new Property(JDBC_PROPERTY_USER, databaseDefinition.getUserName()));
franta-hg@108
    58
		credentials.add(new Property(JDBC_PROPERTY_PASSWORD, databaseDefinition.getPassword()));
franta-hg@107
    59
		credentials.setDefaults(databaseDefinition.getProperties());
franta-hg@107
    60
		properties.setDefaults(credentials);
franta-hg@106
    61
		java.util.Properties javaProperties = properties.getJavaProperties();
franta-hg@106
    62
franta-hg@106
    63
		connection = DriverManager.getConnection(databaseDefinition.getUrl(), javaProperties);
franta-hg@26
    64
	}
franta-hg@29
    65
franta-hg@29
    66
	public void executeQuery(SQLCommand sqlCommand, Formatter formatter) throws SQLException {
franta-hg@91
    67
		formatter.writeStartBatch();
franta-hg@29
    68
		formatter.writeStartDatabase(databaseDefinition);
franta-hg@29
    69
		processCommand(sqlCommand, formatter);
franta-hg@29
    70
		formatter.writeEndDatabase();
franta-hg@91
    71
		formatter.writeEndBatch();
franta-hg@29
    72
	}
franta-hg@29
    73
franta-hg@29
    74
	public void executeBatch(Batch batch, Formatter formatter) throws SQLException {
franta-hg@91
    75
		formatter.writeStartBatch();
franta-hg@29
    76
		formatter.writeStartDatabase(databaseDefinition);
franta-hg@29
    77
		while (batch.hasNext()) {
franta-hg@29
    78
			processCommand(batch.next(), formatter);
franta-hg@29
    79
		}
franta-hg@29
    80
		formatter.writeEndDatabase();
franta-hg@91
    81
		formatter.writeEndBatch();
franta-hg@29
    82
	}
franta-hg@29
    83
franta-hg@29
    84
	private void processCommand(SQLCommand sqlCommand, Formatter formatter) throws SQLException {
franta-hg@29
    85
		try (PreparedStatement ps = sqlCommand.prepareStatement(connection)) {
franta-hg@55
    86
			log.log(Level.FINE, "Statement prepared");
franta-hg@29
    87
			sqlCommand.parametrize(ps);
franta-hg@35
    88
franta-hg@35
    89
			boolean isRS = ps.execute();
franta-hg@55
    90
			log.log(Level.FINE, "Statement executed");
franta-hg@35
    91
			if (isRS) {
franta-hg@35
    92
				try (ResultSet rs = ps.getResultSet()) {
franta-hg@37
    93
					processResultSet(sqlCommand, rs, formatter);
franta-hg@35
    94
				}
franta-hg@35
    95
			} else {
franta-hg@37
    96
				processUpdateResult(sqlCommand, ps, formatter);
franta-hg@35
    97
			}
franta-hg@86
    98
			logWarnings(ps);
franta-hg@35
    99
franta-hg@35
   100
			while (ps.getMoreResults() || ps.getUpdateCount() > -1) {
franta-hg@37
   101
				ResultSet rs = ps.getResultSet();
franta-hg@37
   102
				if (rs == null) {
franta-hg@37
   103
					processUpdateResult(sqlCommand, ps, formatter);
franta-hg@37
   104
				} else {
franta-hg@37
   105
					processResultSet(sqlCommand, rs, formatter);
franta-hg@37
   106
					rs.close();
franta-hg@37
   107
				}
franta-hg@86
   108
				logWarnings(ps);
franta-hg@29
   109
			}
franta-hg@29
   110
		}
franta-hg@37
   111
	}
franta-hg@37
   112
franta-hg@37
   113
	private void processUpdateResult(SQLCommand sqlCommand, PreparedStatement ps, Formatter formatter) throws SQLException {
franta-hg@37
   114
		formatter.writeStartUpdatesResult();
franta-hg@37
   115
		formatter.writeQuery(sqlCommand.getQuery());
franta-hg@37
   116
		formatter.writeParameters(sqlCommand.getParameters());
franta-hg@41
   117
		formatter.writeUpdatedRowsCount(ps.getUpdateCount());
franta-hg@37
   118
		formatter.writeEndUpdatesResult();
franta-hg@37
   119
	}
franta-hg@37
   120
franta-hg@37
   121
	private void processResultSet(SQLCommand sqlCommand, ResultSet rs, Formatter formatter) throws SQLException {
franta-hg@37
   122
		formatter.writeStartResultSet();
franta-hg@37
   123
		formatter.writeQuery(sqlCommand.getQuery());
franta-hg@37
   124
		formatter.writeParameters(sqlCommand.getParameters());
franta-hg@37
   125
franta-hg@37
   126
		processResultSetRows(rs, formatter);
franta-hg@29
   127
franta-hg@29
   128
		formatter.writeEndResultSet();
franta-hg@29
   129
	}
franta-hg@29
   130
franta-hg@37
   131
	private void processResultSetRows(ResultSet rs, Formatter formatter) throws SQLException {
franta-hg@34
   132
		formatter.writeColumnsHeader(new ColumnsHeader(rs.getMetaData()));
franta-hg@34
   133
		int columnCount = rs.getMetaData().getColumnCount();
franta-hg@34
   134
franta-hg@29
   135
		while (rs.next()) {
franta-hg@29
   136
			formatter.writeStartRow();
franta-hg@29
   137
franta-hg@34
   138
			for (int i = 1; i <= columnCount; i++) {
franta-hg@34
   139
				formatter.writeColumnValue(rs.getObject(i));
franta-hg@34
   140
			}
franta-hg@34
   141
franta-hg@29
   142
			formatter.writeEndRow();
franta-hg@29
   143
		}
franta-hg@34
   144
franta-hg@29
   145
	}
franta-hg@42
   146
franta-hg@86
   147
	private void logWarnings(PreparedStatement ps) throws SQLException {
franta-hg@86
   148
		SQLWarning w = ps.getWarnings();
franta-hg@86
   149
		while (w != null) {
franta-hg@86
   150
			log.log(Level.WARNING, "SQL: {0}", w.getLocalizedMessage());
franta-hg@86
   151
			w = w.getNextWarning();
franta-hg@86
   152
		}
franta-hg@86
   153
		ps.clearWarnings();
franta-hg@86
   154
	}
franta-hg@86
   155
franta-hg@65
   156
	/**
franta-hg@65
   157
	 * Tests if this connection is live.
franta-hg@65
   158
	 *
franta-hg@65
   159
	 * @return true if test was successful
franta-hg@65
   160
	 * @throws SQLException if test fails
franta-hg@65
   161
	 */
franta-hg@65
   162
	public boolean test() throws SQLException {
franta-hg@65
   163
		connection.getAutoCommit();
franta-hg@65
   164
		return true;
franta-hg@65
   165
	}
franta-hg@65
   166
franta-hg@42
   167
	@Override
franta-hg@42
   168
	public void close() throws SQLException {
franta-hg@42
   169
		connection.close();
franta-hg@42
   170
	}
franta-hg@26
   171
}