org.mariadb.jdbc.MariaDbBlob Maven / Gradle / Ivy
Show all versions of mariadb-java-client Show documentation
/*
*
* MariaDB Client for Java
*
* Copyright (c) 2012-2014 Monty Program Ab.
* Copyright (c) 2015-2019 MariaDB Ab.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License along
* with this library; if not, write to Monty Program Ab [email protected].
*
* This particular MariaDB Client for Java file is work
* derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
* the following copyright and notice provisions:
*
* Copyright (c) 2009-2011, Marcus Eriksson
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* Neither the name of the driver nor the names of its contributors may not be
* used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
*/
package org.mariadb.jdbc;
import org.mariadb.jdbc.internal.util.exceptions.*;
import java.io.*;
import java.sql.*;
import java.util.*;
public class MariaDbBlob implements Blob, Serializable {
private static final long serialVersionUID = -4736603161284649490L;
protected byte[] data;
protected transient int offset;
protected transient int length;
/** Creates an empty blob. */
public MariaDbBlob() {
data = new byte[0];
offset = 0;
length = 0;
}
/**
* Creates a blob with content.
*
* @param bytes the content for the blob.
*/
public MariaDbBlob(byte[] bytes) {
if (bytes == null) {
throw new NullPointerException("byte array is null");
}
data = bytes;
offset = 0;
length = bytes.length;
}
/**
* Creates a blob with content.
*
* @param bytes the content for the blob.
* @param offset offset
* @param length length
*/
public MariaDbBlob(byte[] bytes, int offset, int length) {
if (bytes == null) {
throw new NullPointerException("byte array is null");
}
data = bytes;
this.offset = offset;
this.length = Math.min(bytes.length - offset, length);
}
private void writeObject(ObjectOutputStream out) throws IOException {
if (offset != 0 || data.length != length) {
data = Arrays.copyOfRange(data, offset, offset + length);
offset = 0;
length = 0;
}
out.defaultWriteObject();
}
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
offset = 0;
length = data.length;
}
/**
* Returns the number of bytes in the BLOB value designated by this Blob
* object.
*
* @return length of the BLOB in bytes
*/
public long length() {
return length;
}
/**
* Retrieves all or part of the BLOB value that this Blob object
* represents, as an array of bytes. This byte array contains up to length
* consecutive bytes starting at position pos.
*
* @param pos the ordinal position of the first byte in the BLOB value to be
* extracted; the first byte is at position 1
* @param length the number of consecutive bytes to be copied; the value for length must be 0 or
* greater
* @return a byte array containing up to length consecutive bytes from the BLOB
* value designated by this Blob object, starting with the byte at
* position pos
* @throws SQLException if there is an error accessing the BLOB value; if pos is less
* than 1 or length is less than 0
* @see #setBytes
* @since 1.2
*/
public byte[] getBytes(final long pos, final int length) throws SQLException {
if (pos < 1) {
throw ExceptionMapper.getSqlException("Pos starts at 1");
}
final int offset = this.offset + (int) (pos - 1);
byte[] result = new byte[length];
System.arraycopy(data, offset, result, 0, Math.min(this.length - (int) (pos - 1), length));
return result;
}
/**
* Retrieves the BLOB value designated by this Blob instance as a
* stream.
*
* @return a stream containing the BLOB data
* @throws SQLException if something went wrong
* @see #setBinaryStream
*/
public InputStream getBinaryStream() throws SQLException {
return getBinaryStream(1, length);
}
/**
* Returns an InputStream object that contains a partial Blob value,
* starting with the byte specified by pos, which is length bytes in length.
*
* @param pos the offset to the first byte of the partial value to be retrieved. The first byte in
* the Blob is at position 1
* @param length the length in bytes of the partial value to be retrieved
* @return InputStream through which the partial Blob value can be read.
* @throws SQLException if pos is less than 1 or if pos is greater than the number of bytes in the
* Blob or if pos + length is greater than the number of bytes in the Blob
*
*/
public InputStream getBinaryStream(final long pos, final long length) throws SQLException {
if (pos < 1) {
throw ExceptionMapper.getSqlException("Out of range (position should be > 0)");
}
if (pos - 1 > this.length) {
throw ExceptionMapper.getSqlException("Out of range (position > stream size)");
}
if (pos + length - 1 > this.length) {
throw ExceptionMapper.getSqlException("Out of range (position + length - 1 > streamSize)");
}
return new ByteArrayInputStream(data, this.offset + (int) pos - 1, (int) length);
}
/**
* Retrieves the byte position at which the specified byte array pattern begins
* within the BLOB value that this Blob object represents. The search
* for pattern begins at position start.
*
* @param pattern the byte array for which to search
* @param start the position at which to begin searching; the first position is 1
* @return the position at which the pattern appears, else -1
*/
public long position(final byte[] pattern, final long start) throws SQLException {
if (start < 1) {
throw ExceptionMapper.getSqlException("Start should be > 0, first position is 1.");
}
if (start > this.length) {
throw ExceptionMapper.getSqlException("Start should be <= " + this.length);
}
final long actualStart = offset + start - 1;
for (int i = (int) actualStart; i < offset + this.length; i++) {
if (data[i] == pattern[0]) {
boolean isEqual = true;
for (int j = 1; j < pattern.length; j++) {
if (i + j >= offset + this.length) {
return -1;
}
if (data[i + j] != pattern[j]) {
isEqual = false;
}
}
if (isEqual) {
return i + 1 - offset;
}
}
}
return -1;
}
/**
* Retrieves the byte position in the BLOB value designated by this Blob
* object at which pattern begins. The search begins at position start.
*
* @param pattern the Blob object designating the BLOB value for which
* to search
* @param start the position in the BLOB value at which to begin searching; the first
* position is 1
* @return the position at which the pattern begins, else -1
*/
public long position(final Blob pattern, final long start) throws SQLException {
return position(pattern.getBytes(1, (int) pattern.length()), start);
}
/**
* Writes the given array of bytes to the BLOB value that this Blob
* object represents, starting at position pos, and returns the number of bytes
* written. The array of bytes will overwrite the existing bytes in the Blob object
* starting at the position pos. If the end of the Blob value is reached
* while writing the array of bytes, then the length of the Blob value will be
* increased to accommodate the extra bytes.
*
* @param pos the position in the BLOB object at which to start writing; the first
* position is 1
* @param bytes the array of bytes to be written to the BLOB value that this
* Blob object represents
* @return the number of bytes written
* @see #getBytes
*/
public int setBytes(final long pos, final byte[] bytes) throws SQLException {
if (pos < 1) {
throw ExceptionMapper.getSqlException("pos should be > 0, first position is 1.");
}
final int arrayPos = (int) pos - 1;
if (length > arrayPos + bytes.length) {
System.arraycopy(bytes, 0, data, offset + arrayPos, bytes.length);
} else {
byte[] newContent = new byte[arrayPos + bytes.length];
if (Math.min(arrayPos, length) > 0) {
System.arraycopy(data, this.offset, newContent, 0, Math.min(arrayPos, length));
}
System.arraycopy(bytes, 0, newContent, arrayPos, bytes.length);
data = newContent;
length = arrayPos + bytes.length;
offset = 0;
}
return bytes.length;
}
/**
* Writes all or part of the given byte array to the BLOB value that
* this Blob object represents and returns the number of bytes written. Writing
* starts at position pos in the BLOB value; len bytes from
* the given byte array are written. The array of bytes will overwrite the existing bytes in the
* Blob object starting at the position pos. If the end of the
* Blob value is reached while writing the array of bytes, then the length of the
* Blob value will be increased to accommodate the extra bytes.
*
* Note: If the value specified for pos is greater then the length+1 of the
* BLOB value then the behavior is undefined. Some JDBC drivers may throw a
* SQLException while other drivers may support this operation.
*
* @param pos the position in the BLOB object at which to start writing; the first
* position is 1
* @param bytes the array of bytes to be written to this BLOB object
* @param offset the offset into the array bytes at which to start reading the bytes
* to be set
* @param len the number of bytes to be written to the BLOB value from the array of
* bytes bytes
* @return the number of bytes written
* @throws SQLException if there is an error accessing the BLOB value or if pos is
* less than 1
* @see #getBytes
*/
public int setBytes(final long pos, final byte[] bytes, final int offset, final int len)
throws SQLException {
if (pos < 1) {
throw ExceptionMapper.getSqlException("pos should be > 0, first position is 1.");
}
final int arrayPos = (int) pos - 1;
final int byteToWrite = Math.min(bytes.length - offset, len);
if (length > arrayPos + byteToWrite) {
System.arraycopy(bytes, offset, data, this.offset + arrayPos, byteToWrite);
} else {
byte[] newContent = new byte[arrayPos + byteToWrite];
if (Math.min(arrayPos, length) > 0) {
System.arraycopy(data, this.offset, newContent, 0, Math.min(arrayPos, length));
}
System.arraycopy(bytes, offset, newContent, arrayPos, byteToWrite);
data = newContent;
length = arrayPos + byteToWrite;
this.offset = 0;
}
return byteToWrite;
}
/**
* Retrieves a stream that can be used to write to the BLOB value that this
* Blob object represents. The stream begins at position pos. The bytes
* written to the stream will overwrite the existing bytes in the Blob object
* starting at the position pos. If the end of the Blob value is reached
* while writing to the stream, then the length of the Blob value will be increased
* to accommodate the extra bytes.
*
*
Note: If the value specified for pos is greater then the length+1 of the
* BLOB value then the behavior is undefined. Some JDBC drivers may throw a
* SQLException while other drivers may support this operation.
*
* @param pos the position in the BLOB value at which to start writing; the first
* position is 1
* @return a java.io.OutputStream object to which data can be written
* @throws SQLException if there is an error accessing the BLOB value or if pos is
* less than 1
* @see #getBinaryStream
* @since 1.4
*/
public OutputStream setBinaryStream(final long pos) throws SQLException {
if (pos < 1) {
throw ExceptionMapper.getSqlException("Invalid position in blob");
}
if (offset > 0) {
byte[] tmp = new byte[length];
System.arraycopy(data, offset, tmp, 0, length);
data = tmp;
offset = 0;
}
return new BlobOutputStream(this, (int) (pos - 1) + offset);
}
/**
* Truncates the BLOB value that this Blob object represents to be
* len bytes in length.
*
* @param len the length, in bytes, to which the BLOB value that this Blob
* object represents should be truncated
*/
public void truncate(final long len) {
if (len >= 0 && len < this.length) {
this.length = (int) len;
}
}
/**
* This method frees the Blob object and releases the resources that it holds. The
* object is invalid once the free method is called.
*
*
After free has been called, any attempt to invoke a method other than
* free will result in a SQLException being thrown. If free is
* called multiple times, the subsequent calls to free are treated as a no-op.
*/
public void free() {
this.data = new byte[0];
this.offset = 0;
this.length = 0;
}
}