com.oceanbase.jdbc.internal.com.send.parameters

Class StreamParameter

java.lang.Object

com.oceanbase.jdbc.internal.com.send.parameters.StreamParameter

All Implemented Interfaces:

LongDataParameterHolder, ParameterHolder, Cloneable

public class StreamParameter
extends Object
implements Cloneable, LongDataParameterHolder

Field Summary

Fields inherited from interface com.oceanbase.jdbc.internal.com.send.parameters.LongDataParameterHolder

BLOB_STREAM_READ_BUF_SIZE

Fields inherited from interface com.oceanbase.jdbc.internal.com.send.parameters.ParameterHolder

BINARY_INTRODUCER, QUOTE

Constructor Summary

Constructors

Constructor and Description
StreamParameter(InputStream is, boolean noBackSlashEscapes)
StreamParameter(InputStream is, long length, boolean noBackslashEscapes) Constructor.
StreamParameter(Lob lob, long length, boolean noBackslashEscapes)

Method Summary

Modifier and Type	Method and Description
int	getApproximateTextProtocolLength() Return approximated data calculated length.
ColumnType	getColumnType()
boolean	isLongData()
boolean	isNullData()
String	toString()
void	writeBinary(PacketOutputStream pos) Write data to socket in binary format.
boolean	writeLongData(PacketOutputStream writer, Options options, int statementId, short paramIndex) Read the data in InputStream and send Long Data Packet in batches according to the size of blobSendChunkSize
boolean	writePieceData(PacketOutputStream pos, boolean first, Options options) Never used
void	writeTo(PacketOutputStream pos) Write stream in text format.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamParameter

public StreamParameter(InputStream is,
                       long length,
                       boolean noBackslashEscapes)

Constructor.

Parameters:

is - stream to write

length - max length to write (if null the whole stream will be send)

noBackslashEscapes - must backslash be escape

StreamParameter

public StreamParameter(Lob lob,
                       long length,
                       boolean noBackslashEscapes)

StreamParameter

public StreamParameter(InputStream is,
                       boolean noBackSlashEscapes)

Method Detail

writeTo

public void writeTo(PacketOutputStream pos)
             throws IOException

Write stream in text format.

Specified by:

writeTo in interface ParameterHolder

Parameters:

pos - database outputStream

Throws:

IOException - if any error occur when reader stream

getApproximateTextProtocolLength

public int getApproximateTextProtocolLength()

Return approximated data calculated length.

Specified by:

getApproximateTextProtocolLength in interface ParameterHolder

Returns:

approximated data length.

writeBinary

public void writeBinary(PacketOutputStream pos)
                 throws IOException

Write data to socket in binary format.

Specified by:

writeBinary in interface ParameterHolder

Parameters:

pos - socket output stream

Throws:

IOException - if socket error occur

toString

public String toString()

Specified by:

toString in interface ParameterHolder

Overrides:

toString in class Object

getColumnType

public ColumnType getColumnType()

Specified by:

getColumnType in interface ParameterHolder

isNullData

public boolean isNullData()

Specified by:

isNullData in interface ParameterHolder

isLongData

public boolean isLongData()

Specified by:

isLongData in interface ParameterHolder

writePieceData

public boolean writePieceData(PacketOutputStream pos,
                              boolean first,
                              Options options)
                       throws IOException

Never used

Specified by:

writePieceData in interface LongDataParameterHolder

Parameters:

pos -

first -

options -

Returns:

Throws:

IOException

writeLongData

public boolean writeLongData(PacketOutputStream writer,
                             Options options,
                             int statementId,
                             short paramIndex)
                      throws IOException

Read the data in InputStream and send Long Data Packet in batches according to the size of blobSendChunkSize

Specified by:

writeLongData in interface LongDataParameterHolder

Parameters:

writer - PacketOutputStream with socket

options - Connection options

statementId - Current statement id

paramIndex - Current parameter index

Returns:

No effect, temporarily reserved

Throws:

IOException