Class AbstractConnectProtocol
- java.lang.Object
-
- org.mariadb.jdbc.internal.protocol.AbstractConnectProtocol
-
- All Implemented Interfaces:
Protocol
- Direct Known Subclasses:
AbstractQueryProtocol
public abstract class AbstractConnectProtocol extends Object implements Protocol
-
-
Field Summary
Fields Modifier and Type Field Description Results
activeStreamingResult
protected int
autoIncrementIncrement
protected static String
CHECK_GALERA_STATE_QUERY
protected boolean
connected
protected String
database
protected boolean
eofDeprecated
protected ExceptionFactory
exceptionFactory
protected boolean
explicitClosed
protected List<String>
galeraAllowedStates
boolean
hasWarnings
protected ReentrantLock
lock
protected Options
options
protected FailoverProxy
proxy
protected PacketInputStream
reader
protected boolean
readOnly
protected long
serverCapabilities
protected ServerPrepareStatementCache
serverPrepareStatementCache
short
serverStatus
protected long
serverThreadId
protected Socket
socket
protected int
socketTimeout
protected LruTraceCache
traceCache
protected UrlParser
urlParser
protected PacketOutputStream
writer
-
Constructor Summary
Constructors Constructor Description AbstractConnectProtocol(UrlParser urlParser, GlobalStateInfo globalInfo, ReentrantLock lock, LruTraceCache traceCache)
Get a protocol instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
abort()
Force closes socket and stream readers/writers.void
changeSocketSoTimeout(int setSoTimeout)
void
changeSocketTcpNoDelay(boolean setTcpNoDelay)
Change Socket TcpNoDelay option.boolean
checkIfMaster()
Check that current connection is a master connection (not read-only).void
close()
Closes socket and stream readers/writers Attempts graceful shutdown.void
connect()
Connect to currentHost.void
connectWithoutProxy()
Connect without proxy.void
destroySocket()
Closing socket in case of Connection error after socket creation.abstract void
executeQuery(String sql)
Results
getActiveStreamingResult()
String
getDatabase()
String
getHost()
HostAddress
getHostAddress()
ReentrantLock
getLock()
int
getMajorServerVersion()
int
getMinorServerVersion()
Options
getOptions()
int
getPatchServerVersion()
boolean
getPinGlobalTxToPhysicalConnection()
int
getPort()
FailoverProxy
getProxy()
PacketInputStream
getReader()
boolean
getReadonly()
long
getServerThreadId()
String
getServerVersion()
Socket
getSocket()
String
getSocketIp()
TimeZone
getTimeZone()
String
getTraces()
Get a String containing readable information about last 10 send/received packets.UrlParser
getUrlParser()
String
getUsername()
boolean
hasMoreResults()
boolean
hasWarnings()
Has warnings.boolean
isClosed()
Is the connection closed.boolean
isConnected()
Is connected.boolean
isEofDeprecated()
boolean
isExplicitClosed()
boolean
isMasterConnection()
Indicate if current protocol is a master protocol.boolean
isServerMariaDb()
boolean
mustBeMasterConnection()
boolean
noBackslashEscapes()
ServerPrepareStatementCache
prepareStatementCache()
void
readEofPacket()
Check that next read packet is a End-of-file packet.void
readPipelineCheckMaster()
void
removeActiveStreamingResult()
Remove exception result and since totally fetched, set fetch size to 0.void
removeHasMoreResults()
Remove flag has more results.boolean
sessionStateAware()
void
setActiveStreamingResult(Results activeStreamingResult)
void
setHasWarnings(boolean hasWarnings)
void
setHostAddress(HostAddress host)
void
setHostFailedWithoutProxy()
void
setProxy(FailoverProxy proxy)
void
setServerStatus(short serverStatus)
boolean
shouldReconnectWithoutProxy()
Indicate for Old reconnection if can reconnect without throwing exception.void
skip()
Skip packets not read that are not needed.void
skipEofPacket()
Check that next read packet is a End-of-file packet.boolean
versionGreaterOrEqual(int major, int minor, int patch)
Utility method to check if database version is greater than parameters.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.mariadb.jdbc.internal.protocol.Protocol
cancelCurrentQuery, closeExplicit, executeBatchClient, executeBatchServer, executeBatchStmt, executePreparedQuery, executeQuery, executeQuery, executeQuery, executeQuery, forceReleasePrepareStatement, forceReleaseWaitingPrepareStatement, getAutocommit, getAutoIncrementIncrement, getCatalog, getMaxRows, getResult, getTimeout, getTransactionIsolationLevel, handleIoException, interrupt, inTransaction, isInterrupted, isValid, ping, prepare, prolog, prologProxy, putInCache, releasePrepareStatement, reset, resetDatabase, resetStateAfterFailover, rollback, setActiveFutureTask, setCatalog, setLocalInfileInputStream, setMaxRows, setReadonly, setTimeout, setTransactionIsolation, stopIfInterrupted
-
-
-
-
Field Detail
-
CHECK_GALERA_STATE_QUERY
protected static final String CHECK_GALERA_STATE_QUERY
- See Also:
- Constant Field Values
-
lock
protected final ReentrantLock lock
-
urlParser
protected final UrlParser urlParser
-
options
protected final Options options
-
traceCache
protected final LruTraceCache traceCache
-
hasWarnings
public boolean hasWarnings
-
activeStreamingResult
public Results activeStreamingResult
-
serverStatus
public short serverStatus
-
autoIncrementIncrement
protected int autoIncrementIncrement
-
socket
protected Socket socket
-
writer
protected PacketOutputStream writer
-
readOnly
protected boolean readOnly
-
reader
protected PacketInputStream reader
-
proxy
protected FailoverProxy proxy
-
connected
protected volatile boolean connected
-
explicitClosed
protected boolean explicitClosed
-
database
protected String database
-
serverThreadId
protected long serverThreadId
-
serverPrepareStatementCache
protected ServerPrepareStatementCache serverPrepareStatementCache
-
eofDeprecated
protected boolean eofDeprecated
-
serverCapabilities
protected long serverCapabilities
-
socketTimeout
protected int socketTimeout
-
exceptionFactory
protected ExceptionFactory exceptionFactory
-
-
Constructor Detail
-
AbstractConnectProtocol
public AbstractConnectProtocol(UrlParser urlParser, GlobalStateInfo globalInfo, ReentrantLock lock, LruTraceCache traceCache)
Get a protocol instance.- Parameters:
urlParser
- connection URL informationglobalInfo
- server global variables informationlock
- the lock for thread synchronisationtraceCache
- trace cache
-
-
Method Detail
-
close
public void close()
Closes socket and stream readers/writers Attempts graceful shutdown.
-
abort
public void abort()
Force closes socket and stream readers/writers.
-
skip
public void skip() throws SQLException
Skip packets not read that are not needed. Packets are read according to needs. If some data have not been read before next execution, skip it. Lock must be set before using this method- Specified by:
skip
in interfaceProtocol
- Throws:
SQLException
- exception
-
setServerStatus
public void setServerStatus(short serverStatus)
- Specified by:
setServerStatus
in interfaceProtocol
-
removeHasMoreResults
public void removeHasMoreResults()
Remove flag has more results.- Specified by:
removeHasMoreResults
in interfaceProtocol
-
connect
public void connect() throws SQLException
Connect to currentHost.- Specified by:
connect
in interfaceProtocol
- Throws:
SQLException
- exception
-
destroySocket
public void destroySocket()
Closing socket in case of Connection error after socket creation.
-
isClosed
public boolean isClosed()
Is the connection closed.
-
checkIfMaster
public boolean checkIfMaster() throws SQLException
Check that current connection is a master connection (not read-only).- Specified by:
checkIfMaster
in interfaceProtocol
- Returns:
- true if master
- Throws:
SQLException
- if requesting infos for server fail.
-
readEofPacket
public void readEofPacket() throws SQLException, IOException
Check that next read packet is a End-of-file packet.- Specified by:
readEofPacket
in interfaceProtocol
- Throws:
SQLException
- if not a End-of-file packetIOException
- if connection error occur
-
skipEofPacket
public void skipEofPacket() throws SQLException, IOException
Check that next read packet is a End-of-file packet.- Specified by:
skipEofPacket
in interfaceProtocol
- Throws:
SQLException
- if not a End-of-file packetIOException
- if connection error occur
-
setHostFailedWithoutProxy
public void setHostFailedWithoutProxy()
- Specified by:
setHostFailedWithoutProxy
in interfaceProtocol
-
getUrlParser
public UrlParser getUrlParser()
- Specified by:
getUrlParser
in interfaceProtocol
-
isMasterConnection
public boolean isMasterConnection()
Indicate if current protocol is a master protocol.- Specified by:
isMasterConnection
in interfaceProtocol
- Returns:
- is master flag
-
readPipelineCheckMaster
public void readPipelineCheckMaster() throws SQLException
- Throws:
SQLException
-
mustBeMasterConnection
public boolean mustBeMasterConnection()
- Specified by:
mustBeMasterConnection
in interfaceProtocol
-
noBackslashEscapes
public boolean noBackslashEscapes()
- Specified by:
noBackslashEscapes
in interfaceProtocol
-
connectWithoutProxy
public void connectWithoutProxy() throws SQLException
Connect without proxy. (use basic failover implementation)- Specified by:
connectWithoutProxy
in interfaceProtocol
- Throws:
SQLException
- exception
-
shouldReconnectWithoutProxy
public boolean shouldReconnectWithoutProxy()
Indicate for Old reconnection if can reconnect without throwing exception.- Specified by:
shouldReconnectWithoutProxy
in interfaceProtocol
- Returns:
- true if can reconnect without issue
-
getServerVersion
public String getServerVersion()
- Specified by:
getServerVersion
in interfaceProtocol
-
getReadonly
public boolean getReadonly()
- Specified by:
getReadonly
in interfaceProtocol
-
getHostAddress
public HostAddress getHostAddress()
- Specified by:
getHostAddress
in interfaceProtocol
-
getSocketIp
public String getSocketIp()
-
setHostAddress
public void setHostAddress(HostAddress host)
- Specified by:
setHostAddress
in interfaceProtocol
-
getProxy
public FailoverProxy getProxy()
-
setProxy
public void setProxy(FailoverProxy proxy)
-
getDatabase
public String getDatabase()
- Specified by:
getDatabase
in interfaceProtocol
-
getUsername
public String getUsername()
- Specified by:
getUsername
in interfaceProtocol
-
getMajorServerVersion
public int getMajorServerVersion()
- Specified by:
getMajorServerVersion
in interfaceProtocol
-
getMinorServerVersion
public int getMinorServerVersion()
- Specified by:
getMinorServerVersion
in interfaceProtocol
-
getPatchServerVersion
public int getPatchServerVersion()
- Specified by:
getPatchServerVersion
in interfaceProtocol
-
versionGreaterOrEqual
public boolean versionGreaterOrEqual(int major, int minor, int patch)
Utility method to check if database version is greater than parameters.- Specified by:
versionGreaterOrEqual
in interfaceProtocol
- Parameters:
major
- major versionminor
- minor versionpatch
- patch version- Returns:
- true if version is greater than parameters
-
getPinGlobalTxToPhysicalConnection
public boolean getPinGlobalTxToPhysicalConnection()
- Specified by:
getPinGlobalTxToPhysicalConnection
in interfaceProtocol
-
hasWarnings
public boolean hasWarnings()
Has warnings.- Specified by:
hasWarnings
in interfaceProtocol
- Returns:
- true if as warnings.
-
isConnected
public boolean isConnected()
Is connected.- Specified by:
isConnected
in interfaceProtocol
- Returns:
- true if connected
-
getServerThreadId
public long getServerThreadId()
- Specified by:
getServerThreadId
in interfaceProtocol
-
isExplicitClosed
public boolean isExplicitClosed()
- Specified by:
isExplicitClosed
in interfaceProtocol
-
getTimeZone
public TimeZone getTimeZone()
- Specified by:
getTimeZone
in interfaceProtocol
-
getOptions
public Options getOptions()
- Specified by:
getOptions
in interfaceProtocol
-
setHasWarnings
public void setHasWarnings(boolean hasWarnings)
- Specified by:
setHasWarnings
in interfaceProtocol
-
getActiveStreamingResult
public Results getActiveStreamingResult()
- Specified by:
getActiveStreamingResult
in interfaceProtocol
-
setActiveStreamingResult
public void setActiveStreamingResult(Results activeStreamingResult)
- Specified by:
setActiveStreamingResult
in interfaceProtocol
-
removeActiveStreamingResult
public void removeActiveStreamingResult()
Remove exception result and since totally fetched, set fetch size to 0.- Specified by:
removeActiveStreamingResult
in interfaceProtocol
-
getLock
public ReentrantLock getLock()
-
hasMoreResults
public boolean hasMoreResults()
- Specified by:
hasMoreResults
in interfaceProtocol
-
prepareStatementCache
public ServerPrepareStatementCache prepareStatementCache()
- Specified by:
prepareStatementCache
in interfaceProtocol
-
executeQuery
public abstract void executeQuery(String sql) throws SQLException
- Specified by:
executeQuery
in interfaceProtocol
- Throws:
SQLException
-
changeSocketTcpNoDelay
public void changeSocketTcpNoDelay(boolean setTcpNoDelay)
Change Socket TcpNoDelay option.- Specified by:
changeSocketTcpNoDelay
in interfaceProtocol
- Parameters:
setTcpNoDelay
- value to set.
-
changeSocketSoTimeout
public void changeSocketSoTimeout(int setSoTimeout) throws SocketException
- Specified by:
changeSocketSoTimeout
in interfaceProtocol
- Throws:
SocketException
-
isServerMariaDb
public boolean isServerMariaDb()
- Specified by:
isServerMariaDb
in interfaceProtocol
-
getReader
public PacketInputStream getReader()
-
isEofDeprecated
public boolean isEofDeprecated()
- Specified by:
isEofDeprecated
in interfaceProtocol
-
sessionStateAware
public boolean sessionStateAware()
- Specified by:
sessionStateAware
in interfaceProtocol
-
-