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
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default int
batchUpdateLength()
Number of parameter rows, and so expected return lengthdefault boolean
binaryProtocol()
Are return value encoded in binary protocoldefault boolean
canSkipMeta()
Can skip metadatadefault java.lang.String
description()
Message descriptionint
encode(Writer writer, Context context)
Encode client message to socket.default java.io.InputStream
getLocalInfileInputStream()
Get current local infile input stream.default boolean
mightBeBulkResult()
Indicating if result might be a COM_STMT_BULK resultdefault 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, java.util.function.Consumer<java.lang.String> redirectFct)
default packet resultset parserdefault boolean
validateLocalFileName(java.lang.String fileName, Context context)
Request for local file to be validated from current query.static boolean
validateLocalFileName(java.lang.String sql, Parameters parameters, java.lang.String fileName, Context context)
Check that file requested correspond to request.
-
-
-
Method Detail
-
validateLocalFileName
static boolean validateLocalFileName(java.lang.String sql, Parameters parameters, java.lang.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
int encode(Writer writer, Context context) throws java.io.IOException, java.sql.SQLException
Encode client message to socket.- Parameters:
writer
- socket writercontext
- connection context- Returns:
- number of client message written
- Throws:
java.io.IOException
- if socket error occurjava.sql.SQLException
- if any issue occurs
-
batchUpdateLength
default int batchUpdateLength()
Number of parameter rows, and so expected return length- Returns:
- batch update length
-
description
default java.lang.String 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, java.util.function.Consumer<java.lang.String> redirectFct) throws java.io.IOException, java.sql.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:
java.io.IOException
- if any socket error occursjava.sql.SQLException
- for other kind of errors
-
getLocalInfileInputStream
default java.io.InputStream getLocalInfileInputStream()
Get current local infile input stream.- Returns:
- default to null
-
mightBeBulkResult
default boolean mightBeBulkResult()
Indicating if result might be a COM_STMT_BULK result- Returns:
- true if so.
-
validateLocalFileName
default boolean validateLocalFileName(java.lang.String fileName, Context context)
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
-
-