Home > Articles > Programming > Java

Java Servlet Sessions

Session Tracking with the Servlet API

The Servlet API has its own built-in support for session tracking. The HttpSession object provides this functionality. In this section, I focus on four of the HttpSession's session tracking methods.

The first method is the setAttribute() method. The setAttribute() method binds a name/value pair to store in the current session. If the name already exists in the session, it is replaced. The method signature for setAttribute() is listed as follows:

public void setAttribute(String name, Object value)

The next method is the getAttribute() method, which is used to get an object that is stored in the session. The getAttribute() method takes a string representing the name that the desired object is bound to. Its signature is listed as follows:

public Object getAttribute(String name)

The third session method returns an array of the current bound names stored in the session. This method is convenient if you want to remove all the current bindings in a session. Its signature is listed as follows:

public String[ ] getAttributeNames()

The last session method is the removeAttribute() method. As its name suggests, it removes a binding from the current session. It takes a string parameter representing the name associated with the binding. Its method signature is listed as follows:

public void removeAttribute(String name)

Now that I have discussed the HttpSession object, let's take a look at an example of how to use it. In this example, you will service a request that contains a list of movies to add to a user's account. You will then parse the submitted list, add it to the customer's session, and redisplay it for approval. When the customer approves the list, they will click the Proceed to Checkout button to commit the transaction. Listing 5.4 contains the source for this example.

Listing 5.4 HttpSessionServlet.java

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.*;
import java.util.*;

public class HttpSessionServlet extends HttpServlet {

 public void init(ServletConfig config)
  throws ServletException {

  super.init(config);
 }

 //Process the HTTP Get request, this method
 // will handle the checkout
 public void doGet(HttpServletRequest request,
  HttpServletResponse response)
  throws ServletException, IOException {

  String[ ] movies = null;

  // Get a handle to the HttpSession Object
  // if there is no session create one
  HttpSession session = request.getSession(true);

  // Get the movies list object bound to the
  // name "Movies"
  if ( session != null ) {

   movies = (String[ ])session.getAttribute("Movies");
  }

  response.setContentType("text/html");
  PrintWriter out = response.getWriter();
  out.println("<html>");
  out.println("<head><title>Session Servlet</title></head>");
  out.println("<body>");

  // Iterate over the movies array, displaying the
  // current list of movies stored in the session
  out.println("<H2>Thank you for purchasing:</H2>");
  for ( int x = 0; x < movies.length; x++ ) {

   out.println(movies[x] + "<BR>");
  }
  out.println("</body></html>");
  out.close();
 }

 //Process the HTTP Post request
 public void doPost(HttpServletRequest request,
  HttpServletResponse response)
  throws ServletException, IOException {

  // Parse the movies selected
  String movies[ ] = request.getParameterValues("Movies");

  // Get a handle to the HttpSession Object
  // if there is no session create one
  HttpSession session = request.getSession(true);

  // add the list of movies to the session
  // binding it to the String "Movies"
  if ( session != null ) {

   session.setAttribute("Movies", movies);
  }

  response.setContentType("text/html");
  PrintWriter out = response.getWriter();
  out.println("<html>");
  out.println("<head><title>Session Servlet</title></head>");
  out.println("<body>");

  out.println("<H2>Contents of Shopping Cart</H2>");

  // Display the submitted movie array
  for ( int x = 0; x < movies.length; x++ ) {

   out.println(movies[x] + "<BR>");
  }
  // Create a form to submit an order
  out.println("<FORM action=/djs/servlet/HttpSessionServlet " +
   "METHOD=GET>");
  out.println("<input type=\"Submit\" name=\"add\" value=" +
   "\"Proceed to Checkout\"></FORM>");

  out.println("</body></html>");
  out.close();
 }

 //Get Servlet information
 public String getServletInfo() {

  return "HttpSessionServlet Information";
 }
}

To invoke this servlet, you need to create an HTML file that will make a POST request containing a list of selected movies. The HTML file that contains this form is in Listing 5.5.

Listing 5.5 HtmlSessionServlet.html

<HTML>
<HEAD>
<TITLE>
Movie List
</TITLE>
</HEAD>

<BODY>
<H2>Select From Available Movies</h2>

<FORM ACTION=http://localhost/djs/servlet/HttpSessionServlet method=POST>

 <SELECT NAME="Movies" SIZE="5" MULTIPLE>
  <OPTION SELECTED>Air Force One</OPTION>
  <OPTION>Happy Gilmore</OPTION>
  <OPTION>So I Married an Axe Murderer</OPTION>
  <OPTION>Austin Powers</OPTION>
  <OPTION>Pure Luck</OPTION>
 </SELECT><BR>
 <INPUT TYPE="Submit" NAME="add" VALUE="Add Movies">

</FORM>

</BODY>
</HTML>

To see how this example works, load this HTML page in a browser. You should see a screen similar to Figure 5.2.

Figure 5.2 The Movie Selection List screen.

When this page is loaded, select a couple of the movies in the list and click the Add Movies button. You should now see a screen containing the list of movies you selected. Figure 5.3 displays an example of this output.

Figure 5.3 The Contents of Shopping Cart screen.

To understand how this first part works, you need to examine the doPost() method. This is the method that services the POST request sent by your HTML document.

The first thing the doPost() method does is get the list of submitted movies from the request. It then tries to get a reference to the HttpSession object stored in the HttpServletRequest. This is done by calling the HttpServletRequest.getSession() method. The code snippet that performs this is listed in the following:

// Get a handle to the HttpSession Object
// if there is no session create one
HttpSession session = request.getSession(true);

The getSession() method takes one parameter. This parameter is a Boolean value that, if true, tells the method to create an HttpSession if one doesn't exist.

When you have a reference to the HttpSession object, you can add your movie list to it. You do this by calling the HttpSession.setAttribute() method, passing it the name "Movies" and the object to be bound to it: movies. The movie list is now stored in the client's session. The last thing you do in the doPost() method is redisplay the list of selected movies and ask the user to click Proceed to Checkout.

NOTE

Sessions do expire. Therefore, you will need to consult your server's documentation to determine the length of time a session is valid.

Now you are going to look at the really cool part. Click the Proceed to Checkout button You shou.ld see a screen similar to Figure 5.4, which tells you "Thank you for purchasing:" and displays the movies you selected.

Figure 5.4 The thank you screen.

The request performed by this form simply calls the same servlet using the GET method. If you look at the URL your browser now points to, you will notice there is no movie data encoded in the URL string.

Look at the doGet() method to see exactly how this is done. The first thing you do is get a reference to the HttpSession object, which is done exactly as before with the getSession() method. When you have a reference to the session, you can get the list of movies stored in the session. You do this by calling the HttpSession.getAttribute() method, passing it the name bound to the movies object. The following code snippet shows how this is done:

// Get the movies list object bound to the
// name "Movies"
if ( session != null ) {

movies = (String[ ])session.getAttribute("Movies");
}

NOTE

Make sure that you downcast your stored object back to its original type. While in the HttpSession, it is stored as an object.

When you have the list of movies, thank the customer for the purchase and redisplay the list of ordered movies. That is all there is to it. As you have seen, the Servlet API provides you with a very elegant and simple-to-use method of maintaining persistent sessions.

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