org.antfarmer.ejce.hibernate

Class AbstractHibernateType

java.lang.Object

org.antfarmer.ejce.hibernate.AbstractHibernateType

All Implemented Interfaces:

ParameterizedType, UserType

Direct Known Subclasses:

AbstractLobType, EncryptedBooleanType, EncryptedByteType, EncryptedCalendarType, EncryptedCharacterType, EncryptedDateType, EncryptedDoubleType, EncryptedFloatType, EncryptedIntegerType, EncryptedLongType, EncryptedObjectType, EncryptedShortType, EncryptedStringType

public abstract class AbstractHibernateType
extends Object
implements UserType, ParameterizedType

Abstract Hibernate UserType class which encrypts and decrypts values transparently. This ensures data is stored in it's encrypted form in persistent storage, while not affecting it's real value in the application.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Charset	DEFAULT_CHARSET
protected static SecureRandom	random

Constructor Summary

Constructors

Constructor and Description
AbstractHibernateType()

Method Summary

Modifier and Type	Method and Description
Object	assemble(Serializable cached, Object owner)
protected void	configure(Properties parameters) Loads the encryptor and any other necessary instance variables.
protected abstract Object	decrypt(String value) Decrypts the given string using an appropriate method for the object type.
Object	deepCopy(Object value)
Serializable	disassemble(Object value)
protected abstract String	encrypt(Object value) Encrypts the given object using an appropriate method for the object type.
boolean	equals(Object x, Object y)
protected Charset	getCharset() Returns the charset.
protected ValueEncryptorInterface<Encryptor>	getEncryptor() Returns the encryptor value.
int	hashCode(Object x)
protected void	initializeIfNot()
boolean	isMutable()
Object	nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner)
void	nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
Object	replace(Object original, Object target, Object owner)
protected void	setCharset(Properties parameters)
void	setParameterValues(Properties parameters)
int[]	sqlTypes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.usertype.UserType

returnedClass

Field Detail

DEFAULT_CHARSET

protected static final Charset DEFAULT_CHARSET

random

protected static final SecureRandom random

Constructor Detail

AbstractHibernateType

public AbstractHibernateType()

Method Detail

encrypt

protected abstract String encrypt(Object value)
                           throws GeneralSecurityException

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

Parameters:

value - the object to be encrypted

Returns:

a string representation of the encrypted and encoded object

Throws:

GeneralSecurityException - GeneralSecurityException

decrypt

protected abstract Object decrypt(String value)
                           throws GeneralSecurityException

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

Parameters:

value - the string to be decrypted

Returns:

the decrypted object

Throws:

GeneralSecurityException - GeneralSecurityException

assemble

public Object assemble(Serializable cached,
                       Object owner)
                throws HibernateException

Specified by:

assemble in interface UserType

Throws:

HibernateException

deepCopy

public Object deepCopy(Object value)
                throws HibernateException

Specified by:

deepCopy in interface UserType

Throws:

HibernateException

disassemble

public Serializable disassemble(Object value)
                         throws HibernateException

Specified by:

disassemble in interface UserType

Throws:

HibernateException

equals

public boolean equals(Object x,
                      Object y)
               throws HibernateException

Specified by:

equals in interface UserType

Throws:

HibernateException

hashCode

public int hashCode(Object x)
             throws HibernateException

Specified by:

hashCode in interface UserType

Throws:

HibernateException

isMutable

public boolean isMutable()

Specified by:

isMutable in interface UserType

nullSafeGet

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

Specified by:

nullSafeGet in interface UserType

Throws:

HibernateException

SQLException

nullSafeSet

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

Specified by:

nullSafeSet in interface UserType

Throws:

HibernateException

SQLException

replace

public Object replace(Object original,
                      Object target,
                      Object owner)
               throws HibernateException

Specified by:

replace in interface UserType

Throws:

HibernateException

sqlTypes

public int[] sqlTypes()

Specified by:

sqlTypes in interface UserType

setParameterValues

public void setParameterValues(Properties parameters)

Specified by:

setParameterValues in interface ParameterizedType

configure

protected void configure(Properties parameters)

Loads the encryptor and any other necessary instance variables.

Parameters:

parameters - the parameter values

setCharset

protected void setCharset(Properties parameters)

initializeIfNot

protected void initializeIfNot()

getEncryptor

protected ValueEncryptorInterface<Encryptor> getEncryptor()

Returns the encryptor value.

Returns:

the encryptor.

getCharset

protected Charset getCharset()

Returns the charset.

Returns:

the charset