File size: 5,173 Bytes
2795186 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
/*
Copyright 2007 MySQL AB, 2008 Sun Microsystems
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as
published by the Free Software Foundation.
There are special exceptions to the terms and conditions of the GPL
as it is applied to this software. View the full text of the
exception in file EXCEPTIONS-CONNECTOR-J in the directory of this
software distribution.
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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package com.mysql.jdbc;
import java.sql.SQLException;
import java.sql.SQLClientInfoException;
import java.util.Properties;
/**
* Classes that implement this interface and provide a no-args constructor
* can be used by the driver to store and retrieve client information and/or
* labels.
*
* The driver will create an instance for each Connection instance, and call
* initialize() once and only once. When the connection is closed, destroy()
* will be called, and the provider is expected to clean up any resources at
* this time.
*
* @version $Id: $
*/
public interface JDBC4ClientInfoProvider {
/**
* Called once by the driver when it needs to configure the provider.
*
* @param conn the connection that the provider belongs too.
* @param configurationProps a java.util.Properties instance that contains
* configuration information for the connection.
* @throws SQLException if initialization fails.
*/
public void initialize(java.sql.Connection conn, Properties configurationProps) throws SQLException;
/**
* Called once by the driver when the connection this provider instance
* belongs to is being closed.
*
* Implementations are expected to clean up and resources at this point
* in time.
*
* @throws SQLException if an error occurs.
*/
public void destroy() throws SQLException;
/**
* Returns the client info for the connection that this provider
* instance belongs to. The connection instance is passed as an argument
* for convenience's sake.
*
* Providers can use the connection to communicate with the database,
* but it will be within the scope of any ongoing transactions, so therefore
* implementations should not attempt to change isolation level, autocommit settings
* or call rollback() or commit() on the connection.
*
* @param conn
* @return
* @throws SQLException
*
* @see java.sql.Connection#getClientInfo()
*/
public Properties getClientInfo(java.sql.Connection conn) throws SQLException;
/**
* Returns the client info for the connection that this provider
* instance belongs to. The connection instance is passed as an argument
* for convenience's sake.
*
* Providers can use the connection to communicate with the database,
* but it will be within the scope of any ongoing transactions, so therefore
* implementations should not attempt to change isolation level, autocommit settings
* or call rollback() or commit() on the connection.
*
* @param conn
* @return
* @throws SQLException
*
* @see java.sql.Connection#getClientInfo(java.lang.String)
*/
public String getClientInfo(java.sql.Connection conn, String name) throws SQLException;
/**
* Sets the client info for the connection that this provider
* instance belongs to. The connection instance is passed as an argument
* for convenience's sake.
*
* Providers can use the connection to communicate with the database,
* but it will be within the scope of any ongoing transactions, so therefore
* implementations should not attempt to change isolation level, autocommit settings
* or call rollback() or commit() on the connection.
*
* @param conn
* @return
* @throws SQLException
*
* @see java.sql.Connection#setClientInfo(java.util.Properties)
*/
public void setClientInfo(java.sql.Connection conn, Properties properties) throws SQLClientInfoException;
/**
* Sets the client info for the connection that this provider
* instance belongs to. The connection instance is passed as an argument
* for convenience's sake.
*
* Providers can use the connection to communicate with the database,
* but it will be within the scope of any ongoing transactions, so therefore
* implementations should not attempt to change isolation level, autocommit settings
* or call rollback() or commit() on the connection.
*
* @param conn
* @return
* @throws SQLException
*
* @see java.sql.Connection#setClientInfo(java.lang.String,java.lang.String)
*/
public void setClientInfo(java.sql.Connection conn, String name, String value) throws SQLClientInfoException;
}
|