org.antfarmer.ejce.hibernate

Class AbstractLobType

java.lang.Object

org.antfarmer.ejce.hibernate.AbstractHibernateType

org.antfarmer.ejce.hibernate.AbstractLobType

All Implemented Interfaces:

ParameterizedType, UserType

Direct Known Subclasses:

EncryptedBlobType, EncryptedClobType

public abstract class AbstractLobType
extends AbstractHibernateType

Abstract extension of AbstractHibernateType for LOB types that encrypts as well as compresses arbitrarily large binary data.

See Also:

AbstractHibernateType

Field Summary

Fields inherited from class org.antfarmer.ejce.hibernate.AbstractHibernateType

DEFAULT_CHARSET, random

Constructor Summary

Constructors

Constructor and Description
AbstractLobType()

Method Summary

Modifier and Type	Method and Description
protected void	configure(Properties parameters) Loads the encryptor and any other necessary instance variables.
protected abstract Object	createLob(byte[] bytes, SessionImplementor session) Converts the InputStream to a LOB.
protected abstract Object	createLob(InputStream is, long length, SessionImplementor session) Converts the InputStream to a LOB.
protected File	createTempFile() Returns a newly created temp file.
protected Object	decrypt(String value) Decrypts the given string using an appropriate method for the object type.
protected InputStream	decryptStream(InputStream is) Decrypts the given InputStream.
protected String	encrypt(Object value) Encrypts the given object using an appropriate method for the object type.
protected InputStream	encryptStream(InputStream is) Encrypts the given InputStream.
protected String	generateTempFileName() Returns a temp file name based on the current time and a random number.
protected int	getMaxInMemoryBuffSize() Returns the maxInMemoryBuffSize.
protected int	getStreamBuffSize() Returns the streamBuffSize.
protected void	initializeIfNot()
protected boolean	isUseCompression() Returns the useCompression.
protected abstract InputStream	lobToStream(Object value) Converts the LOB value to an InputStream.
Object	nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
void	nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
abstract Class<?>	returnedClass()
protected void	setStream(PreparedStatement st, int index, InputStream is) Sets the InputStream on the given PreparedStatement.
int[]	sqlTypes()
protected Object	streamToLob(InputStream is, SessionImplementor session)

Methods inherited from class org.antfarmer.ejce.hibernate.AbstractHibernateType

assemble, deepCopy, disassemble, equals, getCharset, getEncryptor, hashCode, isMutable, replace, setCharset, setParameterValues

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLobType

public AbstractLobType()

Method Detail

sqlTypes

public int[] sqlTypes()

Specified by:

sqlTypes in interface UserType

Overrides:

sqlTypes in class AbstractHibernateType

configure

protected void configure(Properties parameters)

Loads the encryptor and any other necessary instance variables.

Overrides:

configure in class AbstractHibernateType

Parameters:

parameters - the parameter values

initializeIfNot

protected void initializeIfNot()

Overrides:

initializeIfNot in class AbstractHibernateType

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        Object value,
                        int index,
                        SessionImplementor session)
                 throws HibernateException,
                        SQLException

Specified by:

nullSafeSet in interface UserType

Overrides:

nullSafeSet in class AbstractHibernateType

Throws:

HibernateException

SQLException

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                          String[] names,
                          SessionImplementor session,
                          Object owner)
                   throws HibernateException,
                          SQLException

Specified by:

nullSafeGet in interface UserType

Overrides:

nullSafeGet in class AbstractHibernateType

Throws:

HibernateException

SQLException

encryptStream

protected InputStream encryptStream(InputStream is)
                             throws GeneralSecurityException,
                                    IOException

Encrypts the given InputStream.

Parameters:

is - the InputStream

Returns:

an encrypted InputStream

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

decryptStream

protected InputStream decryptStream(InputStream is)
                             throws GeneralSecurityException,
                                    IOException

Decrypts the given InputStream.

Parameters:

is - the InputStream

Returns:

a decrypted InputStream

Throws:

GeneralSecurityException - GeneralSecurityException

IOException - IOException

setStream

protected void setStream(PreparedStatement st,
                         int index,
                         InputStream is)
                  throws IOException,
                         SQLException

Sets the InputStream on the given PreparedStatement. If the given InputStream contains less data than the maxInMemoryBuffSize setting, the data will be set on the PreparedStatement using an in-memory byte array, unless the stream LOB's option is enabled. If maximum buffer size is exceeded, the stream will be set via a temporary file to determine its true length and limit memory usage.

Parameters:

st - the PreparedStatement

index - the parameter index

is - the InputStream

Throws:

IOException - IOException

SQLException - SQLException

streamToLob

protected Object streamToLob(InputStream is,
                             SessionImplementor session)
                      throws IOException

Throws:

IOException

createTempFile

protected File createTempFile()
                       throws IOException

Returns a newly created temp file. The file will be deleted on normal termination of the VM.

Returns:

a newly created temp file

Throws:

IOException - IOException

generateTempFileName

protected String generateTempFileName()

Returns a temp file name based on the current time and a random number.

Returns:

a temp file name based on the current time and a random number

lobToStream

protected abstract InputStream lobToStream(Object value)
                                    throws SQLException

Converts the LOB value to an InputStream.

Parameters:

value - the LOB value

Returns:

the InputStream

Throws:

SQLException - an error converting the value to an InputStream

createLob

protected abstract Object createLob(InputStream is,
                                    long length,
                                    SessionImplementor session)
                             throws IOException

Converts the InputStream to a LOB.

Parameters:

is - the InputStream

length - the stream length

session - the SessionImplementor

Returns:

the LOB

Throws:

IOException - an error converting the stream to a LOB

createLob

protected abstract Object createLob(byte[] bytes,
                                    SessionImplementor session)
                             throws IOException

Converts the InputStream to a LOB.

Parameters:

bytes - the bytes

session - the SessionImplementor

Returns:

the LOB

Throws:

IOException - an error converting the stream to a LOB

decrypt

protected Object decrypt(String value)
                  throws GeneralSecurityException

Decrypts the given string using an appropriate method for the object type.

Specified by:

decrypt in class AbstractHibernateType

Parameters:

value - the string to be decrypted

Returns:

the decrypted object

Throws:

GeneralSecurityException - GeneralSecurityException

encrypt

protected String encrypt(Object value)
                  throws GeneralSecurityException

Encrypts the given object using an appropriate method for the object type.

Specified by:

encrypt in class AbstractHibernateType

Parameters:

value - the object to be encrypted

Returns:

a string representation of the encrypted and encoded object

Throws:

GeneralSecurityException - GeneralSecurityException

returnedClass

public abstract Class<?> returnedClass()

isUseCompression

protected boolean isUseCompression()

Returns the useCompression.

Returns:

the useCompression

getStreamBuffSize

protected int getStreamBuffSize()

Returns the streamBuffSize.

Returns:

the streamBuffSize

getMaxInMemoryBuffSize

protected int getMaxInMemoryBuffSize()

Returns the maxInMemoryBuffSize.

Returns:

the maxInMemoryBuffSize