com.mysql.cj.jdbc.ClientInfoProviderSP Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-j Show documentation
JDBC Type 4 driver for MySQL.
There is a newer version: 9.1.0
/*
 * Copyright (c) 2002, 2024, 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 designed to work with certain software 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 either included with the program or referenced in the documentation.
 *
 * 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;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLClientInfoException;
import java.sql.SQLException;
import java.util.Enumeration;
import java.util.Properties;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

public class ClientInfoProviderSP implements ClientInfoProvider {

    public static final String PNAME_clientInfoSetSPName = "clientInfoSetSPName";
    public static final String PNAME_clientInfoGetSPName = "clientInfoGetSPName";
    public static final String PNAME_clientInfoGetBulkSPName = "clientInfoGetBulkSPName";
    public static final String PNAME_clientInfoDatabase = "clientInfoDatabase";

    PreparedStatement setClientInfoSp;

    PreparedStatement getClientInfoSp;

    PreparedStatement getClientInfoBulkSp;

    private final Lock lock = new ReentrantLock();

    @Override
    public void initialize(Connection conn, Properties configurationProps) throws SQLException {
        this.lock.lock();
        try {
            String identifierQuote = ((JdbcConnection) conn).getSession().getIdentifierQuoteString();
            String setClientInfoSpName = configurationProps.getProperty(PNAME_clientInfoSetSPName, "setClientInfo");
            String getClientInfoSpName = configurationProps.getProperty(PNAME_clientInfoGetSPName, "getClientInfo");
            String getClientInfoBulkSpName = configurationProps.getProperty(PNAME_clientInfoGetBulkSPName, "getClientInfoBulk");
            String clientInfoDatabase = configurationProps.getProperty(PNAME_clientInfoDatabase, ""); // "" means use current from connection

            String db = "".equals(clientInfoDatabase) ? ((JdbcConnection) conn).getDatabase() : clientInfoDatabase;

            this.setClientInfoSp = ((JdbcConnection) conn).clientPrepareStatement(
                    "CALL " + identifierQuote + db + identifierQuote + "." + identifierQuote + setClientInfoSpName + identifierQuote + "(?, ?)");

            this.getClientInfoSp = ((JdbcConnection) conn).clientPrepareStatement(
                    "CALL" + identifierQuote + db + identifierQuote + "." + identifierQuote + getClientInfoSpName + identifierQuote + "(?)");

            this.getClientInfoBulkSp = ((JdbcConnection) conn).clientPrepareStatement(
                    "CALL " + identifierQuote + db + identifierQuote + "." + identifierQuote + getClientInfoBulkSpName + identifierQuote + "()");
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public void destroy() throws SQLException {
        this.lock.lock();
        try {
            if (this.setClientInfoSp != null) {
                this.setClientInfoSp.close();
                this.setClientInfoSp = null;
            }

            if (this.getClientInfoSp != null) {
                this.getClientInfoSp.close();
                this.getClientInfoSp = null;
            }

            if (this.getClientInfoBulkSp != null) {
                this.getClientInfoBulkSp.close();
                this.getClientInfoBulkSp = null;
            }
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public Properties getClientInfo(Connection conn) throws SQLException {
        this.lock.lock();
        try {
            ResultSet rs = null;

            Properties props = new Properties();

            try {
                this.getClientInfoBulkSp.execute();

                rs = this.getClientInfoBulkSp.getResultSet();

                while (rs.next()) {
                    props.setProperty(rs.getString(1), rs.getString(2));
                }
            } finally {
                if (rs != null) {
                    rs.close();
                }
            }

            return props;
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public String getClientInfo(Connection conn, String name) throws SQLException {
        this.lock.lock();
        try {
            ResultSet rs = null;

            String clientInfo = null;

            try {
                this.getClientInfoSp.setString(1, name);
                this.getClientInfoSp.execute();

                rs = this.getClientInfoSp.getResultSet();

                if (rs.next()) {
                    clientInfo = rs.getString(1);
                }
            } finally {
                if (rs != null) {
                    rs.close();
                }
            }

            return clientInfo;
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public void setClientInfo(Connection conn, Properties properties) throws SQLClientInfoException {
        this.lock.lock();
        try {
            Enumeration propNames = properties.propertyNames();

            while (propNames.hasMoreElements()) {
                String name = (String) propNames.nextElement();
                String value = properties.getProperty(name);

                setClientInfo(conn, name, value);
            }
        } catch (SQLException sqlEx) {
            SQLClientInfoException clientInfoEx = new SQLClientInfoException();
            clientInfoEx.initCause(sqlEx);

            throw clientInfoEx;
        } finally {
            this.lock.unlock();
        }
    }

    @Override
    public void setClientInfo(Connection conn, String name, String value) throws SQLClientInfoException {
        this.lock.lock();
        try {
            this.setClientInfoSp.setString(1, name);
            this.setClientInfoSp.setString(2, value);
            this.setClientInfoSp.execute();
        } catch (SQLException sqlEx) {
            SQLClientInfoException clientInfoEx = new SQLClientInfoException();
            clientInfoEx.initCause(sqlEx);

            throw clientInfoEx;
        } finally {
            this.lock.unlock();
        }
    }

}