Stateful Session Bean has been edited by Ashish Jain (May 25, 2008).

(View changes)


This application will take you through the basics of Stateful Session Bean. This application will demonstrate how annotations like @Stateful, @Resource, @PostConstruct, @PreDestroy, @PrePassivate, @PostActivate, @Remove are used in an EJB3 application.

Basically a Stateful Session EJB is used whenever there is a requirement to maintain a session. The example is a user registration process wherein the registration process is a two step process. First page prompts to enter your personal credentials and second page prompts to enter your billing and credit card information. The session is maintained till the user has filled up both the jsp pages. Later the complete information is populated on to a database. The application has a Controller servlet which routes the call received from the jsp client to the Bean class, setter methods and jsp pages.

To run this tutorial, as a minimum you will be required to have installed the following prerequisite software.

  • Sun JDK 5.0+ (J2SE 1.5)
  • Eclipse (Eclipse Classic package of Europa distribution), which is platform specific
  • Web Tools Platform (WTP) 2.0.1
  • Data Tools Platform (DTP) 1.5.1
  • Eclipse Modeling Framework (EMF) 2.3.1
  • Graphical Editing Framework (GEF) 3.3.1

Details on installing eclipse are provided in the Development environment section.
This tutorial is organized in the following sections:

Creating a EJB Project

  1. Right click Under Project Explorer and Select New->EJB Project.

  2. Name the project as StatefulBean. Select Next.

  3. Mark the fields as suggested in the screenshot and Select Next.

  4. Uncheck Generate Deployment Descriptor. This is beacuse we are using annotations is our applications and so deployment descriptors are redundant entity. Select Next.

  5. On next screen select all default values and Select finish.

    This creates a skeleton for the EJB project. Next steps are adding the bean class, bean interface and setter/getter methods.
  6. Right click on ejbModule in StatefulBean project and select New->class.

  7. Name the class as PersonalInfo and package as ejb.stateful. Select Finish.

  8. Add the following code to
    package ejb.stateful;
    public class PersonalInfo implements {
    private static final long serialVersionUID = 1L;
    private String FirstName;
    private String LastName;
    private String UserName;
    private String Password;
    private String Nationality;
    public void setFirstName(String FirstName)
    public void setLastName(String LastName)
    public void setUserName(String UserName)
    public void setPassword(String Password)
    public void setNationality(String Nationality)
    public String getFirstName()
    	return FirstName;
    public String getLastName()
    	return LastName;
    public String getUserName()
    	return UserName;
    public String getPassword()
    	return Password;
    public String getNationality()
    	return Nationality;

  9. Similarly create a class and add the following code.
    package ejb.stateful;
    public class BillingInfo implements
    	private static final long serialVersionUID = 1L;
    	private String houseNo;
    	private String street;
    	private String city;
    	private String pincode;
    	private String country;
    	private String bank;
    	private String cardno;
    	public void setBank(String bank)
    	public void setCardno(String cardno)
    	public void setHouseNo(String houseNo)
    	public void setStreet(String street)
    	public void setCity(String city)
    	public void setPincode(String pincode)
    	public void setCountry(String country)
    	public String getBank()
    		return bank;
    	public String getCardno()
    		return cardno;
    	public String getHouseNo()
    		return houseNo;
    	public String getStreet()
    		return street;
    	public String getCity()
    		return city;
    	public String getPincode()
    		return pincode;
    	public String getCountry()
    		return country;
    } and are classes for setting and getting the user information.

  10. Now we will add the Business interface or bean interface. Right click on the package ejb.stateful and Select New->Interface.

  11. Name the interface as AccountCreator and Select Finish.

  12. Add the following code to AccountCreator interface.
    package ejb.stateful;
    import javax.ejb.Remote;
    public interface AccountCreator {
    void addPersonalInfo(PersonalInfo personalinfo);
    void addBillingInfo(BillingInfo billinginfo);
    void createAccount();


    Once you enter this code you might see errors like @EJB can be resolved. Currently there are some limitations with the geronimo eclipse plugin which will resolved soon. We will soon suggest you how to get rid of those errors.

  13. Next step is to add the implementation to the interface. Right click on ejb.stateful interface and select New->class.

  14. Name the bean class as AccountCreatorBean and Select Finish.

  15. Add the following code to AccountCreatorBean.
    package ejb.stateful;
    import java.sql.Connection;
    import javax.annotation.PostConstruct;
    import javax.annotation.PreDestroy;
    import javax.annotation.Resource;
    import javax.ejb.PostActivate;
    import javax.ejb.PrePassivate;
    import javax.ejb.Remove;
    import javax.ejb.Stateful;
    import javax.sql.DataSource;
    public class AccountCreatorBean implements AccountCreator{
    DataSource datasource;
    Connection connection;
    PersonalInfo personalinfo=new PersonalInfo();
    BillingInfo billinginfo=new BillingInfo();
    	public AccountCreatorBean() {
    public void openConnection()
    	catch(Exception e)
    public void closeConnection()
    public void addPersonalInfo(PersonalInfo personalinfo)
    public void addBillingInfo(BillingInfo billinginfo)
    public void createAccount()
    	System.out.println("Your request has been successfully processed");

    Once you have added the code you will see lot of errors but this can be resolved easily and is shown in next step.

  16. The errors in the code is due to missing classes from our server runtime. This can be resolved as follows.
    Right click on StatefulBean project and select Properties.

  17. On the next screen select Java Build Path->Libraries->Add External Jars.

  18. Browse to <GERONIMO_HOME>/repository/org/apache/geronimo/specs/geronimo-ejb_3.0_spec/1.0.1 and select geronimo-ejb_3.0_spec-1.0.1.jar. Select Open.

  19. Similarly browse to <GERONIMO_HOME>/repository/org/apache/geronimo/specs/geronimo-annotation_1.0_spec/1.1.1 and add geronimo-annotation_1.0_spec-1.1.1.jar.

  20. Once done you can see both the jars enlisted. Select Ok.

  21. Let us walkthrough the EJB bean class code
    • @Stateful public class AccountCreatorBean implements AccountCreator- @ Stateful annotation declares the Bean class as Stateful class.
    • @Resource(name="jdbc/userds") DataSource datasource;- This is a resource injection into the bean class wherin a datasource is injected using the @Resource annotation. We will shortly see how to create a datasource in geronimo.
    • public AccountCreatorBean(} -This is a constructor for the bean class and it will be used to create a bean instance whenever a request is received from new client connection.
    • @PostConstruct @PostActivate public void openConnection()- @PostConstruct and @PostActivate are annotations which are basically called lifecycle callback annotation. The lifecycle for these annotation is as follows
      • New bean instance is created using the default constructor.
      • Resources are injected
      • Now the PostConstruct method is called which in our case is to open a database connection.
      • PostActivate is called on the bean instances which have been passivated and required to be reactivated. It goes on the same cycle as being followed by PostConstruct.
    • @PreDestroy @PrePassivate public void closeConnection()- Again @PreDestroy and @PrePassivate are Lifecycle callback annotation. The lifecycle of these annotation is as follows
      • Bean instances in the pool are used and business methods are invoked.
      • Once the client is idle for a period of time container passivates the bean instance. The closeConnection function is called just before container passivates the bean.
      • If the client does not invoke a passivated bean for a period of time it is destroyed.
    • public void addPersonalInfo(PersonalInfo personalinfo) and public void addBillingInfo(BillingInfo billinginfo)- These two functions are invoked to store client data across various calls.
    • @Remove public void createAccount()- There are two ways in which a bean is destroyed and hence this where a client session ends in stateful bean. One is when a bean has been passivated and is not reinvoked by client hence the bean instance is destroyed. Another way is to use @Remove annotation. Once the client confirms and submits all the required information the data is populated into the database and that is where the session ends.

Creating a database using Administrative Console

  1. Start the server and Launch the Administrative Console using the URL http://localhost:8080/console.
  2. Enter default username and password.
  3. In the welcome page, Under Embedded DB, Select DB Manager.

  4. On the next page create a database userdbs and Select create.

  5. Once done you can see the userdbs database listed in DB Viewer portlet under Databases. This confirms that the database has been successfully created.

  6. As shown in the figure under Use DB, select userdbs from the dropdown box.

  7. Run the userinfo.sql script. Select Run Sql.

    create table userinfo(firstname varchar(20),lastname varchar(20), username varchar(20), password varchar(20), pincode varchar(20), cardno varchar(20))
  8. To verify the table creation succeeded. Select Application as shown in the figure.

  9. Next screen suggests the table has been successfully created. To view the contents of the table select VIEW CONTENTS.

  10. The table is currently empty as shown in the figure.

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences