You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by vi...@apache.org on 2012/04/26 13:53:25 UTC
svn commit: r1330791 -
/openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext
Author: vishwanathk
Date: Thu Apr 26 11:53:24 2012
New Revision: 1330791
URL: http://svn.apache.org/viewvc?rev=1330791&view=rev
Log:
Correct ejb 2.1 compatibility doc
Modified:
openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext
Modified: openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext
URL: http://svn.apache.org/viewvc/openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext?rev=1330791&r1=1330790&r2=1330791&view=diff
==============================================================================
--- openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext (original)
+++ openejb/site/trunk/content/ejb-2.1-compatibility-example.mdtext Thu Apr 26 11:53:24 2012
@@ -1,4 +1,5 @@
Title: EJB 2.1 Compatibility Example
+
<a name="EJB2.1CompatibilityExample-Overview"></a>
# Overview
@@ -20,85 +21,449 @@ backwards compatibility with older clien
API still being used. The advantage is that you can turn EJB 2.1 beans
into EJB 3.0 beans without having to update any code consuming that EJB.
-_The source for this example is in the "component-interfaces" directory
-located in the [openejb-examples.zip](openejb:download.html)
- available on the download page._
+Source available in [svn](http://svn.apache.org/repos/asf/openejb/trunk/openejb/examples/component-interfaces) or [git](https://github.com/apache/openejb/tree/trunk/openejb/examples/component-interfaces). Open a [JIRA](https://issues.apache.org/jira/browse/TOMEE) with patch or pull request*
-<a name="EJB2.1CompatibilityExample-TheCode"></a>
-# The Code
-<a name="EJB2.1CompatibilityExample-AnnotatedBeanClass"></a>
-## Annotated Bean Class
+## FriendlyPerson
-{snippet:id=code|url=openejb3/examples/component-interfaces/src/main/java/org/superbiz/FriendlyPersonImpl.java|lang=java}
+ package org.superbiz;
+
+ import javax.ejb.Init;
+ import javax.ejb.Local;
+ import javax.ejb.LocalHome;
+ import javax.ejb.Remote;
+ import javax.ejb.RemoteHome;
+ import javax.ejb.Remove;
+ import javax.ejb.Stateful;
+ import java.text.MessageFormat;
+ import java.util.HashMap;
+ import java.util.Locale;
+ import java.util.Properties;
+
+ /**
+ * This is an EJB 3 style pojo stateful session bean
+ * it does not need to implement javax.ejb.SessionBean
+ *
+ * @author <a href="mailto:david.blevins@visi.com">David Blevins</a>
+ */
+ //START SNIPPET: code
+
+ // EJB 3.0 Style business interfaces
+ // Each of these interfaces are already annotated in the classes
+ // themselves with @Remote and @Local, so annotating them here
+ // in the bean class again is not really required.
+ @Remote({FriendlyPersonRemote.class})
+ @Local({FriendlyPersonLocal.class})
+
+ // EJB 2.1 Style component interfaces
+ // These interfaces, however, must be annotated here in the bean class.
+ // Use of @RemoteHome in the FriendlyPersonEjbHome class itself is not allowed.
+ // Use of @LocalHome in the FriendlyPersonEjbLocalHome class itself is also not allowed.
+ @RemoteHome(FriendlyPersonEjbHome.class)
+ @LocalHome(FriendlyPersonEjbLocalHome.class)
+
+ @Stateful
+ public class FriendlyPerson implements FriendlyPersonLocal, FriendlyPersonRemote {
+
+ private final HashMap<String, MessageFormat> greetings;
+ private final Properties languagePreferences;
+
+ private String defaultLanguage;
+
+ public FriendlyPerson() {
+ greetings = new HashMap();
+ languagePreferences = new Properties();
+ defaultLanguage = Locale.getDefault().getLanguage();
+
+ addGreeting("en", "Hello {0}!");
+ addGreeting("es", "Hola {0}!");
+ addGreeting("fr", "Bonjour {0}!");
+ addGreeting("pl", "Witaj {0}!");
+ }
+
+ /**
+ * This method corresponds to the FriendlyPersonEjbHome.create() method
+ * and the FriendlyPersonEjbLocalHome.create()
+ * <p/>
+ * If you do not have an EJBHome or EJBLocalHome interface, this method
+ * can be deleted.
+ */
+ @Init
+ public void create() {
+ }
+
+ /**
+ * This method corresponds to the following methods:
+ * - EJBObject.remove()
+ * - EJBHome.remove(ejbObject)
+ * - EJBLocalObject.remove()
+ * - EJBLocalHome.remove(ejbObject)
+ * <p/>
+ * If you do not have an EJBHome or EJBLocalHome interface, this method
+ * can be deleted.
+ */
+ @Remove
+ public void remove() {
+ }
+
+ public String greet(String friend) {
+ String language = languagePreferences.getProperty(friend, defaultLanguage);
+ return greet(language, friend);
+ }
+
+ public String greet(String language, String friend) {
+ MessageFormat greeting = greetings.get(language);
+ if (greeting == null) {
+ Locale locale = new Locale(language);
+ return "Sorry, I don't speak " + locale.getDisplayLanguage() + ".";
+ }
+
+ return greeting.format(new Object[]{friend});
+ }
+
+ public void addGreeting(String language, String message) {
+ greetings.put(language, new MessageFormat(message));
+ }
+
+ public void setLanguagePreferences(String friend, String language) {
+ languagePreferences.put(friend, language);
+ }
+
+ public String getDefaultLanguage() {
+ return defaultLanguage;
+ }
+
+ public void setDefaultLanguage(String defaultLanguage) {
+ this.defaultLanguage = defaultLanguage;
+ }
+ }
-<a name="EJB2.1CompatibilityExample-EJB2.1HomeAndRemoteviews"></a>
-## EJB 2.1 Home And Remote views
+## FriendlyPersonEjbHome
-{snippet:id=code|url=openejb3/examples/component-interfaces/src/main/java/org/superbiz/FriendlyPersonEjbHome.java|lang=java}
+ package org.superbiz;
+
+ //START SNIPPET: code
+
+ import javax.ejb.CreateException;
+ import javax.ejb.EJBHome;
+ import java.rmi.RemoteException;
+
+ public interface FriendlyPersonEjbHome extends EJBHome {
+ FriendlyPersonEjbObject create() throws CreateException, RemoteException;
+ }
-{snippet:id=code|url=openejb3/examples/component-interfaces/src/main/java/org/superbiz/FriendlyPersonEjbObject.java|lang=java}
+## FriendlyPersonEjbLocalHome
-<a name="EJB2.1CompatibilityExample-TestCase"></a>
-# Test Case
+ package org.superbiz;
+
+ //START SNIPPET: code
+
+ import javax.ejb.CreateException;
+ import javax.ejb.EJBLocalHome;
+ import java.rmi.RemoteException;
+
+ public interface FriendlyPersonEjbLocalHome extends EJBLocalHome {
+ FriendlyPersonEjbLocalObject create() throws CreateException, RemoteException;
+ }
-{snippet:id=code|url=openejb3/examples/component-interfaces/src/test/java/org/superbiz/FriendlyPersonTest.java|lang=java|id=remotehome}
+## FriendlyPersonEjbLocalObject
-<a name="EJB2.1CompatibilityExample-Runningit"></a>
-# Running it
+ package org.superbiz;
+
+ import javax.ejb.EJBLocalObject;
+
+ public interface FriendlyPersonEjbLocalObject extends EJBLocalObject {
+ String greet(String friend);
+
+ String greet(String language, String friend);
+
+ void addGreeting(String language, String message);
+
+ void setLanguagePreferences(String friend, String language);
+
+ String getDefaultLanguage();
+
+ void setDefaultLanguage(String defaultLanguage);
+ }
+
+## FriendlyPersonEjbObject
+
+ package org.superbiz;
+
+ //START SNIPPET: code
+
+ import javax.ejb.EJBObject;
+ import java.rmi.RemoteException;
+
+ public interface FriendlyPersonEjbObject extends EJBObject {
+ String greet(String friend) throws RemoteException;
+
+ String greet(String language, String friend) throws RemoteException;
+
+ void addGreeting(String language, String message) throws RemoteException;
+
+ void setLanguagePreferences(String friend, String language) throws RemoteException;
+
+ String getDefaultLanguage() throws RemoteException;
+
+ void setDefaultLanguage(String defaultLanguage) throws RemoteException;
+ }
-Running the example is fairly simple. In the "component-interfaces"
-directory of the [examples zip](openejb:download.html)
-, just run:
+## FriendlyPersonLocal
-> $ mvn clean install
+ package org.superbiz;
+
+ //START SNIPPET: code
+
+ import javax.ejb.Local;
+
+ @Local
+ public interface FriendlyPersonLocal {
+ String greet(String friend);
+
+ String greet(String language, String friend);
+
+ void addGreeting(String language, String message);
+
+ void setLanguagePreferences(String friend, String language);
+
+ String getDefaultLanguage();
+
+ void setDefaultLanguage(String defaultLanguage);
+ }
-Which should create output like the following.
+## FriendlyPersonRemote
+ package org.superbiz;
+
+ import javax.ejb.Remote;
+
+ //START SNIPPET: code
+ @Remote
+ public interface FriendlyPersonRemote {
+ String greet(String friend);
+
+ String greet(String language, String friend);
+
+ void addGreeting(String language, String message);
+
+ void setLanguagePreferences(String friend, String language);
+
+ String getDefaultLanguage();
+
+ void setDefaultLanguage(String defaultLanguage);
+ }
+## FriendlyPersonTest
+
+ package org.superbiz;
+
+ import junit.framework.TestCase;
+
+ import javax.ejb.embeddable.EJBContainer;
+ import javax.naming.Context;
+ import java.util.Locale;
+
+ /**
+ * @author <a href="mailto:david.blevins@visi.com">David Blevins</a>
+ * @version $Rev: 1090810 $ $Date: 2011-04-10 07:49:26 -0700 (Sun, 10 Apr 2011) $
+ */
+ public class FriendlyPersonTest extends TestCase {
+
+ private Context context;
+
+ protected void setUp() throws Exception {
+ context = EJBContainer.createEJBContainer().getContext();
+ }
+
+ /**
+ * Here we lookup and test the FriendlyPerson bean via its EJB 2.1 EJBHome and EJBObject interfaces
+ *
+ * @throws Exception
+ */
+ //START SNIPPET: remotehome
+ public void testEjbHomeAndEjbObject() throws Exception {
+ Object object = context.lookup("java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonEjbHome");
+ FriendlyPersonEjbHome home = (FriendlyPersonEjbHome) object;
+ FriendlyPersonEjbObject friendlyPerson = home.create();
+
+ friendlyPerson.setDefaultLanguage("en");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hello Amelia!", friendlyPerson.greet("Amelia"));
+
+ friendlyPerson.setLanguagePreferences("Amelia", "es");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hola Amelia!", friendlyPerson.greet("Amelia"));
+
+ // Amelia took some French, let's see if she remembers
+ assertEquals("Bonjour Amelia!", friendlyPerson.greet("fr", "Amelia"));
+
+ // Dave should take some Polish and if he had, he could say Hi in Polish
+ assertEquals("Witaj Dave!", friendlyPerson.greet("pl", "Dave"));
+
+ // Let's see if I speak Portuguese
+ assertEquals("Sorry, I don't speak " + new Locale("pt").getDisplayLanguage() + ".", friendlyPerson.greet("pt", "David"));
+
+ // Ok, well I've been meaning to learn, so...
+ friendlyPerson.addGreeting("pt", "Ola {0}!");
+
+ assertEquals("Ola David!", friendlyPerson.greet("pt", "David"));
+ }
+ //END SNIPPET: remotehome
+
+
+ /**
+ * Here we lookup and test the FriendlyPerson bean via its EJB 2.1 EJBLocalHome and EJBLocalObject interfaces
+ *
+ * @throws Exception
+ */
+ public void testEjbLocalHomeAndEjbLocalObject() throws Exception {
+ Object object = context.lookup("java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonEjbLocalHome");
+ FriendlyPersonEjbLocalHome home = (FriendlyPersonEjbLocalHome) object;
+ FriendlyPersonEjbLocalObject friendlyPerson = home.create();
+
+ friendlyPerson.setDefaultLanguage("en");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hello Amelia!", friendlyPerson.greet("Amelia"));
+
+ friendlyPerson.setLanguagePreferences("Amelia", "es");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hola Amelia!", friendlyPerson.greet("Amelia"));
+
+ // Amelia took some French, let's see if she remembers
+ assertEquals("Bonjour Amelia!", friendlyPerson.greet("fr", "Amelia"));
+
+ // Dave should take some Polish and if he had, he could say Hi in Polish
+ assertEquals("Witaj Dave!", friendlyPerson.greet("pl", "Dave"));
+
+ // Let's see if I speak Portuguese
+ assertEquals("Sorry, I don't speak " + new Locale("pt").getDisplayLanguage() + ".", friendlyPerson.greet("pt", "David"));
+
+ // Ok, well I've been meaning to learn, so...
+ friendlyPerson.addGreeting("pt", "Ola {0}!");
+
+ assertEquals("Ola David!", friendlyPerson.greet("pt", "David"));
+ }
+
+ /**
+ * Here we lookup and test the FriendlyPerson bean via its EJB 3.0 business remote interface
+ *
+ * @throws Exception
+ */
+ //START SNIPPET: remote
+ public void testBusinessRemote() throws Exception {
+ Object object = context.lookup("java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonRemote");
+
+ FriendlyPersonRemote friendlyPerson = (FriendlyPersonRemote) object;
+
+ friendlyPerson.setDefaultLanguage("en");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hello Amelia!", friendlyPerson.greet("Amelia"));
+
+ friendlyPerson.setLanguagePreferences("Amelia", "es");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hola Amelia!", friendlyPerson.greet("Amelia"));
+
+ // Amelia took some French, let's see if she remembers
+ assertEquals("Bonjour Amelia!", friendlyPerson.greet("fr", "Amelia"));
+
+ // Dave should take some Polish and if he had, he could say Hi in Polish
+ assertEquals("Witaj Dave!", friendlyPerson.greet("pl", "Dave"));
+
+ // Let's see if I speak Portuguese
+ assertEquals("Sorry, I don't speak " + new Locale("pt").getDisplayLanguage() + ".", friendlyPerson.greet("pt", "David"));
+
+ // Ok, well I've been meaning to learn, so...
+ friendlyPerson.addGreeting("pt", "Ola {0}!");
+
+ assertEquals("Ola David!", friendlyPerson.greet("pt", "David"));
+ }
+ //START SNIPPET: remote
+
+ /**
+ * Here we lookup and test the FriendlyPerson bean via its EJB 3.0 business local interface
+ *
+ * @throws Exception
+ */
+ public void testBusinessLocal() throws Exception {
+ Object object = context.lookup("java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonLocal");
+
+ FriendlyPersonLocal friendlyPerson = (FriendlyPersonLocal) object;
+
+ friendlyPerson.setDefaultLanguage("en");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hello Amelia!", friendlyPerson.greet("Amelia"));
+
+ friendlyPerson.setLanguagePreferences("Amelia", "es");
+
+ assertEquals("Hello David!", friendlyPerson.greet("David"));
+ assertEquals("Hola Amelia!", friendlyPerson.greet("Amelia"));
+
+ // Amelia took some French, let's see if she remembers
+ assertEquals("Bonjour Amelia!", friendlyPerson.greet("fr", "Amelia"));
+
+ // Dave should take some Polish and if he had, he could say Hi in Polish
+ assertEquals("Witaj Dave!", friendlyPerson.greet("pl", "Dave"));
+
+ // Let's see if I speak Portuguese
+ assertEquals("Sorry, I don't speak " + new Locale("pt").getDisplayLanguage() + ".", friendlyPerson.greet("pt", "David"));
+
+ // Ok, well I've been meaning to learn, so...
+ friendlyPerson.addGreeting("pt", "Ola {0}!");
+
+ assertEquals("Ola David!", friendlyPerson.greet("pt", "David"));
+ }
+
+ }
+
+# Running
+
+
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running org.superbiz.FriendlyPersonTest
- Apache OpenEJB 3.0 build: 20080408-04:13
+ Apache OpenEJB 4.0.0-beta-1 build: 20111002-04:06
http://openejb.apache.org/
- INFO - openejb.home =
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces
- INFO - openejb.base =
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces
- INFO - Configuring Service(id=Default Security Service,
-type=SecurityService, provider-id=Default Security Service)
- INFO - Configuring Service(id=Default Transaction Manager,
-type=TransactionManager, provider-id=Default Transaction Manager)
- INFO - Configuring Service(id=Default JDK 1.3 ProxyFactory,
-type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory)
- INFO - Found EjbModule in classpath:
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces/target/classes
- INFO - Configuring app:
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces/target/classes
- INFO - Configuring Service(id=Default Stateful Container, type=Container,
-provider-id=Default Stateful Container)
- INFO - Auto-creating a container for bean FriendlyPerson:
-Container(type=STATEFUL, id=Default Stateful Container)
- INFO - Loaded Module:
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces/target/classes
- INFO - Assembling app:
-/Users/dblevins/work/openejb-3.0/examples/component-interfaces/target/classes
- INFO - Jndi(name=FriendlyPersonRemoteHome) -->
-Ejb(deployment-id=FriendlyPerson)
- INFO - Jndi(name=FriendlyPersonLocalHome) -->
-Ejb(deployment-id=FriendlyPerson)
- INFO - Jndi(name=FriendlyPersonLocal) --> Ejb(deployment-id=FriendlyPerson)
- INFO - Jndi(name=FriendlyPersonRemote) -->
-Ejb(deployment-id=FriendlyPerson)
- INFO - Created Ejb(deployment-id=FriendlyPerson, ejb-name=FriendlyPerson,
-container=Default Stateful Container)
- INFO - Deployed
-Application(path=/Users/dblevins/work/openejb-3.0/examples/component-interfaces/target/classes)
- Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.741 sec
+ INFO - openejb.home = /Users/dblevins/examples/component-interfaces
+ INFO - openejb.base = /Users/dblevins/examples/component-interfaces
+ INFO - Using 'javax.ejb.embeddable.EJBContainer=true'
+ INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service)
+ INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager)
+ INFO - Found EjbModule in classpath: /Users/dblevins/examples/component-interfaces/target/classes
+ INFO - Beginning load: /Users/dblevins/examples/component-interfaces/target/classes
+ INFO - Configuring enterprise application: /Users/dblevins/examples/component-interfaces
+ INFO - Configuring Service(id=Default Stateful Container, type=Container, provider-id=Default Stateful Container)
+ INFO - Auto-creating a container for bean FriendlyPerson: Container(type=STATEFUL, id=Default Stateful Container)
+ INFO - Configuring Service(id=Default Managed Container, type=Container, provider-id=Default Managed Container)
+ INFO - Auto-creating a container for bean org.superbiz.FriendlyPersonTest: Container(type=MANAGED, id=Default Managed Container)
+ INFO - Enterprise application "/Users/dblevins/examples/component-interfaces" loaded.
+ INFO - Assembling app: /Users/dblevins/examples/component-interfaces
+ INFO - Jndi(name="java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonLocal")
+ INFO - Jndi(name="java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonRemote")
+ INFO - Jndi(name="java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonEjbLocalHome")
+ INFO - Jndi(name="java:global/component-interfaces/FriendlyPerson!org.superbiz.FriendlyPersonEjbHome")
+ INFO - Jndi(name="java:global/component-interfaces/FriendlyPerson")
+ INFO - Jndi(name="java:global/EjbModule803660549/org.superbiz.FriendlyPersonTest!org.superbiz.FriendlyPersonTest")
+ INFO - Jndi(name="java:global/EjbModule803660549/org.superbiz.FriendlyPersonTest")
+ INFO - Created Ejb(deployment-id=FriendlyPerson, ejb-name=FriendlyPerson, container=Default Stateful Container)
+ INFO - Created Ejb(deployment-id=org.superbiz.FriendlyPersonTest, ejb-name=org.superbiz.FriendlyPersonTest, container=Default Managed Container)
+ INFO - Started Ejb(deployment-id=FriendlyPerson, ejb-name=FriendlyPerson, container=Default Stateful Container)
+ INFO - Started Ejb(deployment-id=org.superbiz.FriendlyPersonTest, ejb-name=org.superbiz.FriendlyPersonTest, container=Default Managed Container)
+ INFO - Deployed Application(path=/Users/dblevins/examples/component-interfaces)
+ INFO - EJBContainer already initialized. Call ejbContainer.close() to allow reinitialization
+ INFO - EJBContainer already initialized. Call ejbContainer.close() to allow reinitialization
+ INFO - EJBContainer already initialized. Call ejbContainer.close() to allow reinitialization
+ Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.444 sec
Results :
Tests run: 4, Failures: 0, Errors: 0, Skipped: 0
-
-
+