Home > Articles > Programming > Java

  • Print
  • + Share This
This chapter is from the book

5.2 MusicCart Stateful Session Bean

The MusicCart EJB is a stateful session bean that allows clients to create a shopping cart and add and remove recordings (read from the Music Collection database). Before we show you the code, we'll describe a general, architectural view of the major components of our example enterprise application.

The Big Picture

Figure 5-1 presents an architectural overview of our design using J2EE components. A client becomes the "customer" which we encapsulate in the value object CustomerVO(not shown). The stateful session bean MusicCart (denoted SFSB) manipulates RecordingVO objects (see Listing 4.4 on page 96) which originate from the database store we presented in the previous chapter. To keep database access vendor independent, we use the MusicDAO implementation from Chapter 4 (see "DAO Pattern Implementation" on page 121). A new, stateful MusicIterator session bean (denoted SFSB) implements the Value List Iterator Pattern. The Value List Iterator Pattern allows a client to request data in small, manageable chunks instead of all at once. In addition, the stateful MusicIterator EJB accesses the stateless session bean MusicPage (denoted SLSB) to read the data. Finally, the user interacts with all these components through a JSP web component that manages the user input and presentation aspects of the application.

Figure 5-1 Architectural Overview of the Music Shopping Cart Enterprise Application

Figure 5-2 is a sequence diagram that shows the interactions between the client and the MusicCart EJB. The diagram shows the creation of the MusicCart EJB, which in turn creates a CustomerVO and shopping ArrayList object. It also depicts the MusicCart EJB's business methods.

Figure 5-2 Sequence Diagram Showing Interactions Between a Client and a MusicCart EJB

As we present each component, we'll discuss the design issues that motivate our choice of stateful versus stateless session bean implementation.

CustomerVO

Listing 5.1 shows the class definition for value object CustomerVO, which holds a String name (name), a String password (password), and a String e-mail address (email). Its constructor takes three String arguments, and the class provides the typical getter and setter methods of a value object.

Note that CustomerVO implements the java.io.Serializable interface. There are two reasons for this. One, CustomerVOmust be serializable because we use it in remote EJB calls as an argument. Two, the MusicCart EJB will use a CustomerVOinstance variable to hold state information for a specific customer. This field must be serializable for possible activation and passivation in the MusicCart EJB stateful session bean. Remember that fields declared as instance variables in stateful session beans must either be serializable or specifically passivated and activated.

Listing 5.1 CustomerVO.java

// CustomerVO.java
public class CustomerVO implements java.io.Serializable
{
  private String name;
  private String password;
  private String email;

  public CustomerVO(String name, String password,
     String email) {
   setName(name);
   setPassword(password);
   setEmail(email);
  }

  // getters
  public String getPassword() { return password; }
  public String getName() { return name; }
  public String getEmail() { return email; }

  // setters
  public void setPassword(String password) {
     this.password = password; }
  public void setName(String name) { this.name = name; }
  public void setEmail(String email) {
     this.email = email; }
}

Home Interface

A stateful session bean has the following: a home interface containing one or more create()methods, a remote interface with business methods, and a bean implementation class with the code for the methods in both interfaces. Let's look at the home interface of our MusicCart EJB first.

Because the MusicCart EJB is stateful, there may be multiple ways to create the bean and initialize its state. In Listing 5.2, you will find two create() methods in the home interface of the MusicCart EJB. The first one accepts only a customer name, whereas the second one creates the bean from a CustomerVO object. Note that both create()methods return an object of the bean's remote interface type (MusicCart). And, as we've seen in previous examples, each create() method must specify RemoteExceptionand CreateExceptionin its throws clause. The home interface always extends EJBHome.

Listing 5.2 MusicCartHome.java

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

public interface MusicCartHome extends EJBHome {

  MusicCart create(String person) throws RemoteException,
    CreateException;
  MusicCart create(CustomerVO customer) throws
    RemoteException, CreateException;
}

Remote Interface

The MusicCart EJB remote interface in Listing 5.3 contains the bean's business methods. We have methods for adding and removing recordings to the shopping cart, obtaining the current shopping list, and querying customer information.

Listing 5.3 MusicCart.java

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

public interface MusicCart extends EJBObject {

  public void addRecording(RecordingVO album)
     throws RemoteException;
  public void removeRecording(RecordingVO album)
     throws ShoppingException, RemoteException;

  public void clearShoppingList() throws RemoteException;
  public ArrayList getShoppingList()
     throws RemoteException;
  public CustomerVO getCustomer() throws RemoteException;
}

The addRecording() and removeRecording() methods both accept RecordingVOvalue objects as arguments. Method getShoppingList()returns an ArrayList collection of recordings and method clearShoppingList() removes all objects from the shopping list. The removeRecording() method also specifies ShoppingExceptionin its throwsclause. This application exception indicates that the client requested removal of a recording that was not in the shopping cart.

Note that addRecording(), clearShoppingList(), and removeRecording() update the MusicCart's state, whereas getShoppingList() and get-Customer() are getter methods that return portions of the bean's state.

Bean Implementation

The bean implementation class for the MusicCart EJB is shown in Listing 5.4. Because this session bean is stateful, it must have instance variables that maintain state information. For our MusicCart EJB, this state consists of a Custom-erVOvalue object (customer) and an ArrayListof recordings in the shopping cart (shoppingList). Because both of these variables are serializable, we do not need to write implementation code for methods ejbPassivate()and ejbAc-tivate(). The bean class also contains the implementations of the home and remote interface methods.

Each create()method in the home interface has a corresponding ejbCre-ate() method in the bean implementation class with matching arguments. Note that create() always returns a remote interface type but ejbCreate() has void for the return type.

The job of ejbCreate() is to make sure that the EJB container instantiates the MusicCart EJB object correctly. Both ejbCreate()methods check for valid initialization parameters before they initialize the shoppingListand customer instance variables. If either ejbCreate() method finds inconsistencies in the input parameters, it throws a CreateException.

The ArrayList collection is serializable and stores recordings in the shopping cart. Its methods add(), contains(), clear(), and remove()manipulate the collection of recordings.

Implementation Factoid

ArrayList method contains() returns true if the collection contains the specified object. ArrayList uses the Java Object's equals() method to determine equality. This is why we implement method equals() in class RecordingVO.java (see Listing 4.4 on page 96).

Note that removeRecording()checks to see if the recording to be removed is actually in the collection. If it isn't, the method throws a ShoppingException. A client of the MusicCart EJB should check for this exception separately from a more drastic system exception.

Listing 5.4 MusicCartBean.java

// MusicCartBean.java
import javax.ejb.*;
import javax.naming.*;
import java.rmi.RemoteException;
import java.util.*;

public class MusicCartBean implements SessionBean {

  // EJB instance variables
  CustomerVO customer;
  ArrayList shoppingList;

  // create() methods implementation
  // from the EJBHome interface
  // Methods ejbCreate() should initialize the
  // instance variables

  public void ejbCreate(String person)
      throws CreateException {
   if (person == null || person.equals("")) {
     throw new CreateException(
       "Name cannot be null or empty.");
   }
   else {
     customer = new
       CustomerVO(person, "NoPassword", "NoEmail");
   }
   shoppingList = new ArrayList();
  }

  // Implementation for create(CustomerVO cust)
  public void ejbCreate(CustomerVO cust)
      throws CreateException {
   if (cust.getName() == null) {
    throw new CreateException("Name cannot be null.");
   }
   if (cust.getPassword() == null ||
       cust.getPassword().equals("")) {
     throw new CreateException(
       "Password cannot be null or empty.");
   }

   if (cust.getEmail() == null ||
       cust.getEmail().equals("")) {
     throw new CreateException(
       "Email cannot be null or empty.");
   }
   customer = cust;
   shoppingList = new ArrayList();
  }

  // Business methods implementation

  public CustomerVO getCustomer() {
   return customer;
  }

  public void addRecording(RecordingVO album) {
   shoppingList.add(album);
  }

  // ShoppingException is an application exception
  public void removeRecording(RecordingVO album)
   throws ShoppingException
  {
   if (shoppingList.contains(album)) {
   shoppingList.remove(shoppingList.indexOf(album));
   }
   else {
     throw new ShoppingException(
        album.getTitle() + " not in cart.");
   }
  }

  // clear the shopping list
  public void clearShoppingList() {
   shoppingList.clear();
  }

  public ArrayList getShoppingList() {
   return shoppingList;
  }

  // EJB Methods
  public MusicCartBean() {}
  public void ejbRemove() {}
  public void ejbActivate() {}
  public void ejbPassivate() {}
  public void setSessionContext(SessionContext sc) {}

} // MusicCartBean

Deployment Descriptor

Listing 5.5 shows the deployment descriptor for the MusicCart EJB. Here, we indicate that it is a stateful session bean, its home interface is MusicCartHome, its remote interface is MusicCart, and its bean implementation class is Music-CartBean. We show tag values in bold.

Listing 5.5 MusicCart EJB Deployment Descriptor

<ejb-jar>
  <display-name>MusicCartJAR</display-name>
<enterprise-beans>
   <session>

     <display-name>MusicCartBean</display-name>
     <ejb-name>MusicCartBean</ejb-name>
     <home>MusicCartHome</home>
     <remote>MusicCart</remote>
     <ejb-class>MusicCartBean</ejb-class>
     <session-type>Stateful</session-type>
     <transaction-type>Bean</transaction-type>
     <security-identity>
      <description></description>
      <use-caller-identity></use-caller-identity>
     </security-identity>
   </session>
  </enterprise-beans>
</ejb-jar>

Before we examine the other EJBs in our MusicCart design, let's learn about the Value List Iterator Pattern. This important pattern helps you understand the advantages of both stateless and stateful session bean properties.

  • + Share This
  • 🔖 Save To Your Account

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