EJB: Exemplos de Session Beans

Exemplo de um Session Bean sem Estado

O Problema

• Vamos fazer uma aplicação de conversão de moedas
• A conversão será feita por um Session Bean sem estado, já que precisamos apenas fazer um processamento simples de transformação de números

A Solução: Criação do Bean

• A interface remota em Converter.java especifica os "business methods" do Bean

import javax.ejb.EJBObject;
import java.rmi.RemoteException;
import java.math.*;

public interface Converter extends EJBObject {
 
  public BigDecimal dollarToYen(BigDecimal dollars) throws RemoteException;
  public BigDecimal yenToEuro(BigDecimal yen) throws RemoteException;
}

• A home interface define métodos usados por um cliente para criar, localizar ou remover um EJB
• A home interface em ConverterHome.java contém um único método de criação que retorna um objeto do tipo da interface remota

import java.io.Serializable;
import java.rmi.RemoteException;
import javax.ejb.CreateException;
import javax.ejb.EJBHome;

public interface ConverterHome extends EJBHome {

  Converter create() throws RemoteException, CreateException;
}

• A classe de implementação está em ConverterBean.java e deve implementar os métodos prometidos pela interface remota:

import java.rmi.RemoteException; 
import javax.ejb.SessionBean;
import javax.ejb.SessionContext;
import java.math.*;

public class ConverterBean implements SessionBean {
  BigDecimal yenRate = new BigDecimal("121.6000");
  BigDecimal euroRate = new BigDecimal("0.0077"); 

  public BigDecimal dollarToYen(BigDecimal dollars) {
    BigDecimal result = dollars.multiply(yenRate);
    return result.setScale(2,BigDecimal.ROUND_UP);
  }

  public BigDecimal yenToEuro(BigDecimal yen) {
    BigDecimal result = yen.multiply(euroRate);
    return result.setScale(2,BigDecimal.ROUND_UP);
  }

  public ConverterBean() {}
  public void ejbCreate() {}
  public void ejbRemove() {}
  public void ejbActivate() {}
  public void ejbPassivate() {}
  public void setSessionContext(SessionContext sc) {}
} // ConverterBean

• Observe que o ConverterBean não implementa a interface remota
  • Quem realmente vai implementá-la é o container
  • Os clientes não acessam EJBs diretamente
• Observe que muitos métodos "callback" estão vazios
  • São chamados pelo container para você ter ganchos

A Solução: Compilação do Bean

• Agora, devemos compilar os fontes:

C:\...\src>ant converter
Buildfile: build.xml

init:

converter:
    [mkdir] Created dir: C:\Documents and Settings\JACQUES\Meus documentos\Cursos\Hp\j2ee\html\build\converter
    [javac] Compiling 4 source files to C:\Documents and Settings\JACQUES\Meus documentos\Cursos\Hp\j2ee\html\build\conv
erter
     [copy] Copying 1 file to C:\Documents and Settings\JACQUES\Meus documentos\Cursos\Hp\j2ee\html\build\converter

BUILD SUCCESSFUL

Total time: 5 seconds

A Solução: Packaging do Bean

• Agora, usaremos o deploytool para:
  • Criar o Deployment Descriptor do Bean
  • Empacotar o Deployment Descriptor  e as classes do Bean num arquivo JAR para EJB
  • Inserir o EJB JAR no arquivo da aplicação ConverterApp.ear
• Etapas
  • Selecione File -> New-> Application
  • Clique em Browse
  • No file chooser, navegue até src/converter
  • No campo "File Name", digite ConverterApp.ear
  • Clique em "New Application"
  • Clique em OK
  • Selecione File->New-> Enterprise Bean
  • Introduction Dialog Box: clique em Next
  • No EJB JAR Dialog Box:
    • Selecione o botão "Create new JAR File in Application"
    • No combo box, selecione "ConverterApp"
    • No campo "JAR Display Name", digite ConverterJAR
    • Clique em Edit
    • Na árvore "Available Files", localize o diretório build/converter
    • Selecione e adicione Converter.class, ConverterBean.class, ConverterHome.class
    • Clique em OK
    • Clique em Next
  • No General Dialog Box:
    • Em Bean Type, selecione Session
    • Selecione Stateless
    • No combo box "Enterprise Bean Class", selecione ConverterBean
    • No campo "Enterprise Bean Name", digite ConverterEJB
    • No combo box "Remote Home Interface", selecione ConverterHome
    • No combo box "Remote Interface", selecione Converter
    • Clique em Next
  • No Transaction Management Dialog Box:
    • Clique em Finish

A Solução: Criação do Cliente

• Podemos criar vários tipos de clientes
  • Application Client
  • Web Client
• Faremos um Web Client
• O código está em index.jsp

<%@ page import="Converter,ConverterHome,javax.ejb.*, javax.naming.*,
                 javax.rmi.PortableRemoteObject, java.rmi.RemoteException,
                 java.math.*" %>
<%!
  private Converter converter = null;
   public void jspInit() { 
      try {
         InitialContext ic = new InitialContext();
         Object objRef = ic.lookup("java:comp/env/ejb/TheConverter");
         ConverterHome home = (ConverterHome)PortableRemoteObject.narrow(objRef,
                                                           ConverterHome.class);
         converter = home.create();
      } catch (RemoteException ex) {
            System.out.println("Couldn't create converter bean."+ ex.getMessage());
      } catch (CreateException ex) {
            System.out.println("Couldn't create converter bean."+ ex.getMessage());
      } catch (NamingException ex) {
            System.out.println("Unable to lookup home: "+ "TheConverter "+ ex.getMessage());
      } 
   }

   public void jspDestroy() {    
         converter = null;
   }
%>
<html>
<head>
    <title>Converter</title>
</head>
<body bgcolor="white">
<h1><b><center>Converter</center></b></h1>
<hr>
<p>Enter an amount to convert:</p>
<form method="get">
<input type="text" name="amount" size="25">
<br>
<p>
<input type="submit" value="Submit">
<input type="reset" value="Reset">
</form>
<%
    String amount = request.getParameter("amount");
    if ( amount != null && amount.length() > 0 ) {
      BigDecimal d = new BigDecimal (amount);
%>
<p><%= amount %> dollars are <%= converter.dollarToYen(d) %> Yen.
<p><%= amount %> Yen are <%= converter.yenToEuro(d) %> Euro.
<%
    }
%>
</body>
</html> 

• Precisamos fazer 3 coisas:
  • Localizar a home interface
  • Criar uma instância de um EJB
  • Chamar um Business Method deste EJB
• Localizar a home interface
  • Primeiro criamos um contexto JNDI
  • Depois obtemos um objeto amarrado ao nome "ejb/TheConverter"
  • Finalmente, convertemos o objeto ao tipo correto ConverterHome
    • É como fazer um cast mas envolvendo objetos remotos
• Criar uma instância de um EJB
  • Feito com:
    Converter currencyConverter = home.create();
  • O método ConverterBean.ejbCreate() é chamado
• Chamar um Business Method deste EJB
  • Feito com:
    converter.dollarToYen(new BigDecimal(amount))
  • Na realidade, vamos chamar o método do container e este chama o método do objeto remoto (a instância do EJB)

A Solução: Compilação do Cliente

• Páginas JSP são automaticamente convertidas para servlets e compiladas pelo servidor J2EE

A Solução: Packaging do Cliente

• No deploytool:
  • Selecione File->New->Web Component
  • No dialog box "Introduction"
    • Clique em "Next"
  • No dialog box "WAR File"
    • Selecione "Create New WAR File in Application"
    • Na combo box, selecione "ConverterApp"
    • No campo "WAR Display Name", digite "ConverterWAR"
    • Clique em "Edit"
    • Sob a árvore "Available Files", localize o diretório build/converter
    • Selecione e adicione index.jsp
    • Clique em "OK"
    • Clique em "Next"
  • Selecione "JSP"
  • Clique em "Next"
  • No dialog box "Component General Properties"
    • No combo box "JSP Filename", selecione index.jsp
    • Clique em "Finish"
  • Especifique a referência EJB:
    • Selecione ConverterWAR
    • Selecione a orelha "EJB Refs"
    • Clique em Add
    • Na coluna "Coded Name", digite "ejb/TheConverter"
    • Na coluna "Type", selecione Session
    • Na coluna "Interfaces", selecione Remote
    • Na coluna "Home Interface", digite "ConverterHome"
    • Na coluna "Local/Remote Interface", digite "Converter"
  • Especifique o nome JNDI
    • Selecione ConverterApp
    • Selecione a orelha "JNDI Names"
    • Para especificar um nome JNDI para o Bean, examine a tabela "Application" e localize o componente "ConverterEJB" e digite MyConverter na coluna "JNDI Name"
    • Para mapear as referências, examine a tabela "References" e digite MyConverter em "JNDI Name" para cada linha
  • Salva

A solução: O Deployment Descriptor

O DD da aplicação

• O deployment descriptor para a aplicação como um todo está divido em duas partes
  • Parte independente do servidor (application.xml)
  • Parte dependente do servidor (sun-j2ee-ri.xml)
• Aqui está application.xml
  • Observe os dois módulos
  • Observe o context root para o módulo web

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE application PUBLIC '-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN' 'http://java.sun.com/dtd/application_1_3.dtd'>

<application>
  <display-name>ConverterApp</display-name>
  <description>Application description</description>
  <module>
    <web>
      <web-uri>war-ic.war</web-uri>
      <context-root>converter</context-root>
    </web>
  </module>
  <module>
    <ejb>ejb-jar-ic.jar</ejb>
  </module>
</application>

• Aqui está sun-j2ee-ri.xml (parcial)

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE j2ee-ri-specific-information PUBLIC '-//Sun Microsystems Inc.//DTD J2EE Reference Implementation 1.3//EN' 'http://localhost:8000/sun-j2ee-ri_1_3.dtd'>

<j2ee-ri-specific-information>
  <server-name></server-name>
  <rolemapping />
  <web>
    <module-name>war-ic.war</module-name>
    <context-root>converter</context-root>
    <ejb-ref>
      <ejb-ref-name>ejb/TheConverter</ejb-ref-name>
      <jndi-name>MyConverter</jndi-name>
    </ejb-ref>
  </web>
  <enterprise-beans>
    <module-name>ejb-jar-ic.jar</module-name>
    <unique-id>0</unique-id>
    <ejb>
      <ejb-name>ConverterEJB</ejb-name>
      <jndi-name>MyConverter</jndi-name>
...
    </ejb>
  </enterprise-beans>
</j2ee-ri-specific-information>

O DD do bean EJB

• Eis o arquivo ejb-jar.xml, o deployment descriptor do EJB, contido no arquivo JAR do bean (ejb-jar-ic.jar)que, por sua vez está no arquivo ConverterApp.ear

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE ejb-jar PUBLIC '-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN' 'http://java.sun.com/dtd/ejb-jar_2_0.dtd'>

<ejb-jar>
  <display-name>ConverterJAR</display-name>
  <enterprise-beans>
    <session>
      <display-name>ConverterEJB</display-name>
      <ejb-name>ConverterEJB</ejb-name>
      <home>ConverterHome</home>
      <remote>Converter</remote>
      <ejb-class>ConverterBean</ejb-class>
      <session-type>Stateless</session-type>
      <transaction-type>Bean</transaction-type>
      <security-identity>
        <description></description>
        <use-caller-identity></use-caller-identity>
      </security-identity>
    </session>
  </enterprise-beans>
</ejb-jar>

A Solução: Deployment da Aplicação

• Etapas:
  • O servidor j2ee deve estar funcionando
  • Selecione a aplicação "ConverterApp"
  • Selecione Tools->Deploy
  • No dialogo box "Introduction", confirme ConverterApp e o servidor apropriado
  • No campo de texto, entre o nome completo src/converter/ConverterAppClient.jar
    • Este arquivo vai conter os stubs para acessar o ConverterEJB bean remotamente
  • Clique em Next
  • No dialog box "JNDI Names", verifique os nomes usados da seção anterior
  • Clique em Next
  • No dialog box "WAR Context Root", digite "converter" no campo "Context Root"
  • Clique em "Next"
  • No dialogo box "Review", clique em Finish

A Solução: Execução da Aplicação

• URL http://anjinho.dsc.ufpb.br:8080/converter

Exemplo de um Session Bean com Estado

• Criaremos um Bean de cesta de compras, CartEJB
• Você concorda que uma cesta de compras mantida no servidor não poderia ser stateless?
• O bean tem a seguinte funcionalidade:
  • Adicionar um livro
  • Remover um livro
  • Examinar conteúdo
• Deixo como exercício fazer um Cart para qualquer tipo de objeto vendável
• Precisamos fazer o seguinte:
  • Uma interface Home (CartHome)
  • Uma interface Remote (Cart)
  • Uma classe de implementação (CartBean)

A Remote Interface

• Define os Business Methods

import java.util.*;
import javax.ejb.EJBObject;
import java.rmi.RemoteException;

public interface Cart extends EJBObject {
 
  public void addBook(String title) throws RemoteException;
  public void removeBook(String title) throws BookException,
                                              RemoteException;
  public Vector getContents() throws RemoteException;
}

A Home Interface

• Define os métodos de criação que podem ser chamados pelo cliente remoto

import java.io.Serializable;
import java.rmi.RemoteException;
import javax.ejb.CreateException;
import javax.ejb.EJBHome;

public interface CartHome extends EJBHome {
 
  Cart create(String person) throws RemoteException, CreateException;
  Cart create(String person, String id) throws RemoteException, 
                                               CreateException; 
}

Classe de Implementação

• Algumas regras a obedecer:
  • Implementa a interface SessionBean
  • A classe deve ser "public" (devido à instrospecção do Java)
  • A classe não pode ser abstract ou final
  • Para cada método create na interface Home, a classe de implementação deve implementar um método ejbCreate
    • Lembre que essa classe não implementa a Remote interface
    • Não é chamada pelo cliente
    • Só é chamada pelo container
  • Implementa os Business Methods da Remote Interface
  • Contém um construtor público sem parâmetro
  • Não deve definir o método finalize
• O código segue:

import java.util.*;
import javax.ejb.*;

public class CartBean implements SessionBean {

  String customerName;
  String customerId;
  Vector contents;

  public void ejbCreate(String person) throws CreateException {
    if (person == null) {
      throw new CreateException("Null person not allowed.");
    } else {
      customerName = person;
    }
    customerId = "0";
    contents = new Vector();
  }

  public void ejbCreate(String person, String id) throws CreateException {
    ejbCreate(person);
    IdVerifier idChecker = new IdVerifier();
    if (idChecker.validate(id)) {
      customerId = id;
    } else {
      throw new CreateException("Invalid id: " + id);
    }
  }

  public void addBook(String title) {
    contents.add(title);
  }

  public void removeBook(String title) throws BookException {
    boolean result = contents.remove(title);
    if (result == false) {
      throw new BookException(title + " not in cart.");
    }
  }

  public Vector getContents() {
    return contents;
  }

  public CartBean() {}
  public void ejbRemove() {}
  public void ejbActivate() {}
  public void ejbPassivate() {}
  public void setSessionContext(SessionContext sc) {}
}

• As classes de apoio seguem:

public class BookException extends Exception {

  public BookException() {
  }

  public BookException(String msg) {
    super(msg);
  }
}

public class IdVerifier {

  public IdVerifier() {
  }

  public boolean validate(String id) {

    boolean result = true;
    for (int i = 0; i < id.length(); i++) {
      if (Character.isDigit(id.charAt(i)) == false)
        result = false;
    }
    return result;
  }
}

A interface SessionBean

• Há vários métodos de callback
  • Chamados pelo container em momentos apropriados
• Foram deixados vazios porque não são necessários aqui
• Para entender quando os callbacks são chamados, examine a figura abaixo que representa o ciclo de vida de uma Stateful Session Bean

Os Business Methods

• Examine a implementação dos Business methods acima
• Eles seriam chamados assim pelo cliente:

  Cart shoppingCart = home.create(“Duke DeEarl”, “123”);
  . . .
  shoppingCart.addBook(“The Martian Chronicles”);
  shoppingCart.removeBook(“Alice In Wonderland”);
  bookList = shoppingCart.getContents();
  . . .

• Você pode lançar suas exceções nos métodos: eles serão repassados para o cliente
  • Exemplo: BookException
  • Exceções EJBException indicam erros de sistema
    • São colocadas dentro de uma RemoteException que o cliente captura
  • Outras exceções (como BookException) não são colocadas numa RemoteException
• O deployment descriptor será o seguinte quando terminarmos de criar o componente

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE ejb-jar PUBLIC '-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN' 'http://java.sun.com/dtd/ejb-jar_2_0.dtd'>

<ejb-jar>
  <display-name>CartJAR</display-name>
  <enterprise-beans>
    <session>
      <display-name>CartEJB</display-name>
      <ejb-name>CartEJB</ejb-name>
      <home>CartHome</home>
      <remote>Cart</remote>
      <ejb-class>CartBean</ejb-class>
      <session-type>Stateful</session-type>
      <transaction-type>Container</transaction-type>
      <security-identity>
        <description></description>
        <use-caller-identity></use-caller-identity>
      </security-identity>
    </session>
  </enterprise-beans>
...
</ejb-jar>

Criação de um cliente

• Vamos fazer um cliente simples (Application Client)

import java.util.*;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.rmi.PortableRemoteObject;

public class CartClient {

  public static void main(String[] args) {
    try {
      Context initial = new InitialContext();
      Object objref = initial.lookup("java:comp/env/ejb/SimpleCart");

      CartHome home = 
          (CartHome)PortableRemoteObject.narrow(objref, 
                                       CartHome.class);

      Cart shoppingCart = home.create("Duke DeEarl","123");

      shoppingCart.addBook("The Martian Chronicles");
      shoppingCart.addBook("2001 A Space Odyssey");
      shoppingCart.addBook("The Left Hand of Darkness");
      
      Vector bookList = shoppingCart.getContents();
      Iterator enumer = bookList.iterator();
      while (enumer.hasNext()) {
        String title = (String) enumer.next();
        System.out.println(title);
      }

      shoppingCart.removeBook("Alice in Wonderland");
      shoppingCart.remove();

      System.exit(0);

    } catch (BookException ex) {
      System.err.println("Caught a BookException: " + ex.getMessage());
      System.exit(0);
    } catch (Exception ex) {
      System.err.println("Caught an unexpected exception!");
      ex.printStackTrace();
      System.exit(1);
    }
  } 
} 

• Compile com "ant cart"
• Usando o deploytool, crie uma aplicação com as seguintes características:
  • Nome no arquivo da aplicação: CartApp.ear
  • Dois modules:
    • Um JAR contendo o EJB CartEJB com nome de referência ejb/SimpleCart e nome JNDI: MyCart
    • Um JAR contendo a aplicação cliente
• Caso tenha dúvidas, aqui está o arquivo CartApp.ear final

Execução do exemplo CartEJB

• Agora faça o deployment, pedindo para retornar o "JAR Cliente" e execute a aplicação:
  • set APPCPATH=CartAppClient.jar (MSDOS)
  • APPCPATH=CartAppClient.jar export APPCPATH (UNIX)
  • runclient -client CartApp.ear -name CartClient -textauth
    • login: guest
    • senha: guest123
  • A saída deve ser como segue (observe o tratamento de exceções)

C:\...\src\cart\earpronto>runclient -client CartApp.ear -
name CartClient -textauth
Initiating login ...
Username = null
Enter Username:guest
Enter Password:guest123
Binding name:`java:comp/env/ejb/SimpleCart`
The Martian Chronicles
2001 A Space Odyssey
The Left Hand of Darkness
Caught a BookException: Alice in Wonderland not in cart.
Unbinding name:`java:comp/env/ejb/SimpleCart`

exsession programa