org.mariadb.jdbc.MariaDbDataSource Maven / Gradle / Ivy
Show all versions of mariadb-java-client-jre7 Show documentation
/*
*
* MariaDB Client for Java
*
* Copyright (c) 2012-2014 Monty Program Ab.
* Copyright (c) 2015-2017 MariaDB Ab.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License along
* with this library; if not, write to Monty Program Ab [email protected].
*
* This particular MariaDB Client for Java file is work
* derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
* the following copyright and notice provisions:
*
* Copyright (c) 2009-2011, Marcus Eriksson
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* Neither the name of the driver nor the names of its contributors may not be
* used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
*/
package org.mariadb.jdbc;
import org.mariadb.jdbc.internal.protocol.Protocol;
import org.mariadb.jdbc.internal.util.DefaultOptions;
import org.mariadb.jdbc.internal.util.Utils;
import org.mariadb.jdbc.internal.util.constant.HaMode;
import org.mariadb.jdbc.internal.util.exceptions.ExceptionMapper;
import javax.sql.*;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.ArrayList;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Logger;
public class MariaDbDataSource implements DataSource, ConnectionPoolDataSource, XADataSource {
private final UrlParser urlParser;
/**
* Constructor.
*
* @param hostname hostname (ipv4, ipv6, dns name)
* @param port server port
* @param database database name
* @throws SQLException exception if connection failed
*/
public MariaDbDataSource(String hostname, int port, String database) throws SQLException {
ArrayList hostAddresses = new ArrayList<>();
hostAddresses.add(new HostAddress(hostname, port));
urlParser = new UrlParser(database, hostAddresses, DefaultOptions.defaultValues(HaMode.NONE), HaMode.NONE);
}
public MariaDbDataSource(String url) throws SQLException {
this.urlParser = UrlParser.parse(url);
}
/**
* Default constructor. hostname will be localhost, port 3306.
*/
public MariaDbDataSource() {
ArrayList hostAddresses = new ArrayList<>();
hostAddresses.add(new HostAddress("localhost", 3306));
urlParser = new UrlParser("", hostAddresses, DefaultOptions.defaultValues(HaMode.NONE), HaMode.NONE);
}
/**
* Gets the name of the database.
*
* @return the name of the database for this data source
*/
public String getDatabaseName() {
return (urlParser.getDatabase() != null) ? urlParser.getDatabase() : "";
}
/**
* Sets the database name.
*
* @param dbName the name of the database
*/
public void setDatabaseName(String dbName) {
urlParser.setDatabase(dbName);
}
/**
* Gets the username.
*
* @return the username to use when connecting to the database
*/
public String getUser() {
return urlParser.getUsername();
}
/**
* Sets the username.
*
* @param userName the username
*/
public void setUser(String userName) {
setUserName(userName);
}
/**
* Gets the username.
*
* @return the username to use when connecting to the database
*/
public String getUserName() {
return urlParser.getUsername();
}
/**
* Sets the username.
*
* @param userName the username
*/
public void setUserName(String userName) {
urlParser.setUsername(userName);
}
/**
* Sets the password.
*
* @param pass the password
*/
public void setPassword(String pass) {
urlParser.setPassword(pass);
}
/**
* Returns the port number.
*
* @return the port number
*/
public int getPort() {
return urlParser.getHostAddresses().get(0).port;
}
/**
* Sets the database port.
*
* @param port the port
*/
public void setPort(int port) {
urlParser.getHostAddresses().get(0).port = port;
}
/**
* Returns the port number.
*
* @return the port number
*/
public int getPortNumber() {
return getPort();
}
/**
* Sets the port number.
*
* @param port the port
* @see #setPort
*/
public void setPortNumber(int port) {
if (port > 0) {
setPort(port);
}
}
public void setProperties(String properties) {
urlParser.setProperties(properties);
}
/**
* Sets the connection string URL.
*
* @param url the connection string
* @throws SQLException if error in URL
* @deprecated since 1.3.0 use setUrl method instead
*/
@Deprecated
public void setURL(String url) throws SQLException {
setUrl(url);
}
/**
* Sets the connection string URL.
*
* @param url the connection string
* @throws SQLException if error in URL
*/
public void setUrl(String url) throws SQLException {
this.urlParser.parseUrl(url);
}
/**
* Returns the name of the database server.
*
* @return the name of the database server
*/
public String getServerName() {
return (this.urlParser.getHostAddresses().get(0).host != null) ? this.urlParser.getHostAddresses().get(0).host : "";
}
/**
* Sets the server name.
*
* @param serverName the server name
*/
public void setServerName(String serverName) {
if (serverName != null && !serverName.isEmpty()) {
urlParser.getHostAddresses().get(0).host = serverName;
}
}
/**
* Attempts to establish a connection with the data source that this DataSource object represents.
*
* @return a connection to the data source
* @throws SQLException if a database access error occurs
*/
public Connection getConnection() throws SQLException {
try {
ReentrantLock lock = new ReentrantLock();
Protocol proxyfiedProtocol = Utils.retrieveProxy(urlParser, lock);
return MariaDbConnection.newConnection(urlParser.getInitialUrl(), proxyfiedProtocol, lock);
} catch (SQLException e) {
ExceptionMapper.throwException(e, null, null);
return null;
}
}
/**
* Attempts to establish a connection with the data source that this DataSource object represents.
*
* @param username the database user on whose behalf the connection is being made
* @param password the user's password
* @return a connection to the data source
* @throws SQLException if a database access error occurs
* @since 1.4
*/
public Connection getConnection(final String username, final String password) throws SQLException {
urlParser.setUsername(username);
urlParser.setPassword(password);
//if (log.isDebugEnabled()) log.debug("connection : " +urlParser.toString());
return getConnection();
}
/**
* Retrieves the log writer for this DataSource object.
*
* The log writer is a character output stream to which all logging and tracing messages for this data source
* will be printed. This includes messages printed by the methods of this object, messages printed by methods of
* other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are
* not printed to the log writer associated with the java.sql.DriverManager class. When a
* DataSource object is created, the log writer is initially null; in other words, the default is for
* logging to be disabled.
*
* @return the log writer for this data source or null if logging is disabled
* @throws SQLException if a database access error occurs
* @see #setLogWriter
* @since 1.4
*/
public PrintWriter getLogWriter() throws SQLException {
return null;
}
/**
* Sets the log writer for this DataSource object to the given java.io.PrintWriter
* object.
*
* The log writer is a character output stream to which all logging and tracing messages for this data source
* will be printed. This includes messages printed by the methods of this object, messages printed by methods of
* other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are
* not printed to the log writer associated with the java.sql.DriverManager class. When a
* DataSource object is created the log writer is initially null; in other words, the default is for
* logging to be disabled.
*
* @param out the new log writer; to disable logging, set to null
* @throws SQLException if a database access error occurs
* @see #getLogWriter
* @since 1.4
*/
public void setLogWriter(final PrintWriter out) throws SQLException {
//not implemented
}
/**
* Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A
* value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that
* there is no timeout. When a DataSource object is created, the login timeout is initially zero.
*
* @return the data source login time limit
* @throws SQLException if a database access error occurs.
* @see #setLoginTimeout
* @since 1.4
*/
public int getLoginTimeout() throws SQLException {
return urlParser.getOptions().connectTimeout == null ? 0 : urlParser.getOptions().connectTimeout / 1000;
}
/**
* Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A
* value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies
* that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
*
* @param seconds the data source login time limit
* @throws SQLException if a database access error occurs.
* @see #getLoginTimeout
* @since 1.4
*/
@Override
public void setLoginTimeout(final int seconds) throws SQLException {
urlParser.getOptions().connectTimeout = seconds * 1000;
}
/**
* Returns an object that implements the given interface to allow access to non-standard methods, or standard
* methods not exposed by the proxy.
*
* If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the
* receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a
* proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the
* wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface,
* then an SQLException is thrown.
*
* @param iface A Class defining an interface that the result must implement.
* @return an object that implements the interface. May be a proxy for the actual implementing object.
* @throws SQLException If no object found that implements the interface
* @since 1.6
*/
public T unwrap(final Class iface) throws SQLException {
try {
if (isWrapperFor(iface)) {
return iface.cast(this);
} else {
throw new SQLException("The receiver is not a wrapper and does not implement the interface");
}
} catch (Exception e) {
throw new SQLException("The receiver is not a wrapper and does not implement the interface");
}
}
/**
* Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an
* object that does. Returns false otherwise. If this implements the interface then return true, else if this is a
* wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this
* does not implement the interface and is not a wrapper, return false. This method should be implemented as a
* low-cost operation compared to unwrap so that callers can use this method to avoid expensive
* unwrap calls that may fail. If this method returns true then calling unwrap with the
* same argument should succeed.
*
* @param interfaceOrWrapper a Class defining an interface.
* @return true if this implements the interface or directly or indirectly wraps an object that does.
* @throws SQLException if an error occurs while determining whether this is a wrapper for an object with
* the given interface.
* @since 1.6
*/
public boolean isWrapperFor(final Class interfaceOrWrapper) throws SQLException {
return interfaceOrWrapper.isInstance(this);
}
/**
* Attempts to establish a physical database connection that can
* be used as a pooled connection.
*
* @return a PooledConnection object that is a physical
* connection to the database that this
* ConnectionPoolDataSource object represents
* @throws SQLException if a database access error occurs
* if the JDBC driver does not support
* this method
* @since 1.4
*/
public PooledConnection getPooledConnection() throws SQLException {
return new MariaDbPooledConnection((MariaDbConnection) getConnection());
}
/**
* Attempts to establish a physical database connection that can
* be used as a pooled connection.
*
* @param user the database user on whose behalf the connection is being made
* @param password the user's password
* @return a PooledConnection object that is a physical
* connection to the database that this
* ConnectionPoolDataSource object represents
* @throws SQLException if a database access error occurs
* @since 1.4
*/
public PooledConnection getPooledConnection(String user, String password) throws SQLException {
return new MariaDbPooledConnection((MariaDbConnection) getConnection(user, password));
}
@Override
public XAConnection getXAConnection() throws SQLException {
return new MariaXaConnection((MariaDbConnection) getConnection());
}
@Override
public XAConnection getXAConnection(String user, String password) throws SQLException {
return new MariaXaConnection((MariaDbConnection) getConnection(user, password));
}
public Logger getParentLogger() throws SQLFeatureNotSupportedException {
return null;
}
/**
* For testing purpose only.
* @return current url parser.
*/
protected UrlParser getUrlParser() {
return urlParser;
}
}