Package org.mariadb.jdbc.message
Interface ClientMessage
- All Known Subinterfaces:
RedoableClientMessage
,RedoableWithPrepareClientMessage
- All Known Implementing Classes:
AuthMoreRawPacket
,BulkExecutePacket
,ChangeDbPacket
,ClosePreparePacket
,ExecutePacket
,HandshakeResponse
,LongDataPacket
,PingPacket
,PrepareExecutePacket
,PreparePacket
,QueryPacket
,QueryWithParametersPacket
,QuitPacket
,ResetPacket
,SslRequestPacket
public interface ClientMessage
-
Method Summary
Modifier and TypeMethodDescriptiondefault int
Number of parameter rows, and so expected return lengthdefault boolean
Are return value encoded in binary protocoldefault boolean
Can skip metadatadefault String
Message descriptionint
Encode client message to socket.default InputStream
Get current local infile input stream.default boolean
default Completion
readPacket
(Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, Reader reader, Writer writer, Context context, ExceptionFactory exceptionFactory, ClosableLock lock, boolean traceEnable, ClientMessage message, Consumer<String> redirectFct) default packet resultset parserdefault boolean
validateLocalFileName
(String fileName, Context context) Request for local file to be validated from current query.static boolean
validateLocalFileName
(String sql, Parameters parameters, String fileName, Context context) Check that file requested correspond to request.
-
Method Details
-
validateLocalFileName
static boolean validateLocalFileName(String sql, Parameters parameters, String fileName, Context context) Check that file requested correspond to request.- Parameters:
sql
- current command sqlparameters
- current command parameterfileName
- file path requestcontext
- current connection context- Returns:
- true if file name correspond to demand and query is a load local infile
-
encode
Encode client message to socket.- Parameters:
writer
- socket writercontext
- connection context- Returns:
- number of client message written
- Throws:
IOException
- if socket error occurSQLException
- if any issue occurs
-
batchUpdateLength
default int batchUpdateLength()Number of parameter rows, and so expected return length- Returns:
- batch update length
-
description
Message description- Returns:
- description
-
binaryProtocol
default boolean binaryProtocol()Are return value encoded in binary protocol- Returns:
- use binary protocol
-
canSkipMeta
default boolean canSkipMeta()Can skip metadata- Returns:
- can skip metadata
-
readPacket
default Completion readPacket(Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, Reader reader, Writer writer, Context context, ExceptionFactory exceptionFactory, ClosableLock lock, boolean traceEnable, ClientMessage message, Consumer<String> redirectFct) throws IOException, SQLException default packet resultset parser- Parameters:
stmt
- callerfetchSize
- fetch sizemaxRows
- maximum number of rowsresultSetConcurrency
- resultset concurrencyresultSetType
- resultset typecloseOnCompletion
- must close caller on result parsing endreader
- packet readerwriter
- packet writercontext
- connection contextexceptionFactory
- connection exception factorylock
- thread safe lockstraceEnable
- is logging trace enablemessage
- client messageredirectFct
- redirect consumer- Returns:
- results
- Throws:
IOException
- if any socket error occursSQLException
- for other kind of errors
-
getLocalInfileInputStream
Get current local infile input stream.- Returns:
- default to null
-
mightBeBulkResult
default boolean mightBeBulkResult() -
validateLocalFileName
Request for local file to be validated from current query.- Parameters:
fileName
- server file request pathcontext
- current connection context- Returns:
- true if file name correspond to demand and query is a load local infile
-