Package org.jasypt.hibernate6.type

Class EncryptedByteAsStringType

Object
org.jasypt.hibernate6.type.AbstractEncryptedAsStringType
org.jasypt.hibernate6.type.EncryptedByteAsStringType
All Implemented Interfaces:
org.hibernate.usertype.ParameterizedType, org.hibernate.usertype.UserType
public final class EncryptedByteAsStringType extends AbstractEncryptedAsStringType
A Hibernate UserType implementation which allows encryption of Byte values into String (VARCHAR) database fields during persistence of entities.

This class is intended only for declarative use from a Hibernate mapping file. Do not use it directly from your .java files (although of course you can use it when mapping entities using annotations).

To use this Hibernate type in one of your Hibernate mappings, you can add it like this: 

  <hibernate-mapping package="myapp">
    ...
    <typedef name="encryptedByteAsString" class="org.jasypt.hibernate.type.EncryptedByteAsStringType">
      <param name="encryptorRegisteredName">myHibernateStringEncryptor</param>
    </typedef>
    ...
    <class name="UserData" table="USER_DATA">
      ...
      <property name="salary" column="SALARY" type="encryptedByteAsString" />
      ...
    <class>
    ...
  <hibernate-mapping>

...where a HibernatePBEStringEncryptor object should have been previously registered to be used from Hibernate with name myHibernateStringEncryptor (see HibernatePBEStringEncryptor and HibernatePBEEncryptorRegistry).

Or, if you prefer to avoid registration of encryptors, you can configure your encryptor directly in the mapping file (although not recommended), like this: 

  <hibernate-mapping package="myapp">
    ...
    <typedef name="encryptedByteAsString" class="org.jasypt.hibernate.type.EncryptedByteAsStringType">
      <param name="algorithm">PBEWithMD5AndTripleDES</param>
      <param name="password">XXXXX</param>
      <param name="keyObtentionIterations">1000</param>
    </typedef>
    ...
    <class name="UserData" table="USER_DATA">
      ...
      <property name="salary" column="SALARY" type="encryptedByteAsString" />
      ...
    <class>
    ...
  <hibernate-mapping>

To learn more about usage of user-defined types, please refer to the Hibernate Reference Documentation.

Since:
1.9.0
Author:
Chus Picos