com.mysql.cj.protocol

Class AbstractProtocol<M extends Message>

java.lang.Object

com.mysql.cj.protocol.AbstractProtocol<M>

All Implemented Interfaces:

Protocol<M>, Protocol.ProtocolEventHandler

Direct Known Subclasses:

NativeProtocol, XProtocol

public abstract class AbstractProtocol<M extends Message>
extends java.lang.Object
implements Protocol<M>, Protocol.ProtocolEventHandler

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.protocol.Protocol

Protocol.ProtocolEventHandler, Protocol.ProtocolEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationProvider<M>	authProvider
protected ExceptionInterceptor	exceptionInterceptor
protected Log	log The logger we're going to use
protected MessageBuilder<M>	messageBuilder
protected java.util.LinkedList<java.lang.StringBuilder>	packetDebugRingBuffer
protected PropertySet	propertySet
protected java.lang.String	queryTimingUnits
protected Session	session
protected SocketConnection	socketConnection
protected TransactionEventHandler	transactionManager
protected boolean	useNanosForElapsedTime

Constructor Summary

Constructors

Constructor and Description
AbstractProtocol()

Method Summary

Modifier and Type	Method and Description
void	addListener(Protocol.ProtocolEventListener l) Add listener for this protocol events.
AuthenticationProvider<M>	getAuthenticationProvider()
ExceptionInterceptor	getExceptionInterceptor()
MessageBuilder<M>	getMessageBuilder()
PacketReceivedTimeHolder	getPacketReceivedTimeHolder()
PacketSentTimeHolder	getPacketSentTimeHolder()
PropertySet	getPropertySet()
java.lang.String	getQueryTimingUnits()
SocketConnection	getSocketConnection()
void	init(Session sess, SocketConnection phConnection, PropertySet propSet, TransactionEventHandler trManager) Init method takes the place of constructor.
void	invokeListeners(Protocol.ProtocolEventListener.EventType type, java.lang.Throwable reason)
void	removeListener(Protocol.ProtocolEventListener listener) Remove protocol listener.
void	reset() Return Protocol to its initial state right after successful connect.
void	setPacketReceivedTimeHolder(PacketReceivedTimeHolder packetReceivedTimeHolder)
void	setPacketSentTimeHolder(PacketSentTimeHolder packetSentTimeHolder)
void	setPropertySet(PropertySet propertySet)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mysql.cj.protocol.Protocol

afterHandshake, beforeHandshake, changeDatabase, changeUser, checkErrorMessage, close, configureTimeZone, connect, getLocalInfileInputStream, getQueryComment, getServerSession, getValueEncoderSupplier, initServerSession, negotiateSSLConnection, read, read, readMessage, readMetadata, readQueryResult, readServerCapabilities, send, sendCommand, setLocalInfileInputStream, setQueryComment, versionMeetsMinimum

Field Detail

session

protected Session session

socketConnection

protected SocketConnection socketConnection

propertySet

protected PropertySet propertySet

transactionManager

protected TransactionEventHandler transactionManager

log

protected transient Log log

The logger we're going to use

exceptionInterceptor

protected ExceptionInterceptor exceptionInterceptor

authProvider

protected AuthenticationProvider<M extends Message> authProvider

messageBuilder

protected MessageBuilder<M extends Message> messageBuilder

packetDebugRingBuffer

protected java.util.LinkedList<java.lang.StringBuilder> packetDebugRingBuffer

useNanosForElapsedTime

protected boolean useNanosForElapsedTime

queryTimingUnits

protected java.lang.String queryTimingUnits

Constructor Detail

AbstractProtocol

public AbstractProtocol()

Method Detail

init

public void init(Session sess,
                 SocketConnection phConnection,
                 PropertySet propSet,
                 TransactionEventHandler trManager)

Description copied from interface: Protocol

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

Specified by:

init in interface Protocol<M extends Message>

Parameters:

sess - Session

phConnection - SocketConnection

propSet - PropertySet

trManager - TransactionEventHandler

getSocketConnection

public SocketConnection getSocketConnection()

Specified by:

getSocketConnection in interface Protocol<M extends Message>

getAuthenticationProvider

public AuthenticationProvider<M> getAuthenticationProvider()

Specified by:

getAuthenticationProvider in interface Protocol<M extends Message>

getExceptionInterceptor

public ExceptionInterceptor getExceptionInterceptor()

Specified by:

getExceptionInterceptor in interface Protocol<M extends Message>

getPacketSentTimeHolder

public PacketSentTimeHolder getPacketSentTimeHolder()

Specified by:

getPacketSentTimeHolder in interface Protocol<M extends Message>

setPacketSentTimeHolder

public void setPacketSentTimeHolder(PacketSentTimeHolder packetSentTimeHolder)

Specified by:

setPacketSentTimeHolder in interface Protocol<M extends Message>

getPacketReceivedTimeHolder

public PacketReceivedTimeHolder getPacketReceivedTimeHolder()

Specified by:

getPacketReceivedTimeHolder in interface Protocol<M extends Message>

setPacketReceivedTimeHolder

public void setPacketReceivedTimeHolder(PacketReceivedTimeHolder packetReceivedTimeHolder)

Specified by:

setPacketReceivedTimeHolder in interface Protocol<M extends Message>

getPropertySet

public PropertySet getPropertySet()

Specified by:

getPropertySet in interface Protocol<M extends Message>

setPropertySet

public void setPropertySet(PropertySet propertySet)

Specified by:

setPropertySet in interface Protocol<M extends Message>

getMessageBuilder

public MessageBuilder<M> getMessageBuilder()

Specified by:

getMessageBuilder in interface Protocol<M extends Message>

reset

public void reset()

Description copied from interface: Protocol

Return Protocol to its initial state right after successful connect.

Specified by:

reset in interface Protocol<M extends Message>

getQueryTimingUnits

public java.lang.String getQueryTimingUnits()

Specified by:

getQueryTimingUnits in interface Protocol<M extends Message>

addListener

public void addListener(Protocol.ProtocolEventListener l)

Description copied from interface: Protocol.ProtocolEventHandler

Add listener for this protocol events.

Specified by:

addListener in interface Protocol.ProtocolEventHandler

Parameters:

l - Protocol.ProtocolEventListener instance.

removeListener

public void removeListener(Protocol.ProtocolEventListener listener)

Description copied from interface: Protocol.ProtocolEventHandler

Remove protocol listener.

Specified by:

removeListener in interface Protocol.ProtocolEventHandler

Parameters:

listener - Protocol.ProtocolEventListener instance.

invokeListeners

public void invokeListeners(Protocol.ProtocolEventListener.EventType type,
                            java.lang.Throwable reason)

Specified by:

invokeListeners in interface Protocol.ProtocolEventHandler