Skip to main content

How to use Jpa Hibernate Lifecycle Events Feature

Consider two possibilities to understand a typical usage and its not about Validation its all about Integration.
   
     1. You wrote a Bug Tracking Application and deployed it at your client, client has a new requirement that when a new bug is created it wants to send its information to other internal System via Web Service.

   2. You wrote an Enterprise Application and a new features requires that when a new Product is added to database via JPA Hibernate its details should be sent to other departments via Web Service call.

And this is where the feature kick-ins.
  We need to design and implement the capability with these features
  1. Scalable (should be able to use separate threat to do its job).
  2. Simple Design and Usable.
  3. Extendable i.e. No procedural junk code.
Consider following design and Code snippet where Manufacturer and Product are JPA Entities and PartnerXNotifier and PartnerYNotifier are Web Service Clients.
   





@EntityListeners({EventListener.class})
@Entity
public class Product implements Serializable {

}


@EntityListeners({EventListener.class})
@Entity
public class Manufacturer implements Serializable {
}

public class EventListener {

    @PrePersist
    public void prePersist(Object object) {
        EventObserver.getIntance().prePersist(object);
    }

    @PostPersist
    public void postPersist(Object object) {
        EventObserver.getIntance().postPersist(object);
    }

    @PreUpdate
    public void preUpdate(Object object) {
        EventObserver.getIntance().preUpdate(object);
    }

    @PostUpdate
    public void postUpdate(Object object) {
        EventObserver.getIntance().postUpdate(object);
    }

    @PreRemove
    public void preRemove(Object object) {
        EventObserver.getIntance().preRemove(object);
    }

    @PostLoad
    public void postLoad(Object object) {
        EventObserver.getIntance().postLoad(object);
    }
}

public class EventObserver {

    private Map<Class, Set<Handler>> map = new HashMap<Class, Set<Handler>>();
    private static final EventObserver observer = new EventObserver();

    private EventObserver() {
    }

    public static EventObserver getIntance() {
        return observer;
    }

    public void clear() {
        map = new HashMap<Class, Set<Handler>>();
    }

    public void loadPropertiesFileOnChange() {
        // Todo  entity_listener.properties from classpath
        // sample file contents
        // Product=com.company.project.PartnerXNotifier
       // Manufacturer=com.company.project.PartnerYNotifier
    }
    public void registerHandler(Class clazz, Handler handler) {
        Set<Handler> handlers = map.get(clazz);
        if (handlers == null) {
            handlers = new HashSet<Handler>();
        }
        handlers.add(handler);
        map.put(clazz, handlers);
    }

    public void prePersist(Object object) {
        Set<Handler> set = map.get(object.getClass());
        for (Handler handler : set) {
            handler.prePersist(object);
        }
    }

    public void postPersist(Object object) {
        Set<Handler> set = map.get(object.getClass());
        for (Handler handler : set) {
            handler.postPersist(object);
        }
    }

    public void preUpdate(Object object) {
    }

    public void postUpdate(Object object) {
    }

    public void preRemove(Object object) {
    }

    public void postLoad(Object object) {
    }
}


public interface Handler {
    public void prePersist(Object object);
    public void postPersist(Object object);
    public void preUpdate(Object object);
    public void postUpdate(Object object);
    public void preRemove(Object object);
    public void postLoad(Object object);
}

public class PartnerXNotifier implements Handler {
    public void prePersist(Object object) {
        // Call the webservice of the partner and pass the object.
    }
    public void postPersist(Object object) {
    }
}

public class PartnerYNotifier extends AbstractHandler {
    @Override
    public void preRemove(Object object) {
        // update partnery webservice 
    }
}

public abstract class AbstractHandler implements Handler {
    public void prePersist(Object object) {}
    public void postPersist(Object object) {}
    public void preUpdate(Object object) {}
    public void postUpdate(Object object) {}
    public void preRemove(Object object) {}
    public void postLoad(Object object) {}
}




Above design can significantly improve by introducing
  •    Generics in Handler
  •    ThreadExecutor in EventObserver
  •    Properly implementing loadPropertiesFileOnChange() to load properties file from multiple    classpath locations
Hope make sense and opens door for seamless integration with other Systems.

Comments

Post a Comment

Popular posts from this blog

JPA 2 new feature @ElementCollection explained

@ElementCollection is new annotation introduced in JPA 2.0, This will help us get rid of One-Many and Many-One shitty syntax. Example 1: Stores list of Strings in an Entity @Entity public class Users implements Serializable {     private static final long serialVersionUID = 1L;     @Id     @GeneratedValue(strategy = GenerationType.AUTO)     private Long id;     @ElementCollection     private List<String> certifications = new ArrayList <String> ();     public Long getId() {         return id;     }     public void setId(Long id) {         this.id = id;     }     public List <String> getCertifications() {         return certifications;     }     pub...
21 comments
Read more

Validating CSV Files

What is CsvValidator ?   A Java framework which validates any CSV files something similar to XML validation using XSD. Why should I use this ?   You don't have to use this and in fact its easy to write something your own and also checkout its source code for reference. Why did I write this ?   Some of our projects integrate with third party application which exchanges information in CSV files so I thought of writing a generic validator which can be hooked in multiple projects or can be used by QA for integration testing. What is the license clause ?   GNU GPL v2 Are there any JUnit test cases for me checkout ?  Yes,  source How to integrate in my existing project ? Just add the Jar which can be downloaded from here  CsvValidator.jar  and you are good. Instantiate  CsvValidator c onstructor which takes these 3 arguements          // filename is the the file to be validated and here ...
7 comments
Read more

Reuse JPA Entities as DTO

Note : Major design advantages of JPA Entities are they can detached and used across tiers and networks and later can by merged. Checkout this new way of querying entities in JPA 2.0 String ql = " SELECT new prepclass2.Employee (e.firstname, e.lastname) FROM Employee e "; List<Employee> dtos = em.createQuery(ql).getResultList(); The above query loads all Employee entities but with subset of data i.e. firstname, lastname. Employee entity looks like this. @Entity @Table(name="emp") public class Employee implements Serializable {     private static final long serialVersionUID = 1L;     @Id     @GeneratedValue(strategy = GenerationType.AUTO)     private Long id;     @Column     private String firstname;     @Column     private String lastname;     @Column     private String username;     @Column ...
11 comments
Read more