java/sql-dk/src/info/globalcode/sql/dk/configuration/DatabaseDefinition.java
author František Kučera <franta-hg@frantovo.cz>
Sun, 17 May 2015 13:51:40 +0200
branchv_0
changeset 194 629c9c7eab01
parent 188 54bacc7ed42b
child 203 504c4ba56d1c
permissions -rw-r--r--
JDBC driver class can be specified in the database configuration as an optional parameter (useful especially while embedding jdbc-dk-driver into other application that does not support automatic driver discovery)
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@26
    18
package info.globalcode.sql.dk.configuration;
franta-hg@26
    19
franta-hg@30
    20
import static info.globalcode.sql.dk.Xmlns.CONFIGURATION;
franta-hg@27
    21
import info.globalcode.sql.dk.DatabaseConnection;
franta-hg@179
    22
import info.globalcode.sql.dk.jmx.ConnectionManagement;
franta-hg@29
    23
import java.sql.SQLException;
franta-hg@179
    24
import java.util.logging.Logger;
franta-hg@26
    25
import javax.xml.bind.annotation.XmlElement;
franta-hg@26
    26
franta-hg@26
    27
/**
franta-hg@155
    28
 * Configured (but not yet connected) database connection.
franta-hg@26
    29
 *
franta-hg@26
    30
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@26
    31
 */
franta-hg@26
    32
public class DatabaseDefinition implements NameIdentified {
franta-hg@26
    33
franta-hg@179
    34
	private static final Logger log = Logger.getLogger(DatabaseDefinition.class.getName());
franta-hg@194
    35
	/**
franta-hg@194
    36
	 * database name in SQL-DK configuration
franta-hg@194
    37
	 */
franta-hg@26
    38
	private String name;
franta-hg@194
    39
	/**
franta-hg@194
    40
	 * JDBC URL
franta-hg@194
    41
	 */
franta-hg@26
    42
	private String url;
franta-hg@194
    43
	/**
franta-hg@194
    44
	 * JDBC user name
franta-hg@194
    45
	 */
franta-hg@26
    46
	private String userName;
franta-hg@194
    47
	/**
franta-hg@194
    48
	 * JDBC password
franta-hg@194
    49
	 */
franta-hg@26
    50
	private String password;
franta-hg@194
    51
	/**
franta-hg@194
    52
	 * optional JDBC driver – if empty, the DriverManager is used to lookup specific Driver for
franta-hg@194
    53
	 * given URL
franta-hg@194
    54
	 */
franta-hg@194
    55
	private String driver;
franta-hg@194
    56
	/**
franta-hg@194
    57
	 * JDBC properties
franta-hg@194
    58
	 */
franta-hg@104
    59
	private Properties properties = new Properties();
franta-hg@26
    60
franta-hg@30
    61
	@XmlElement(name = "name", namespace = CONFIGURATION)
franta-hg@26
    62
	@Override
franta-hg@26
    63
	public String getName() {
franta-hg@26
    64
		return name;
franta-hg@26
    65
	}
franta-hg@26
    66
franta-hg@26
    67
	public void setName(String name) {
franta-hg@26
    68
		this.name = name;
franta-hg@26
    69
	}
franta-hg@26
    70
franta-hg@30
    71
	@XmlElement(name = "url", namespace = CONFIGURATION)
franta-hg@26
    72
	public String getUrl() {
franta-hg@26
    73
		return url;
franta-hg@26
    74
	}
franta-hg@26
    75
franta-hg@26
    76
	public void setUrl(String url) {
franta-hg@26
    77
		this.url = url;
franta-hg@26
    78
	}
franta-hg@26
    79
franta-hg@30
    80
	@XmlElement(name = "userName", namespace = CONFIGURATION)
franta-hg@26
    81
	public String getUserName() {
franta-hg@26
    82
		return userName;
franta-hg@26
    83
	}
franta-hg@26
    84
franta-hg@26
    85
	public void setUserName(String userName) {
franta-hg@26
    86
		this.userName = userName;
franta-hg@26
    87
	}
franta-hg@26
    88
franta-hg@30
    89
	@XmlElement(name = "password", namespace = CONFIGURATION)
franta-hg@26
    90
	public String getPassword() {
franta-hg@26
    91
		return password;
franta-hg@26
    92
	}
franta-hg@26
    93
franta-hg@26
    94
	public void setPassword(String password) {
franta-hg@26
    95
		this.password = password;
franta-hg@26
    96
	}
franta-hg@26
    97
franta-hg@194
    98
	public String getDriver() {
franta-hg@194
    99
		return driver;
franta-hg@194
   100
	}
franta-hg@194
   101
franta-hg@194
   102
	public void setDriver(String driver) {
franta-hg@194
   103
		this.driver = driver;
franta-hg@194
   104
	}
franta-hg@194
   105
franta-hg@104
   106
	@XmlElement(name = "property", namespace = CONFIGURATION)
franta-hg@104
   107
	public Properties getProperties() {
franta-hg@104
   108
		return properties;
franta-hg@104
   109
	}
franta-hg@104
   110
franta-hg@104
   111
	public void setProperties(Properties properties) {
franta-hg@104
   112
		this.properties = properties;
franta-hg@104
   113
	}
franta-hg@104
   114
franta-hg@106
   115
	/**
franta-hg@155
   116
	 * @param properties ad-hoc properties from CLI options (for the JDBC driver)
franta-hg@179
   117
	 * @param jmxBean JMX management bean for progress reporting | null = disable JMX
franta-hg@194
   118
	 * @return
franta-hg@188
   119
	 * @throws java.sql.SQLException
franta-hg@179
   120
	 */
franta-hg@179
   121
	public DatabaseConnection connect(Properties properties, ConnectionManagement jmxBean) throws SQLException {
franta-hg@179
   122
		return new DatabaseConnection(this, properties, jmxBean);
franta-hg@179
   123
	}
franta-hg@179
   124
franta-hg@179
   125
	/**
franta-hg@188
   126
	 * @param properties
franta-hg@194
   127
	 * @return
franta-hg@188
   128
	 * @throws java.sql.SQLException
franta-hg@179
   129
	 * @see #connect(info.globalcode.sql.dk.configuration.Properties, java.lang.String)
franta-hg@179
   130
	 * With disabled JMX reporting.
franta-hg@106
   131
	 */
franta-hg@106
   132
	public DatabaseConnection connect(Properties properties) throws SQLException {
franta-hg@179
   133
		return new DatabaseConnection(this, properties, null);
franta-hg@26
   134
	}
franta-hg@26
   135
}