Modifier and Type	Class and Description
public static interface	Protocol.ProtocolEventHandler
public static interface	Protocol.ProtocolEventListener

Method Summary

Modifier and Type	Method and Description
public void	afterHandshake()
public void	beforeHandshake()
public void	changeDatabase(String database)
public void	changeUser(String DB user name user, String DB user password password, String database name database) Re-authenticates as the given user and password
public M	Returns: a message ready for reading. checkErrorMessage() Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading
public void	close()
public void	configureTimeZone()
public void	connect(String DB user name user, String DB user password password, String database name database) Create a new session.
public AuthenticationProvider<M>	getAuthenticationProvider()
public ExceptionInterceptor	getExceptionInterceptor()
public InputStream	Returns: input stream getLocalInfileInputStream() Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement.
public MessageBuilder<M>	getMessageBuilder()
public PacketReceivedTimeHolder	getPacketReceivedTimeHolder()
public PacketSentTimeHolder	getPacketSentTimeHolder()
public PropertySet	getPropertySet()
public String	getQueryTimingUnits()
public ServerSession	getServerSession()
public SocketConnection	getSocketConnection()
public Supplier<ValueEncoder>	getValueEncoderSupplier(Object obj)
public void	init(Session `Session` session, SocketConnection `SocketConnection` socketConnection, PropertySet `PropertySet` propertySet, TransactionEventHandler `TransactionEventHandler` transactionManager) Init method takes the place of constructor.
public void	initServerSession()
public void	negotiateSSLConnection()
public <T extends ProtocolEntity> T	read(Class<T> requiredClass, ProtocolEntityFactory<T, M> protocolEntityFactory)
public < object extending the `ProtocolEntity` T extends ProtocolEntity> T	Returns: `ProtocolEntity` instance read(Class<Resultset> required Resultset class requiredClass, int the maximum number of rows to read (-1 means all rows) maxRows, boolean should the driver leave the results on the wire, and read them only when needed? streamResults, M the first packet of information in the result set resultPacket, boolean true if the binary protocol is used (for server prepared statements) isBinaryEncoded, ColumnDefinition use this metadata instead of the one provided on wire metadata, ProtocolEntityFactory<T, M> `ProtocolEntityFactory` instance protocolEntityFactory) Read protocol entity.
public M	Returns: the message from the server. readMessage(M `Message` instance to read into, may be null reuse) Read one message from the MySQL server into the reusable buffer if provided or into the new one.
public ColumnDefinition	readMetadata()
public < result type T extends QueryResult> T	Returns: `QueryResult` readQueryResult(ResultBuilder<T> `ResultBuilder` instance resultBuilder) Read messages from server and deliver them to resultBuilder.
public ServerCapabilities	Returns: `ServerCapabilities` readServerCapabilities() Retrieve ServerCapabilities from server.
public void	reset() Return Protocol to its initial state right after successful connect.
public void	send(Message `Message` instance message, int length of header + payload packetLen)
public M	Returns: the response packet from the server sendCommand(Message a packet pre-loaded with data for the protocol (eg. from a client-side prepared statement). The first byte of this packet is the MySQL protocol 'command' from MysqlDefs queryPacket, boolean do not call checkErrorPacket() if true skipCheck, int timeout timeoutMillis) Send a command to the MySQL server.
public void	setLocalInfileInputStream(InputStream input stream stream) Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement.
public void	setPacketReceivedTimeHolder(PacketReceivedTimeHolder packetReceivedTimeHolder)
public void	setPacketSentTimeHolder(PacketSentTimeHolder packetSentTimeHolder)
public void	setPropertySet(PropertySet propertySet)
public boolean	versionMeetsMinimum(int major, int minor, int subminor)

Method Detail

afterHandshake	back to summary
public void afterHandshake()

beforeHandshake	back to summary
public void beforeHandshake()

changeDatabase	back to summary
public void changeDatabase(String database)

changeUser	back to summary
public void changeUser(String user, String password, String database) Re-authenticates as the given user and password Parameters user:String DB user name password:String DB user password database:String database name

changeUser

back to summary

public void changeUser(String user, String password, String database)

Re-authenticates as the given user and password

Parameters

user:String: DB user name
password:String: DB user password
database:String: database name

checkErrorMessage	back to summary
public M checkErrorMessage() Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading Returns:M a message ready for reading.

checkErrorMessage

back to summary

public M checkErrorMessage()

Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading

Returns:M: a message ready for reading.

close	back to summary
public void close() throws IOException

configureTimeZone	back to summary
public void configureTimeZone()

connect	back to summary
public void connect(String user, String password, String database) Create a new session. This generally happens once at the beginning of a connection. Parameters user:String DB user name password:String DB user password database:String database name

connect

back to summary

public void connect(String user, String password, String database)

Create a new session. This generally happens once at the beginning of a connection.

Parameters

user:String: DB user name
password:String: DB user password
database:String: database name

getAuthenticationProvider	back to summary
public AuthenticationProvider<M> getAuthenticationProvider()

getExceptionInterceptor	back to summary
public ExceptionInterceptor getExceptionInterceptor()

getLocalInfileInputStream	back to summary
public InputStream getLocalInfileInputStream() Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement. This method returns NULL if no such stream has been set via setLocalInfileInputStream(). Returns:InputStream input stream

getLocalInfileInputStream

back to summary

public InputStream getLocalInfileInputStream()

Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement. This method returns NULL if no such stream has been set via setLocalInfileInputStream().

Returns:InputStream: input stream

getMessageBuilder	back to summary
public MessageBuilder<M> getMessageBuilder()

getPacketReceivedTimeHolder	back to summary
public PacketReceivedTimeHolder getPacketReceivedTimeHolder()

getPacketSentTimeHolder	back to summary
public PacketSentTimeHolder getPacketSentTimeHolder()

getPropertySet	back to summary
public PropertySet getPropertySet()

getQueryTimingUnits	back to summary
public String getQueryTimingUnits()

getServerSession	back to summary
public ServerSession getServerSession()

getSocketConnection	back to summary
public SocketConnection getSocketConnection()

getValueEncoderSupplier	back to summary
public Supplier<ValueEncoder> getValueEncoderSupplier(Object obj)

init back to summary

init	back to summary
public void init(Session session, SocketConnection socketConnection, PropertySet propertySet, TransactionEventHandler transactionManager) Init method takes the place of constructor. A constructor should be used unless the encapsulation of ProtocolFactory is necessary. Parameters session:Session `Session` socketConnection:SocketConnection `SocketConnection` propertySet:PropertySet `PropertySet` transactionManager:TransactionEventHandler `TransactionEventHandler`

public void init(Session session, SocketConnection socketConnection, PropertySet propertySet, TransactionEventHandler transactionManager)

Init method takes the place of constructor. A constructor should be used unless the encapsulation of ProtocolFactory is necessary.

Parameters

session:Session: Session
socketConnection:SocketConnection: SocketConnection
propertySet:PropertySet: PropertySet
transactionManager:TransactionEventHandler: TransactionEventHandler

initServerSession	back to summary
public void initServerSession()

negotiateSSLConnection	back to summary
public void negotiateSSLConnection()

read	back to summary
public <T extends ProtocolEntity> T read(Class<T> requiredClass, ProtocolEntityFactory<T, M> protocolEntityFactory) throws IOException

read back to summary

read	back to summary
public <T extends ProtocolEntity> T read(Class<Resultset> requiredClass, int maxRows, boolean streamResults, M resultPacket, boolean isBinaryEncoded, ColumnDefinition metadata, ProtocolEntityFactory<T, M> protocolEntityFactory) throws IOException Read protocol entity. Parameters <T> object extending the `ProtocolEntity` requiredClass:Class<Resultset> required Resultset class maxRows:int the maximum number of rows to read (-1 means all rows) streamResults:boolean should the driver leave the results on the wire, and read them only when needed? resultPacket:M the first packet of information in the result set isBinaryEncoded:boolean true if the binary protocol is used (for server prepared statements) metadata:ColumnDefinition use this metadata instead of the one provided on wire protocolEntityFactory:ProtocolEntityFactory<T, M> `ProtocolEntityFactory` instance Returns:T `ProtocolEntity` instance Exceptions IOException: if an error occurs

public <T extends ProtocolEntity> T read(Class<Resultset> requiredClass, int maxRows, boolean streamResults, M resultPacket, boolean isBinaryEncoded, ColumnDefinition metadata, ProtocolEntityFactory<T, M> protocolEntityFactory) throws IOException

Read protocol entity.

Parameters

<T>: object extending the ProtocolEntity
requiredClass:Class<Resultset>: required Resultset class
maxRows:int: the maximum number of rows to read (-1 means all rows)
streamResults:boolean: should the driver leave the results on the wire, and read them only when needed?
resultPacket:M: the first packet of information in the result set
isBinaryEncoded:boolean: true if the binary protocol is used (for server prepared statements)
metadata:ColumnDefinition: use this metadata instead of the one provided on wire
protocolEntityFactory:ProtocolEntityFactory<T, M>: ProtocolEntityFactory instance

Returns:T

ProtocolEntity instance

Exceptions

IOException:: if an error occurs

readMessage back to summary

readMessage	back to summary
public M readMessage(M reuse) Read one message from the MySQL server into the reusable buffer if provided or into the new one. Parameters reuse:M `Message` instance to read into, may be null Returns:M the message from the server.

public M readMessage(M reuse)

Read one message from the MySQL server into the reusable buffer if provided or into the new one.

Parameters

reuse:M: Message instance to read into, may be null

Returns:M

the message from the server.

readMetadata	back to summary
public ColumnDefinition readMetadata()

readQueryResult back to summary

readQueryResult	back to summary
public <T extends QueryResult> T readQueryResult(ResultBuilder<T> resultBuilder) Read messages from server and deliver them to resultBuilder. Parameters <T> result type resultBuilder:ResultBuilder<T> `ResultBuilder` instance Returns:T `QueryResult`

public <T extends QueryResult> T readQueryResult(ResultBuilder<T> resultBuilder)

Read messages from server and deliver them to resultBuilder.

Parameters

<T>: result type
resultBuilder:ResultBuilder<T>: ResultBuilder instance

Returns:T

QueryResult

readServerCapabilities back to summary

readServerCapabilities	back to summary
public ServerCapabilities readServerCapabilities() Retrieve ServerCapabilities from server. Returns:ServerCapabilities `ServerCapabilities`

public ServerCapabilities readServerCapabilities()

Retrieve ServerCapabilities from server.

Returns:ServerCapabilities: ServerCapabilities

reset	back to summary
public void reset() Return Protocol to its initial state right after successful connect.

send	back to summary
public void send(Message message, int packetLen) Parameters message:Message `Message` instance packetLen:int length of header + payload

sendCommand	back to summary
public M sendCommand(Message queryPacket, boolean skipCheck, int timeoutMillis) Send a command to the MySQL server. Parameters queryPacket:Message a packet pre-loaded with data for the protocol (eg. from a client-side prepared statement). The first byte of this packet is the MySQL protocol 'command' from MysqlDefs skipCheck:boolean do not call checkErrorPacket() if true timeoutMillis:int timeout Returns:M the response packet from the server Exceptions CJException: if an I/O error or SQL error occurs

sendCommand

back to summary

public M sendCommand(Message queryPacket, boolean skipCheck, int timeoutMillis)

Send a command to the MySQL server.

Parameters

queryPacket:Message: a packet pre-loaded with data for the protocol (eg. from a client-side prepared statement). The first byte of this packet is the MySQL protocol 'command' from MysqlDefs
skipCheck:boolean: do not call checkErrorPacket() if true
timeoutMillis:int: timeout

Returns:M

the response packet from the server

Exceptions

CJException:: if an I/O error or SQL error occurs

setLocalInfileInputStream	back to summary
public void setLocalInfileInputStream(InputStream stream) Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement. This stream will be read to completion upon execution of a "LOAD DATA LOCAL INFILE" statement, and will automatically be closed by the driver, so it needs to be reset before each call to execute*() that would cause the MySQL server to request data to fulfill the request for "LOAD DATA LOCAL INFILE". If this value is set to NULL, the driver will revert to using a FileInputStream or URLInputStream as required. Parameters stream:InputStream input stream

setLocalInfileInputStream

back to summary

public void setLocalInfileInputStream(InputStream stream)

Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement. This stream will be read to completion upon execution of a "LOAD DATA LOCAL INFILE" statement, and will automatically be closed by the driver, so it needs to be reset before each call to execute*() that would cause the MySQL server to request data to fulfill the request for "LOAD DATA LOCAL INFILE". If this value is set to NULL, the driver will revert to using a FileInputStream or URLInputStream as required.

Parameters

stream:InputStream: input stream

setPacketReceivedTimeHolder	back to summary
public void setPacketReceivedTimeHolder(PacketReceivedTimeHolder packetReceivedTimeHolder)

setPacketSentTimeHolder	back to summary
public void setPacketSentTimeHolder(PacketSentTimeHolder packetSentTimeHolder)

setPropertySet	back to summary
public void setPropertySet(PropertySet propertySet)

versionMeetsMinimum	back to summary
public boolean versionMeetsMinimum(int major, int minor, int subminor)

com.mysql.cj.protocol back to summary

public Interface Protocol.ProtocolEventHandler

Known Direct Implementers: com.mysql.cj.protocol.AbstractProtocol

Method Summary

Modifier and Type	Method and Description
public void	addListener(Protocol.ProtocolEventListener `ProtocolEventListener` instance. l) Add listener for this protocol events.
public void	invokeListeners(Protocol.ProtocolEventListener.EventType type, Throwable reason)
public void	removeListener(Protocol.ProtocolEventListener `ProtocolEventListener` instance. l) Remove protocol listener.

Method Detail

addListener back to summary

addListener	back to summary
public void addListener(Protocol.ProtocolEventListener l) Add listener for this protocol events. Parameters l:Protocol.ProtocolEventListener `ProtocolEventListener` instance.

public void addListener(Protocol.ProtocolEventListener l)

Add listener for this protocol events.

Parameters

l:Protocol.ProtocolEventListener: ProtocolEventListener instance.

invokeListeners	back to summary
public void invokeListeners(Protocol.ProtocolEventListener.EventType type, Throwable reason)

removeListener back to summary

removeListener	back to summary
public void removeListener(Protocol.ProtocolEventListener l) Remove protocol listener. Parameters l:Protocol.ProtocolEventListener `ProtocolEventListener` instance.

public void removeListener(Protocol.ProtocolEventListener l)

Remove protocol listener.

Parameters

l:Protocol.ProtocolEventListener: ProtocolEventListener instance.

com.mysql.cj.protocol back to summary

public Interface Protocol.ProtocolEventListener

Known Direct Implementers: com.mysql.cj.xdevapi.ClientImpl

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Protocol.ProtocolEventListener.EventType

Method Summary

Modifier and Type	Method and Description
public void	handleEvent(Protocol.ProtocolEventListener.EventType type, Object info, Throwable reason)

Method Detail

handleEvent	back to summary
public void handleEvent(Protocol.ProtocolEventListener.EventType type, Object info, Throwable reason)

com.mysql.cj.protocol back to summary

public final Enum Protocol.ProtocolEventListener.EventType

Class Inheritance

extends Enum<Protocol.ProtocolEventListener.EventType>

java.lang.Object
java.lang.Enum
com.mysql.cj.protocol.Protocol.ProtocolEventListener.EventType

Field Summary

Modifier and Type	Field and Description
public static final Protocol.ProtocolEventListener.EventType	SERVER_CLOSED_SESSION
public static final Protocol.ProtocolEventListener.EventType	SERVER_SHUTDOWN

Constructor Summary

Access	Constructor and Description
private	EventType()

Method Summary

Modifier and Type	Method and Description
public static Protocol.ProtocolEventListener.EventType	valueOf(String name)
public static Protocol.ProtocolEventListener.EventType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

SERVER_CLOSED_SESSION	back to summary
public static final Protocol.ProtocolEventListener.EventType SERVER_CLOSED_SESSION

SERVER_SHUTDOWN	back to summary
public static final Protocol.ProtocolEventListener.EventType SERVER_SHUTDOWN

Constructor Detail

EventType	back to summary
private EventType()

Method Detail

valueOf	back to summary
public static Protocol.ProtocolEventListener.EventType valueOf(String name)

values	back to summary
public static Protocol.ProtocolEventListener.EventType[] values()

public Interface Protocol<M extends Message>

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Protocol.ProtocolEventHandler

Method Summary

Method Detail

public Interface Protocol.ProtocolEventListener

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Protocol.ProtocolEventListener.EventType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail