Home > Articles > Programming > Java

The Benefits of Stateful Session Beans

In this sample chapter, Paul and Gail Anderson look closely at stateful session beans and show you their benefits and costs over stateless session beans. They also discuss how the EJB container manages stateful session beans in a J2EE environment.
This sample chapter is excerpted from Enterprise JavaBeans Component Architecture: Designing and Coding Enterprise Applications, by Paul and Gail Anderson.
This chapter is from the book

Topics in This Chapter

  • Introducing Stateful Session Beans
  • Implications of Stateful vs. Stateless EJBs
  • Leveraging your EJB Components
  • Extending Multiple Interfaces
  • Value List Iterator Pattern
  • Example with a JSP Client
  • Local Interfaces

In the previous two chapters, we explored the design of stateless session beans. The most important characteristic of a stateless session bean is that it does not retain client-specific data. Thus, multiple clients can share stateless session beans, providing performance benefits. Stateless session beans also provide important business processes, but the results are transient, even during a session. Although a method of a stateless session bean could keep track of client-specific data, the bean does not retain the data when the method returns. Hence, the EJB container is free to assign the same instance of a stateless session bean to another client. All instances of a stateless session bean are therefore identical.

In contrast, stateful session beans do keep track of client-specific data. Multiple clients cannot share stateful session beans because the EJB container assigns a specific instance to each client. Stateful session beans have the advantage of being tightly coupled with clients, but there is more overhead involved. It's important, therefore, to understand how to properly design applications with stateful session beans so that performance does not suffer.

In this chapter, we'll look closely at stateful session beans and show you their benefits and costs over stateless session beans. We'll also discuss how the EJB container manages stateful session beans in a J2EE environment.

5.1 Introducing Stateful Session Beans

A stateful session bean keeps track of client-specific data over the course of a session. The client-related data is stored in instance variables of the stateful session bean. The lifetime of the bean corresponds to one client's session and its state reflects the work performed throughout the session. The session bean keeps track of the conversational state between the client and the bean. Throughout its lifetime, the EJB container assigns an instance of a stateful session bean to a single client. The state of any given instance is dependent on how the client creates the bean and the invocation of its business methods. When the session terminates, the bean's state is released and the bean's instance no longer exists.

Stateful Session Passivation and Activation

In a J2EE environment, a running application uses many system resources. The EJB container, which controls the life cycle and activation state of its enterprise beans, may need to reacquire resources used by a stateful session bean. These resources include system memory, socket connections, and database connections. When resources must be reclaimed, the container serializes a bean's state and copies it to secondary storage. This process is called passivation. When it's time to restore a bean to its active state, the container reads the bean's state from secondary storage and de-serializes the objects. This process is called activation. In general, the EJB container performs this work quietly and transparently.

It's not always possible for the EJB container to serialize all state information in a session bean. If an instance variable, for example, does not implement the Serializableinterface, the container cannot save and restore the data. In this case (and in other scenarios which might require special attention), the bean developer provides code to reinitialize the bean properly.

The session bean interface provides the ejbPassivate() and ejbActi-vate()methods, which allow bean developers to control the passivation and activation tasks for a session bean. The container invokes ejbPassivate()just before it passivates the instance and ejbActivate() just after it activates the instance. The bean developer places the code for these methods in the session bean implementation class.

Let's look at an example. Suppose a stateful session bean contains an instance variable (ds) which is a reference to a DataSourceobject. To properly passivate this instance, we must assign null to the ds reference in ejbPassi-vate(), since a reference to an object cannot be serialized. To activate the instance, we provide the code to reinitialize the dsreference in ejbActivate(). The following code snippets show how to do this.

// example ejbPassivate() inside bean implementation class
public void ejbPassivate() {
  // DataSource ds is an instance variable
  ds = null;
}

// example ejbActivate() inside bean implementation class
public void ejbActivate() {
  String dbName = "java:comp/env/jdbc/MusicDB";
  try {
   InitialContext ic = new InitialContext();
   // DataSource ds is an instance variable
   ds = (DataSource) ic.lookup(dbName);
  } catch (Exception ex) {
   throw new EJBException("Cannot find DataSource: " +
     ex.getMessage());
  }
}

Design Guideline

In general, you should design an ejbPassivate() method to "undo" (or release) any actions (or resources) performed (or acquired) by the ejbActivate() method. For example, close a database connection in ejbPassivate() if you acquire it in ejbActivate().

The astute reader will recognize part of this code from our Music EJB session bean in Chapter 4, specifically the ejbCreate() method found in the Music-Bean implementation class (see its source on page 100). Why didn't we need ejbPassivate()and ejbActivate()methods for the Music EJB session bean? Recall that Music EJB is a stateless session bean. The EJB container never needs to passivate it. Once a client returns from a method invocation, the container may assign the instance to another client. This sharing means that expensive resources are more easily distributed among various clients. Furthermore, if the container needs to recover resources, it simply destroys the instance. There is no "conversational state" to save. Thus, there is no need to save and restore state through passivation and activation.

Design Guideline

When you're choosing between a stateful or stateless session bean to implement a business process, it helps to understand how the EJB container manages different session beans. A knowledge of each bean's life cycle is one way to gauge the performance impact to your enterprise application.

How does the EJB container decide which stateful bean to passivate? Usually, a container uses heuristics based on how recently a client has accessed a bean (typically the container will passivate the bean that has been called the least recently). Furthermore, if the bean is in the middle of a method call or involved in a transaction, the container cannot passivate it. (A transaction defines the boundaries of uninterruptible database operations. We discuss transactions in Chapter 6.) This chapter will demonstrate two stateful session beans by building on previous designs from earlier chapters. Our first example, a MusicCart EJB, implements the (now traditional) online shopping paradigm. A client creates a shopping cart of music recordings, adds or removes recordings from the cart, and displays the cart's contents.

Our second stateful session bean implements the Value List Iterator Pattern. This pattern is extremely useful for managing large lists of data. We'll modify our stateless session Music EJB slightly and reuse the MusicDAO from the previous chapter to access the Music Collection database. You will see that our implementation takes advantage of the performance differences between stateful and stateless session beans, leveraging the different benefits of each one to fit our application.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020