com.mysql.cj.jdbc.BlobFromLocator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-java
Show all versions of mysql-connector-java
JDBC Type 4 driver for MySQL
/*
* Copyright (c) 2002, 2018, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 2.0, as published by the
* Free Software Foundation.
*
* This program is also distributed with certain software (including but not
* limited to OpenSSL) that is licensed under separate terms, as designated in a
* particular file or component or in included license documentation. The
* authors of MySQL hereby grant you an additional permission to link the
* program and your derivative works with the separately licensed software that
* they have included with MySQL.
*
* Without limiting anything contained in the foregoing, this file, which is
* part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
* version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program 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 General Public License, version 2.0,
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.cj.jdbc;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import com.mysql.cj.Messages;
import com.mysql.cj.conf.PropertyDefinitions;
import com.mysql.cj.exceptions.ExceptionInterceptor;
import com.mysql.cj.exceptions.MysqlErrorNumbers;
import com.mysql.cj.jdbc.exceptions.SQLError;
import com.mysql.cj.jdbc.result.ResultSetImpl;
import com.mysql.cj.result.Field;
/**
* The representation (mapping) in the JavaTM programming language of an SQL BLOB value. An SQL BLOB is a built-in type that stores a Binary Large Object
* as a column value in a row of a database table. The driver implements Blob using an SQL locator(BLOB), which means that a Blob object contains a logical
* pointer to the SQL BLOB data rather than the data itself. A Blob object is valid for the duration of the transaction in which is was created. Methods in
* the interfaces ResultSet, CallableStatement, and PreparedStatement, such as getBlob and setBlob allow a programmer to access an SQL BLOB value. The Blob
* interface provides methods for getting the length of an SQL BLOB (Binary Large Object) value, for materializing a BLOB value on the client, and for
* determining the position of a pattern of bytes within a BLOB value. This class is new in the JDBC 2.0 API.
*/
public class BlobFromLocator implements java.sql.Blob {
private List primaryKeyColumns = null;
private List primaryKeyValues = null;
/** The ResultSet that created this BLOB */
private ResultSetImpl creatorResultSet;
private String blobColumnName = null;
private String tableName = null;
private int numColsInResultSet = 0;
private int numPrimaryKeys = 0;
private String quotedId;
private ExceptionInterceptor exceptionInterceptor;
/**
* Creates an updatable BLOB that can update in-place
*
* @param creatorResultSetToSet
* result set
* @param blobColumnIndex
* column index
* @param exceptionInterceptor
* exception interceptor
* @throws SQLException
* if an error occurs
*/
public BlobFromLocator(ResultSetImpl creatorResultSetToSet, int blobColumnIndex, ExceptionInterceptor exceptionInterceptor) throws SQLException {
this.exceptionInterceptor = exceptionInterceptor;
this.creatorResultSet = creatorResultSetToSet;
Field[] fields = this.creatorResultSet.getMetadata().getFields();
this.numColsInResultSet = fields.length;
this.quotedId = this.creatorResultSet.getSession().getIdentifierQuoteString();
if (this.numColsInResultSet > 1) {
this.primaryKeyColumns = new ArrayList<>();
this.primaryKeyValues = new ArrayList<>();
for (int i = 0; i < this.numColsInResultSet; i++) {
if (fields[i].isPrimaryKey()) {
StringBuilder keyName = new StringBuilder();
keyName.append(this.quotedId);
String originalColumnName = fields[i].getOriginalName();
if ((originalColumnName != null) && (originalColumnName.length() > 0)) {
keyName.append(originalColumnName);
} else {
keyName.append(fields[i].getName());
}
keyName.append(this.quotedId);
this.primaryKeyColumns.add(keyName.toString());
this.primaryKeyValues.add(this.creatorResultSet.getString(i + 1));
}
}
} else {
notEnoughInformationInQuery();
}
this.numPrimaryKeys = this.primaryKeyColumns.size();
if (this.numPrimaryKeys == 0) {
notEnoughInformationInQuery();
}
if (fields[0].getOriginalTableName() != null) {
StringBuilder tableNameBuffer = new StringBuilder();
String databaseName = fields[0].getDatabaseName();
if ((databaseName != null) && (databaseName.length() > 0)) {
tableNameBuffer.append(this.quotedId);
tableNameBuffer.append(databaseName);
tableNameBuffer.append(this.quotedId);
tableNameBuffer.append('.');
}
tableNameBuffer.append(this.quotedId);
tableNameBuffer.append(fields[0].getOriginalTableName());
tableNameBuffer.append(this.quotedId);
this.tableName = tableNameBuffer.toString();
} else {
StringBuilder tableNameBuffer = new StringBuilder();
tableNameBuffer.append(this.quotedId);
tableNameBuffer.append(fields[0].getTableName());
tableNameBuffer.append(this.quotedId);
this.tableName = tableNameBuffer.toString();
}
this.blobColumnName = this.quotedId + this.creatorResultSet.getString(blobColumnIndex) + this.quotedId;
}
private void notEnoughInformationInQuery() throws SQLException {
throw SQLError.createSQLException(Messages.getString("Blob.8"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
}
@Override
public OutputStream setBinaryStream(long indexToWriteAt) throws SQLException {
throw SQLError.createSQLFeatureNotSupportedException();
}
@Override
public java.io.InputStream getBinaryStream() throws SQLException {
// TODO: Make fetch size configurable
return new BufferedInputStream(new LocatorInputStream(),
this.creatorResultSet.getSession().getPropertySet().getMemorySizeProperty(PropertyDefinitions.PNAME_locatorFetchBufferSize).getValue());
}
@Override
public int setBytes(long writeAt, byte[] bytes, int offset, int length) throws SQLException {
java.sql.PreparedStatement pStmt = null;
if ((offset + length) > bytes.length) {
length = bytes.length - offset;
}
byte[] bytesToWrite = new byte[length];
System.arraycopy(bytes, offset, bytesToWrite, 0, length);
// FIXME: Needs to use identifiers for column/table names
StringBuilder query = new StringBuilder("UPDATE ");
query.append(this.tableName);
query.append(" SET ");
query.append(this.blobColumnName);
query.append(" = INSERT(");
query.append(this.blobColumnName);
query.append(", ");
query.append(writeAt);
query.append(", ");
query.append(length);
query.append(", ?) WHERE ");
query.append(this.primaryKeyColumns.get(0));
query.append(" = ?");
for (int i = 1; i < this.numPrimaryKeys; i++) {
query.append(" AND ");
query.append(this.primaryKeyColumns.get(i));
query.append(" = ?");
}
try {
// FIXME: Have this passed in instead
pStmt = this.creatorResultSet.getConnection().prepareStatement(query.toString());
pStmt.setBytes(1, bytesToWrite);
for (int i = 0; i < this.numPrimaryKeys; i++) {
pStmt.setString(i + 2, this.primaryKeyValues.get(i));
}
int rowsUpdated = pStmt.executeUpdate();
if (rowsUpdated != 1) {
throw SQLError.createSQLException(Messages.getString("Blob.9"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
}
} finally {
if (pStmt != null) {
try {
pStmt.close();
} catch (SQLException sqlEx) {
// do nothing
}
pStmt = null;
}
}
return (int) length();
}
@Override
public int setBytes(long writeAt, byte[] bytes) throws SQLException {
return setBytes(writeAt, bytes, 0, bytes.length);
}
@Override
public byte[] getBytes(long pos, int length) throws SQLException {
java.sql.PreparedStatement pStmt = null;
try {
pStmt = createGetBytesStatement();
return getBytesInternal(pStmt, pos, length);
} finally {
if (pStmt != null) {
try {
pStmt.close();
} catch (SQLException sqlEx) {
// do nothing
}
pStmt = null;
}
}
}
@Override
public long length() throws SQLException {
java.sql.ResultSet blobRs = null;
java.sql.PreparedStatement pStmt = null;
// FIXME: Needs to use identifiers for column/table names
StringBuilder query = new StringBuilder("SELECT LENGTH(");
query.append(this.blobColumnName);
query.append(") FROM ");
query.append(this.tableName);
query.append(" WHERE ");
query.append(this.primaryKeyColumns.get(0));
query.append(" = ?");
for (int i = 1; i < this.numPrimaryKeys; i++) {
query.append(" AND ");
query.append(this.primaryKeyColumns.get(i));
query.append(" = ?");
}
try {
// FIXME: Have this passed in instead
pStmt = this.creatorResultSet.getConnection().prepareStatement(query.toString());
for (int i = 0; i < this.numPrimaryKeys; i++) {
pStmt.setString(i + 1, this.primaryKeyValues.get(i));
}
blobRs = pStmt.executeQuery();
if (blobRs.next()) {
return blobRs.getLong(1);
}
throw SQLError.createSQLException(Messages.getString("Blob.9"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
} finally {
if (blobRs != null) {
try {
blobRs.close();
} catch (SQLException sqlEx) {
// do nothing
}
blobRs = null;
}
if (pStmt != null) {
try {
pStmt.close();
} catch (SQLException sqlEx) {
// do nothing
}
pStmt = null;
}
}
}
@Override
public long position(java.sql.Blob pattern, long start) throws SQLException {
return position(pattern.getBytes(0, (int) pattern.length()), start);
}
@Override
public long position(byte[] pattern, long start) throws SQLException {
java.sql.ResultSet blobRs = null;
java.sql.PreparedStatement pStmt = null;
// FIXME: Needs to use identifiers for column/table names
StringBuilder query = new StringBuilder("SELECT LOCATE(");
query.append("?, ");
query.append(this.blobColumnName);
query.append(", ");
query.append(start);
query.append(") FROM ");
query.append(this.tableName);
query.append(" WHERE ");
query.append(this.primaryKeyColumns.get(0));
query.append(" = ?");
for (int i = 1; i < this.numPrimaryKeys; i++) {
query.append(" AND ");
query.append(this.primaryKeyColumns.get(i));
query.append(" = ?");
}
try {
// FIXME: Have this passed in instead
pStmt = this.creatorResultSet.getConnection().prepareStatement(query.toString());
pStmt.setBytes(1, pattern);
for (int i = 0; i < this.numPrimaryKeys; i++) {
pStmt.setString(i + 2, this.primaryKeyValues.get(i));
}
blobRs = pStmt.executeQuery();
if (blobRs.next()) {
return blobRs.getLong(1);
}
throw SQLError.createSQLException(Messages.getString("Blob.9"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
} finally {
if (blobRs != null) {
try {
blobRs.close();
} catch (SQLException sqlEx) {
// do nothing
}
blobRs = null;
}
if (pStmt != null) {
try {
pStmt.close();
} catch (SQLException sqlEx) {
// do nothing
}
pStmt = null;
}
}
}
@Override
public void truncate(long length) throws SQLException {
java.sql.PreparedStatement pStmt = null;
// FIXME: Needs to use identifiers for column/table names
StringBuilder query = new StringBuilder("UPDATE ");
query.append(this.tableName);
query.append(" SET ");
query.append(this.blobColumnName);
query.append(" = LEFT(");
query.append(this.blobColumnName);
query.append(", ");
query.append(length);
query.append(") WHERE ");
query.append(this.primaryKeyColumns.get(0));
query.append(" = ?");
for (int i = 1; i < this.numPrimaryKeys; i++) {
query.append(" AND ");
query.append(this.primaryKeyColumns.get(i));
query.append(" = ?");
}
try {
// FIXME: Have this passed in instead
pStmt = this.creatorResultSet.getConnection().prepareStatement(query.toString());
for (int i = 0; i < this.numPrimaryKeys; i++) {
pStmt.setString(i + 1, this.primaryKeyValues.get(i));
}
int rowsUpdated = pStmt.executeUpdate();
if (rowsUpdated != 1) {
throw SQLError.createSQLException(Messages.getString("Blob.9"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
}
} finally {
if (pStmt != null) {
try {
pStmt.close();
} catch (SQLException sqlEx) {
// do nothing
}
pStmt = null;
}
}
}
java.sql.PreparedStatement createGetBytesStatement() throws SQLException {
StringBuilder query = new StringBuilder("SELECT SUBSTRING(");
query.append(this.blobColumnName);
query.append(", ");
query.append("?");
query.append(", ");
query.append("?");
query.append(") FROM ");
query.append(this.tableName);
query.append(" WHERE ");
query.append(this.primaryKeyColumns.get(0));
query.append(" = ?");
for (int i = 1; i < this.numPrimaryKeys; i++) {
query.append(" AND ");
query.append(this.primaryKeyColumns.get(i));
query.append(" = ?");
}
return this.creatorResultSet.getConnection().prepareStatement(query.toString());
}
byte[] getBytesInternal(java.sql.PreparedStatement pStmt, long pos, int length) throws SQLException {
java.sql.ResultSet blobRs = null;
try {
pStmt.setLong(1, pos);
pStmt.setInt(2, length);
for (int i = 0; i < this.numPrimaryKeys; i++) {
pStmt.setString(i + 3, this.primaryKeyValues.get(i));
}
blobRs = pStmt.executeQuery();
if (blobRs.next()) {
return ((com.mysql.cj.jdbc.result.ResultSetImpl) blobRs).getBytes(1);
}
throw SQLError.createSQLException(Messages.getString("Blob.9"), MysqlErrorNumbers.SQL_STATE_GENERAL_ERROR, this.exceptionInterceptor);
} finally {
if (blobRs != null) {
try {
blobRs.close();
} catch (SQLException sqlEx) {
// do nothing
}
blobRs = null;
}
}
}
class LocatorInputStream extends InputStream {
long currentPositionInBlob = 0;
long length = 0;
java.sql.PreparedStatement pStmt = null;
LocatorInputStream() throws SQLException {
this.length = length();
this.pStmt = createGetBytesStatement();
}
@SuppressWarnings("synthetic-access")
LocatorInputStream(long pos, long len) throws SQLException {
this.length = pos + len;
this.currentPositionInBlob = pos;
long blobLength = length();
if (pos + len > blobLength) {
throw SQLError.createSQLException(
Messages.getString("Blob.invalidStreamLength", new Object[] { Long.valueOf(blobLength), Long.valueOf(pos), Long.valueOf(len) }),
MysqlErrorNumbers.SQL_STATE_ILLEGAL_ARGUMENT, BlobFromLocator.this.exceptionInterceptor);
}
if (pos < 1) {
throw SQLError.createSQLException(Messages.getString("Blob.invalidStreamPos"), MysqlErrorNumbers.SQL_STATE_ILLEGAL_ARGUMENT,
BlobFromLocator.this.exceptionInterceptor);
}
if (pos > blobLength) {
throw SQLError.createSQLException(Messages.getString("Blob.invalidStreamPos"), MysqlErrorNumbers.SQL_STATE_ILLEGAL_ARGUMENT,
BlobFromLocator.this.exceptionInterceptor);
}
}
@Override
public int read() throws IOException {
if (this.currentPositionInBlob + 1 > this.length) {
return -1;
}
try {
byte[] asBytes = getBytesInternal(this.pStmt, (this.currentPositionInBlob++) + 1, 1);
if (asBytes == null) {
return -1;
}
return asBytes[0];
} catch (SQLException sqlEx) {
throw new IOException(sqlEx.toString());
}
}
@Override
public int read(byte[] b, int off, int len) throws IOException {
if (this.currentPositionInBlob + 1 > this.length) {
return -1;
}
try {
byte[] asBytes = getBytesInternal(this.pStmt, (this.currentPositionInBlob) + 1, len);
if (asBytes == null) {
return -1;
}
System.arraycopy(asBytes, 0, b, off, asBytes.length);
this.currentPositionInBlob += asBytes.length;
return asBytes.length;
} catch (SQLException sqlEx) {
throw new IOException(sqlEx.toString());
}
}
@Override
public int read(byte[] b) throws IOException {
if (this.currentPositionInBlob + 1 > this.length) {
return -1;
}
try {
byte[] asBytes = getBytesInternal(this.pStmt, (this.currentPositionInBlob) + 1, b.length);
if (asBytes == null) {
return -1;
}
System.arraycopy(asBytes, 0, b, 0, asBytes.length);
this.currentPositionInBlob += asBytes.length;
return asBytes.length;
} catch (SQLException sqlEx) {
throw new IOException(sqlEx.toString());
}
}
@Override
public void close() throws IOException {
if (this.pStmt != null) {
try {
this.pStmt.close();
} catch (SQLException sqlEx) {
throw new IOException(sqlEx.toString());
}
}
super.close();
}
}
@Override
public void free() throws SQLException {
this.creatorResultSet = null;
this.primaryKeyColumns = null;
this.primaryKeyValues = null;
}
@Override
public InputStream getBinaryStream(long pos, long length) throws SQLException {
return new LocatorInputStream(pos, length);
}
}