org.firebirdsql.jdbc.field.FBBlobField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
/*
* Firebird Open Source J2ee connector - jdbc driver
*
* Distributable under LGPL license.
* You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
*
* 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
* LGPL License for more details.
*
* This file was created by members of the firebird development team.
* All individual contributions remain the Copyright (C) of those
* individuals. Contributors to this file are either listed here or
* can be obtained from a CVS history command.
*
* All rights reserved.
*/
package org.firebirdsql.jdbc.field;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.sql.Blob;
import java.sql.SQLException;
import org.firebirdsql.gds.GDSException;
import org.firebirdsql.gds.IscBlobHandle;
import org.firebirdsql.gds.XSQLVAR;
import org.firebirdsql.jdbc.FBBlob;
import org.firebirdsql.jdbc.FBDriverNotCapableException;
import org.firebirdsql.jdbc.FBSQLException;
import org.firebirdsql.jdbc.Synchronizable;
/**
* Describe class FBBlobField here.
*
* @author Roman Rokytskyy
* @version 1.0
*/
public class FBBlobField extends FBField implements FBFlushableField {
private FBBlob blob;
// Rather then hold cached data in the XSQLDAVar we will hold it in here.
private int length;
private InputStream binaryStream;
private Reader characterStream;
private byte[] bytes;
FBBlobField(XSQLVAR field, FieldDataProvider dataProvider, int requiredType)
throws SQLException
{
super(field, dataProvider, requiredType);
}
public void close() throws SQLException {
try {
if (blob != null)
blob.close();
} catch(IOException ioex) {
throw new FBSQLException(ioex);
} finally {
// forget this blob instance, resource waste
// but simplifies our life. BLOB handle will be
// released by a server automatically later
blob = null;
this.bytes = null;
this.binaryStream = null;
this.characterStream = null;
this.length = 0;
}
}
public Blob getBlob() throws SQLException {
if (blob != null)
return blob;
final byte[] bytes = getFieldData();
if (bytes == null)
return BLOB_NULL_VALUE;
/*@todo convert this into a method of FirebirdConnection */
blob = new FBBlob(gdsHelper, field.decodeLong( bytes ));
return blob;
}
public InputStream getAsciiStream() throws SQLException {
return getBinaryStream();
}
public InputStream getBinaryStream() throws SQLException {
// getBinaryStream() is not defined for BLOB types, only for BINARY
if (field.sqlsubtype < 0)
throw (SQLException)createException(
BINARY_STREAM_CONVERSION_ERROR).fillInStackTrace();
Blob blob = getBlob();
if (blob == BLOB_NULL_VALUE)
return STREAM_NULL_VALUE;
return blob.getBinaryStream();
}
public byte[] getBytes() throws SQLException {
// getBytes() is not defined for BLOB types, only for BINARY
// if (field.sqlsubtype < 0)
// throw (SQLException)createException(
// BYTES_CONVERSION_ERROR);
return getBytesInternal();
}
public byte[] getBytesInternal() throws SQLException {
final byte[] blobIdBuffer = getFieldData();
if (blobIdBuffer == null)
return BYTES_NULL_VALUE;
final long blobId = field.decodeLong(blobIdBuffer);
Object syncObject = ((Synchronizable)getBlob()).getSynchronizationObject();
synchronized (syncObject) {
try {
final IscBlobHandle blobHandle =
gdsHelper.openBlob(blobId, FBBlob.SEGMENTED);
try {
final int blobLength = gdsHelper.getBlobLength(blobHandle);
final int bufferLength = gdsHelper.getBlobBufferLength();
final byte[] resultBuffer = new byte[blobLength];
int offset = 0;
while (offset < blobLength) {
final byte[] segementBuffer =
gdsHelper.getBlobSegment(blobHandle, bufferLength);
if (segementBuffer.length == 0) {
// unexpected EOF
throw (SQLException) createException(BYTES_CONVERSION_ERROR);
}
System.arraycopy(segementBuffer, 0, resultBuffer, offset, segementBuffer.length);
offset += segementBuffer.length;
}
return resultBuffer;
} finally {
gdsHelper.closeBlob(blobHandle);
}
} catch (GDSException e) {
throw new FBSQLException(e);
}
}
}
public byte[] getCachedObject() throws SQLException {
if (getFieldData() == null) {
if (bytes != null)
return bytes;
else
if (binaryStream != null)
throw new FBDriverNotCapableException();
else
if (characterStream != null)
throw new FBDriverNotCapableException();
else
return BYTES_NULL_VALUE;
}
return getBytesInternal();
}
public String getString() throws SQLException {
// getString() is not defined for BLOB fields, only for BINARY
if (field.sqlsubtype < 0)
throw (SQLException)createException(
STRING_CONVERSION_ERROR).fillInStackTrace();
Blob blob = getBlob();
if (blob == BLOB_NULL_VALUE)
return STRING_NULL_VALUE;
return field.decodeString(getBytes(), javaEncoding, mappingPath);
}
public InputStream getUnicodeStream() throws SQLException {
return getBinaryStream();
}
//--- setXXX methods
public void setAsciiStream(InputStream in, int length) throws SQLException {
setBinaryStream(in, length);
}
public void setCharacterStream(Reader in, int length) throws SQLException {
if (in == READER_NULL_VALUE) {
setNull();
return;
}
this.binaryStream = null;
this.characterStream = in;
this.bytes = null;
this.length = length;
}
public void setBinaryStream(InputStream in, int length) throws SQLException {
if (in == STREAM_NULL_VALUE) {
setNull();
return;
}
this.binaryStream = in;
this.characterStream = null;
this.bytes = null;
this.length = length;
}
public void flushCachedData() throws SQLException {
if (binaryStream != null)
copyBinaryStream(this.binaryStream, this.length);
else
if (characterStream != null)
copyCharacterStream(characterStream, length, javaEncoding);
else
if (bytes != null)
copyBytes(bytes, length);
else
if (blob == null)
setNull();
this.characterStream = null;
this.binaryStream = null;
this.bytes = null;
this.length = 0;
}
private void copyBinaryStream(InputStream in, int length) throws SQLException {
FBBlob blob = new FBBlob(gdsHelper);
blob.copyStream(in, length);
setFieldData(field.encodeLong(blob.getBlobId()));
}
private void copyCharacterStream(Reader in, int length, String encoding) throws SQLException {
FBBlob blob = new FBBlob(gdsHelper);
blob.copyCharacterStream(in, length, encoding);
setFieldData(field.encodeLong(blob.getBlobId()));
}
private void copyBytes(byte[] bytes, int length) throws SQLException {
FBBlob blob = new FBBlob(gdsHelper);
blob.copyBytes(bytes, 0, length);
setFieldData(field.encodeLong(blob.getBlobId()));
}
public void setBytes(byte[] value) throws SQLException {
if (value == BYTES_NULL_VALUE) {
setNull();
return;
}
this.binaryStream = null;
this.characterStream = null;
this.bytes = value;
this.length = value.length;
}
public void setString(String value) throws SQLException {
if (value == STRING_NULL_VALUE) {
setNull();
return;
}
setBytes(field.encodeString(value,javaEncoding, mappingPath));
}
public void setUnicodeStream(InputStream in, int length) throws SQLException {
setBinaryStream(in, length);
}
public void setBlob(FBBlob blob) throws SQLException {
setFieldData(field.encodeLong(blob.getBlobId()));
this.blob = blob;
}
public void setNull() {
super.setNull();
this.binaryStream = null;
this.characterStream = null;
this.bytes = null;
this.length = 0;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy