Class JDBC4CommentClientInfoProvider

java.lang.Object

com.mysql.jdbc.JDBC4CommentClientInfoProvider

All Implemented Interfaces:

JDBC4ClientInfoProvider

public class JDBC4CommentClientInfoProvider
extends Object
implements JDBC4ClientInfoProvider

An implementation of JDBC4ClientInfoProvider that exposes the client info as a comment prepended to all statements issued by the driver. Client information is never read from the server with this implementation, it is always cached locally.

Constructor Summary

Constructors

Constructor	Description
JDBC4CommentClientInfoProvider()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Called once by the driver when the connection this provider instance belongs to is being closed.
Properties	getClientInfo(Connection conn)	Returns the client info for the connection that this provider instance belongs to.
String	getClientInfo(Connection conn, String name)	Returns the client info for the connection that this provider instance belongs to.
void	initialize(Connection conn, Properties configurationProps)	Called once by the driver when it needs to configure the provider.
void	setClientInfo(Connection conn, String name, String value)	Sets the client info for the connection that this provider instance belongs to.
void	setClientInfo(Connection conn, Properties properties)	Sets the client info for the connection that this provider instance belongs to.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JDBC4CommentClientInfoProvider

public JDBC4CommentClientInfoProvider()

Method Details

initialize

public void initialize(Connection conn,
 Properties configurationProps)
                throws SQLException

Description copied from interface: JDBC4ClientInfoProvider

Called once by the driver when it needs to configure the provider.

Specified by:

initialize in interface JDBC4ClientInfoProvider

Parameters:

conn - the connection that the provider belongs too.

configurationProps - a java.util.Properties instance that contains configuration information for the connection.

Throws:

SQLException - if initialization fails.

destroy

public void destroy()
             throws SQLException

Description copied from interface: JDBC4ClientInfoProvider

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.

Specified by:

destroy in interface JDBC4ClientInfoProvider

Throws:

SQLException - if an error occurs.

getClientInfo

public Properties getClientInfo(Connection conn)
                         throws SQLException

Description copied from interface: JDBC4ClientInfoProvider

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.

Specified by:

getClientInfo in interface JDBC4ClientInfoProvider

Parameters:

conn -

Returns:

Throws:

SQLException

See Also:

• Connection.getClientInfo()

getClientInfo

public String getClientInfo(Connection conn,
 String name)
                     throws SQLException

Description copied from interface: JDBC4ClientInfoProvider

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.

Specified by:

getClientInfo in interface JDBC4ClientInfoProvider

Parameters:

conn -

Returns:

Throws:

SQLException

See Also:

• Connection.getClientInfo(java.lang.String)

setClientInfo

public void setClientInfo(Connection conn,
 Properties properties)
                   throws SQLClientInfoException

Description copied from interface: JDBC4ClientInfoProvider

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.

Specified by:

setClientInfo in interface JDBC4ClientInfoProvider

Parameters:

conn -

Throws:

SQLClientInfoException

See Also:

• Connection.setClientInfo(java.util.Properties)

setClientInfo

public void setClientInfo(Connection conn,
 String name,
 String value)
                   throws SQLClientInfoException

Description copied from interface: JDBC4ClientInfoProvider

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.

Specified by:

setClientInfo in interface JDBC4ClientInfoProvider

Parameters:

conn -

Throws:

SQLClientInfoException

See Also:

• Connection.setClientInfo(java.lang.String,java.lang.String)