How to make an Entity read-only?

by

In your entity add an EntityListener like this:

@Entity
@EntityListeners(PreventAnyUpdate.class)
public class YourEntity {
    // ...
}

Implement your EntityListener, to throw an exception if any update occurs:

public class PreventAnyUpdate {

    @PrePersist
    void onPrePersist(Object o) {
        throw new IllegalStateException("JPA is trying to persist an entity of type " + (o == null ? "null" : o.getClass()));
    }

    @PreUpdate
    void onPreUpdate(Object o) {
        throw new IllegalStateException("JPA is trying to update an entity of type " + (o == null ? "null" : o.getClass()));
    }

    @PreRemove
    void onPreRemove(Object o) {
        throw new IllegalStateException("JPA is trying to remove an entity of type " + (o == null ? "null" : o.getClass()));
    }
}

This will create a bullet proof safety net for your entity with JPA lifecycle listeners.

  • PRO: JPA standard – not hibernate specific
  • PRO: very safe
  • CON: only shows write attempts at runtime. If you want a compile time check, you should not implement setters.

More Related Contents:

  1. How to properly use findBySomeOtherId not findById in Spring data jpa?
  2. Hibernate throws MultipleBagFetchException – cannot simultaneously fetch multiple bags
  3. Hibernate Annotations – Which is better, field or property access?
  4. How to store date/time and timestamps in UTC time zone with JPA and Hibernate
  5. What is this spring.jpa.open-in-view=true property in Spring Boot?
  6. Bypass GeneratedValue in Hibernate (merge data not in db?)
  7. How to create and handle composite primary key in JPA
  8. How does the FetchMode work in Spring Data JPA
  9. How to properly express JPQL “join fetch” with “where” clause as JPA 2 CriteriaQuery?
  10. How to configure JPA for testing in Maven
  11. JAXB Mapping cyclic references to XML
  12. JPA entity without id
  13. How to clone a JPA entity
  14. Should I write equals() and hashCode() methods in JPA entities?
  15. JPA OneToMany and ManyToOne throw: Repeated column in mapping for entity column (should be mapped with insert=”false” update=”false”)
  16. GenerationType.AUTO vs GenerationType.IDENTITY in hibernate
  17. Native query with named parameter fails with “Not all named parameters have been set”
  18. UNION to JPA Query
  19. When should EntityManagerFactory instance be created/opened?
  20. @BatchSize a smart or stupid use?
  21. Where did Configuration.generateSchemaCreationScript() go in Hibernate 5
  22. JPA Criteria API with multiple parameters
  23. Error creating bean with name ‘entityManagerFactory
  24. HQL joined query to eager fetch a large number of relationships
  25. Clarifying terminology – What does “hydrating” a JPA or Hibernate entity mean when fetching the entity from the DB
  26. Setting a JPA timestamp column to be generated by the database?
  27. What properties does @Column columnDefinition make redundant?
  28. DAO and Service layers (JPA/Hibernate + Spring) [duplicate]
  29. org.hibernate.loader.MultipleBagFetchException: cannot simultaneously fetch multiple bags
  30. JPA Updating Bidirectional Association

Leave a Comment