com.mysql.cj.jdbc.admin.MiniAdmin Maven / Gradle / Ivy
/*
* Copyright (c) 2002, 2020, Oracle and/or its affiliates.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 2.0, as published by the
* Free Software Foundation.
*
* This program is also distributed with certain software (including but not
* limited to OpenSSL) that is licensed under separate terms, as designated in a
* particular file or component or in included license documentation. The
* authors of MySQL hereby grant you an additional permission to link the
* program and your derivative works with the separately licensed software that
* they have included with MySQL.
*
* Without limiting anything contained in the foregoing, this file, which is
* part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
* version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program 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 General Public License, version 2.0,
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.cj.jdbc.admin;
import java.sql.SQLException;
import java.util.Properties;
import com.mysql.cj.Messages;
import com.mysql.cj.exceptions.MysqlErrorNumbers;
import com.mysql.cj.jdbc.Driver;
import com.mysql.cj.jdbc.JdbcConnection;
import com.mysql.cj.jdbc.exceptions.SQLError;
/**
* Utility functions for admin functionality from Java.
*/
public class MiniAdmin {
private JdbcConnection conn;
/**
* Create a new MiniAdmin using the given connection
*
* @param conn
* the existing connection to use.
*
* @throws SQLException
* if an error occurs
*/
public MiniAdmin(java.sql.Connection conn) throws SQLException {
if (conn == null) {
throw SQLError.createSQLException(Messages.getString("MiniAdmin.0"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, null);
}
if (!(conn instanceof JdbcConnection)) {
throw SQLError.createSQLException(Messages.getString("MiniAdmin.1"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR,
((com.mysql.cj.jdbc.ConnectionImpl) conn).getExceptionInterceptor());
}
this.conn = (JdbcConnection) conn;
}
/**
* Create a new MiniAdmin, connecting using the given JDBC URL.
*
* @param jdbcUrl
* the JDBC URL to use
*
* @throws SQLException
* if an error occurs
*/
public MiniAdmin(String jdbcUrl) throws SQLException {
this(jdbcUrl, new Properties());
}
/**
* Create a new MiniAdmin, connecting using the given JDBC URL and
* properties
*
* @param jdbcUrl
* the JDBC URL to use
* @param props
* the properties to use when connecting
*
* @throws SQLException
* if an error occurs
*/
public MiniAdmin(String jdbcUrl, Properties props) throws SQLException {
this.conn = (JdbcConnection) (new Driver().connect(jdbcUrl, props));
}
/**
* Shuts down the MySQL server at the other end of the connection that this
* MiniAdmin was created from/for.
*
* @throws SQLException
* if an error occurs
*/
public void shutdown() throws SQLException {
this.conn.shutdownServer();
}
}