EJB - Callback

Il callback è un meccanismo mediante il quale è possibile intercettare il ciclo di vita di un bean enterprise. La specifica EJB 3.0 ha dei callback specificati per i quali vengono creati i metodi del gestore di callback. EJB Container chiama questi callback. Possiamo definire metodi di callback nella stessa classe EJB o in una classe separata. EJB 3.0 ha fornito molte annotazioni per i callback.

Di seguito è riportato l'elenco delle annotazioni di callback per il bean senza stato:

Annotazione	Descrizione
@PostConstruct	Richiamato quando un bean viene creato per la prima volta.
@PreDestroy	Richiamato quando un bean viene rimosso dal pool di bean o viene distrutto.

Di seguito è riportato l'elenco delle annotazioni di callback per il bean stateful -

Annotazione	Descrizione
@PostConstruct	Richiamato quando un bean viene creato per la prima volta.
@PreDestroy	Richiamato quando un bean viene rimosso dal pool di bean o viene distrutto.
@PostActivate	Richiamato quando un bean viene caricato per essere utilizzato.
@PrePassivate	Richiamato quando un bean viene rimesso nel pool di fagioli.

Di seguito è riportato l'elenco delle annotazioni di callback per il bean basato sui messaggi:

Annotazione	Descrizione
@PostConstruct	Richiamato quando un bean viene creato per la prima volta.
@PreDestroy	Richiamato quando un bean viene rimosso dal pool di bean o viene distrutto.

Di seguito è riportato l'elenco delle annotazioni di callback per il bean di entità:

Annotazione	Descrizione
@PrePersist	Richiamato quando un'entità viene creata nel database.
@PostPersist	Richiamato dopo la creazione di un'entità nel database.
@PreRemove	Richiamato quando un'entità viene eliminata dal database.
@PostRemove	Richiamato dopo che un'entità è stata eliminata dal database.
@PreUpdate	Richiamato prima che un'entità venga aggiornata nel database.
@PostLoad	Richiamato quando un record viene recuperato dal database e caricato nell'entità.

Applicazione di esempio

Creiamo un'applicazione EJB di prova per testare vari callback in EJB.

Passo	Descrizione
1	Creare un progetto con un nome EjbComponent sotto un pacchetto com.tutorialspoint.stateless come spiegato nel capitolo EJB - Crea applicazione . È inoltre possibile utilizzare il progetto creato nel capitolo EJB - Persistenza in quanto tale per questo capitolo per aggiungere vari callback a EJB.
2	Creare LibrarySessionBean.java e LibrarySessionBeanRemote come spiegato nel capitolo EJB - Crea applicazione . Mantieni il resto dei file invariato.
3	Usa i fagioli creati nel capitolo EJB - Persistenza . Aggiungi metodi di callback come mostrato di seguito. Mantieni il resto dei file invariato.
4	Crea una classe java BookCallbackListener nel pacchetto com.tutorialspoint.callback . Questa classe dimostrerà la separazione dei metodi di callback.
5	Pulisci e crea l'applicazione per assicurarti che la logica aziendale funzioni secondo i requisiti.
6	Infine, distribuisci l'applicazione sotto forma di file jar su JBoss Application Server. JBoss Application Server verrà avviato automaticamente se non è ancora stato avviato.
7	Ora crea il client EJB, un'applicazione basata su console nello stesso modo spiegato nel capitolo EJB - Crea applicazione sotto l'argomentoCreate Client to access EJB.

EJBComponent (modulo EJB)

BookCallbackListener.java

package com.tutorialspoint.callback;

import javax.persistence.PrePersist;
import javax.persistence.PostLoad;
import javax.persistence.PostPersist;
import javax.persistence.PostRemove;
import javax.persistence.PostUpdate;
import javax.persistence.PreRemove;
import javax.persistence.PreUpdate;

import com.tutorialspoint.entity.Book;

public class BookCallbackListener {
    
   @PrePersist
   public void prePersist(Book book) {
      System.out.println("BookCallbackListener.prePersist:" 
         + "Book to be created with book id: "+book.getId());
   }

   @PostPersist
   public void postPersist(Object book) {
      System.out.println("BookCallbackListener.postPersist::"
         + "Book created with book id: "+((Book)book).getId());
   }

   @PreRemove
   public void preRemove(Book book) {
      System.out.println("BookCallbackListener.preRemove:"
         + " About to delete Book: " + book.getId());
   }

   @PostRemove
   public void postRemove(Book book) {
      System.out.println("BookCallbackListener.postRemove::"
         + " Deleted Book: " + book.getId());
   }

   @PreUpdate
   public void preUpdate(Book book) {
      System.out.println("BookCallbackListener.preUpdate::"
         + " About to update Book: " + book.getId());
   }

   @PostUpdate
   public void postUpdate(Book book) {
      System.out.println("BookCallbackListener.postUpdate::"
         + " Updated Book: " + book.getId());
   }

   @PostLoad
   public void postLoad(Book book) {
      System.out.println("BookCallbackListener.postLoad::"
         + " Loaded Book: " + book.getId());
   }
}

Book.java

package com.tutorialspoint.entity;
 
import java.io.Serializable;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
 
@Entity
@Table(name="books")
public class Book implements Serializable{
    
   private int id;
   private String name;
 
   public Book() {        
   }
 
   @Id
   @GeneratedValue(strategy= GenerationType.IDENTITY)
   @Column(name="id")
   public int getId() {
      return id;
   }
 
   public void setId(int id) {
      this.id = id;
   }
 
   public String getName() {
      return name;
   }
 
   public void setName(String name) {
      this.name = name;
   }    
}

LibraryStatefulSessionBean.java

package com.tutorialspoint.stateful;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import javax.ejb.PostActivate;
import javax.ejb.PrePassivate;
import javax.ejb.Stateful;

@Stateful
public class LibraryStatefulSessionBean 
   implements LibraryStatefulSessionBeanRemote {
   List<String> bookShelf;    

   public LibraryStatefulSessionBean() {
      bookShelf = new ArrayList<String>();
   }

   public void addBook(String bookName) {
      bookShelf.add(bookName);
   }    

   public List<String> getBooks() {
      return bookShelf;
   }

   @PostConstruct
   public void postConstruct() {
      System.out.println("LibraryStatefulSessionBean.postConstruct::"
         + " bean created.");
   }

   @PreDestroy
   public void preDestroy() {
      System.out.println("LibraryStatefulSessionBean.preDestroy:"
         + " bean removed.");
   }

   @PostActivate
   public void postActivate() {
      System.out.println("LibraryStatefulSessionBean.postActivate:"
         + " bean activated.");
   }

   @PrePassivate
   public void prePassivate() {
      System.out.println("LibraryStatefulSessionBean.prePassivate:"
         + " bean passivated.");
   }    
}

LibraryStatefulSessionBeanRemote.java

package com.tutorialspoint.stateful;

import java.util.List;
import javax.ejb.Remote;

@Remote
public interface LibraryStatefulSessionBeanRemote {
   void addBook(String bookName);
   List getBooks();
}

LibraryPersistentBean.java

package com.tutorialspoint.stateless;

import com.tutorialspoint.entity.Book;
import java.util.List;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

@Stateless
public class LibraryPersistentBean 
   implements LibraryPersistentBeanRemote {
    
   public LibraryPersistentBean() {}

   @PersistenceContext(unitName="EntityEjbPU")
   private EntityManager entityManager;         

   public void addBook(Book book) {
      entityManager.persist(book);
   }    

   public List<Book> getBooks() {     
      return entityManager.createQuery("From Book")
         .getResultList();
   }

   @PostConstruct
   public void postConstruct() {
      System.out.println("postConstruct:: LibraryPersistentBean session bean"
         + " created with entity Manager object: ");
   }

   @PreDestroy
   public void preDestroy() {
      System.out.println("preDestroy: LibraryPersistentBean session"
      + " bean is removed ");
   }
}

LibraryPersistentBeanRemote.java

package com.tutorialspoint.stateless;

import com.tutorialspoint.entity.Book;
import java.util.List;
import javax.ejb.Remote;

@Remote
public interface LibraryPersistentBeanRemote {

   void addBook(Book bookName);

   List<Book> getBooks();
    
}

• Non appena distribuisci il progetto EjbComponent su JBOSS, osserva il registro jboss.

• JBoss ha creato automaticamente una voce JNDI per il nostro bean di sessione - LibraryPersistentBean/remote.

• Useremo questa stringa di ricerca per ottenere un oggetto business remoto di tipo - com.tutorialspoint.stateless.LibraryPersistentBeanRemote

Output del registro di JBoss Application Server

...
16:30:01,401 INFO  [JndiSessionRegistrarBase] Binding the following Entries in Global JNDI:
   LibraryPersistentBean/remote - EJB3.x Default Remote Business Interface
   LibraryPersistentBean/remote-com.tutorialspoint.stateless.LibraryPersistentBeanRemote - EJB3.x Remote Business Interface
16:30:02,723 INFO  [SessionSpecContainer] Starting jboss.j2ee:jar=EjbComponent.jar,name=LibraryPersistentBean,service=EJB3
16:30:02,723 INFO  [EJBContainer] STARTED EJB: com.tutorialspoint.stateless.LibrarySessionBeanRemote ejbName: LibraryPersistentBean
...

EJBTester (client EJB)

jndi.properties

java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory
java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces
java.naming.provider.url=localhost

• Queste proprietà vengono utilizzate per inizializzare l'oggetto InitialContext del servizio di denominazione java.

• L'oggetto InitialContext verrà utilizzato per cercare il bean di sessione senza stato.

EJBTester.java

package com.tutorialspoint.test;
   
import com.tutorialspoint.stateful.LibrarySessionBeanRemote;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;

import java.util.List;
import java.util.Properties;

import javax.naming.InitialContext;
import javax.naming.NamingException;

public class EJBTester {

   BufferedReader brConsoleReader = null; 
   Properties props;
   InitialContext ctx;
   {
      props = new Properties();
      try {
         props.load(new FileInputStream("jndi.properties"));
      } catch (IOException ex) {
         ex.printStackTrace();
      }
      try {
         ctx = new InitialContext(props);            
      } catch (NamingException ex) {
         ex.printStackTrace();
      }
      brConsoleReader = 
      new BufferedReader(new InputStreamReader(System.in));
   }
   
   public static void main(String[] args) {

      EJBTester ejbTester = new EJBTester();

      ejbTester.testEntityEjb();
   }
   
   private void showGUI() {
      System.out.println("**********************");
      System.out.println("Welcome to Book Store");
      System.out.println("**********************");
      System.out.print("Options \n1. Add Book\n2. Exit \nEnter Choice: ");
   }
   
   private void testEntityEjb() {    
      try {
      int choice = 1; 

      LibraryPersistentBeanRemote libraryBean = 
      (LibraryPersistentBeanRemote)
      ctx.lookup("LibraryPersistentBean/remote");

      while (choice != 2) {
         String bookName;
         showGUI();
         String strChoice = brConsoleReader.readLine();
         choice = Integer.parseInt(strChoice);
         if (choice == 1) {
            System.out.print("Enter book name: ");
            bookName = brConsoleReader.readLine();
            Book book = new Book();
            book.setName(bookName);
            libraryBean.addBook(book);          
         } else if (choice == 2) {
            break;
         }
      }

      List<Book> booksList = libraryBean.getBooks();

      System.out.println("Book(s) entered so far: " + booksList.size());
      int i = 0;
      for (Book book:booksList) {
         System.out.println((i+1)+". " + book.getName());
         i++;
      }           

      } catch (Exception e) {
         System.out.println(e.getMessage());
         e.printStackTrace();
      }finally {
         try {
            if(brConsoleReader !=null) {
               brConsoleReader.close();
            }
         } catch (IOException ex) {
            System.out.println(ex.getMessage());
         }
      }    
   }    
}

EJBTester esegue le seguenti attività:

• Carica le proprietà da jndi.properties e inizializza l'oggetto InitialContext.

• Nel metodo testStatelessEjb (), la ricerca jndi viene eseguita con il nome - "LibrarySessionBean / remote" per ottenere l'oggetto business remoto (EJB senza stato).

• Quindi all'utente viene mostrata l'interfaccia utente di un negozio della libreria e gli viene chiesto di inserire una scelta.

• Se l'utente immette 1, il sistema richiede il nome del libro e salva il libro utilizzando il metodo addBook () del bean di sessione senza stato. Session Bean sta archiviando il libro nel database.

• Se l'utente immette 2, il sistema recupera i libri utilizzando il metodo getBooks () del bean di sessione senza stato ed esce.

Eseguire il client per accedere a EJB

Individua EJBTester.java in Esplora progetti. Fare clic con il tasto destro sulla classe EJBTester e selezionarerun file.

Verificare il seguente output nella console Netbeans.

run:
**********************
Welcome to Book Store
**********************
Options 
1. Add Book
2. Exit 
Enter Choice: 1
Enter book name: Learn Java
**********************
Welcome to Book Store
**********************
Options 
1. Add Book
2. Exit 
Enter Choice: 2
Book(s) entered so far: 1
1. Learn Java
BUILD SUCCESSFUL (total time: 13 seconds)

Output del registro di JBoss Application Server

È possibile trovare le seguenti voci di richiamata nel registro di JBoss

14:08:34,293 INFO  [STDOUT] postConstruct:: LibraryPersistentBean session bean created with entity Manager object
...
16:39:09,484 INFO  [STDOUT] BookCallbackListener.prePersist:: Book to be created with book id: 0
16:39:09,531 INFO  [STDOUT] BookCallbackListener.postPersist:: Book created with book id: 1
16:39:09,900 INFO  [STDOUT] BookCallbackListener.postLoad:: Loaded Book: 1
...