Home > Articles > Programming > Java

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

10.8 Example: A Listener That Counts Sessions

Session tracking can significantly increase the server's memory load. For example, if a site that uses session tracking has 1,000 unique visitors per hour and the server uses a two-hour session timeout, the system will have approximately 2,000 sessions in memory at any one time. Reducing the timeout to one hour would cut the session memory requirements in half but would risk having active sessions prematurely time out. You need to track typical usage before you can decide on the appropriate solution.

So, you need a listener that will keep track of how many sessions are created, how many are destroyed, and how many are in memory at any one time. Assuming that you have no explicit calls to invalidate, the session destructions correspond to expired timeouts.

The following steps summarize a listener that accomplishes this task.

  1. Implement the HttpSessionListenerinterface. Listing 10.20 shows a class (SessionCounter) that implements this interface.

  2. Override sessionCreatedand sessionDestroyed. The first of these (sessionCreated) increments two counters: totalSession-Countand currentSessionCount. If the current count is greater than the previous maximum count, the method also increments the maxSessionCountvariable. The second method (session-Destroyed) decrements the currentSessionCountvariable.

  3. Obtain and use the servlet context. In this application, no specific use is made of the session object. The only thing that matters is the fact that a session was created or destroyed, not any details about the session itself. But, the session counts have to be placed in a location that is easily accessible to servlets and JSP pages that will display the counts. So, the first time sessionCreatedis called, it obtains the session object, calls getServletContexton it, and then calls set-Attributeto store the listener object in the servlet context.

  4. Declare the listener. Listing 10.21 shows the web.xml file. It declares the listener with the listenerand listener-classele-ments, as below.

    <listener>
      <listener-class>
       moreservlets.listeners.SessionCounter
      </listener-class>
    </listener>

Listing 10.22 shows a JSP page that displays the session counts. Figures 10–11 shows a typical result.

Figures 10–11 The SessionCounter listener keeps track of the sessions used in the Web application.

In order to test session creation and timeout, I made three temporary changes. First, I disabled cookies in my browser. Since my servers are set to use cookies for session tracking, this had the result of making each request be a new session. See the following subsection for information on disabling cookies in Netscape and Internet Explorer.

Second, I created an HTML page (Listing 10.23, Figures 10–12) that used frames with four rows and four columns to request the same JSP page (Listing 10.24) 16 times. In an environment that has cookies disabled, a request for the framed page results in 16 new sessions being created on the server (recall that JSP pages perform session tracking automatically unless the session attribute of the page directive is set to false—see Section 3.4).

Figures 10–12 Session management was tested with a frame-based page that was invoked after cookies were disabled. So, each request resulted in 16 different sessions.

Third, I chose an extremely low session timeout: two minutes. This saved me from waiting for hours to test the session-counting listener. Changing the default session timeout is discussed in Section 5.10, but it simply amounts to creating a session-config entry in web.xml, as follows.

<session-config>
  <session-timeout>2</session-timeout>
</session-config>

Listing 10.20 SessionCounter.java

package moreservlets.listeners;

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

/** Listener that keeps track of the number of sessions
 * that the Web application is currently using and has
 * ever used in its life cycle.
 */

public class SessionCounter implements HttpSessionListener {
  private int totalSessionCount = 0;
  private int currentSessionCount = 0;
  private int maxSessionCount = 0;
  private ServletContext context = null;

  public void sessionCreated(HttpSessionEvent event) {
   totalSessionCount++;
   currentSessionCount++;
   if (currentSessionCount > maxSessionCount) {
     maxSessionCount = currentSessionCount;
   }
   if (context == null) {
    storeInServletContext(event);
   }
}

public void sessionDestroyed(HttpSessionEvent event) {
  currentSessionCount--;
}

/** The total number of sessions created. */

public int getTotalSessionCount() {
  return(totalSessionCount);
}

/** The number of sessions currently in memory. */

public int getCurrentSessionCount() {
  return(currentSessionCount);
}
   /** The largest number of sessions ever in memory
    * at any one time.
    */

   public int getMaxSessionCount() {
    return(maxSessionCount);
  }

  // Register self in the servlet context so that
  // servlets and JSP pages can access the session counts.

  private void storeInServletContext(HttpSessionEvent event) {
    HttpSession session = event.getSession();
    context = session.getServletContext();
    context.setAttribute("sessionCounter", this);
  }
}

Listing 10.21 web.xml (Excerpt for session counting listener)

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app PUBLIC
    "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
    "http://java.sun.com/dtd/web-app_2_3.dtd">

  <web-app>
     <!-- ... -->

     <!-- Register the session counting event listener. -->
     <listener>
       <listener-class>
        moreservlets.listeners.SessionCounter
       </listener-class>
     </listener>
     <!-- ... -->

     <!-- Set the default session timeout to two minutes. -->
     <session-config>
         <session-timeout>2</session-timeout>
     </session-config>
     <!-- ... -->
</web-app>

Listing 10.22 session-counts.jsp

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Session Info</TITLE>
<LINK REL=STYLESHEET
     HREF="events-styles.css"
     TYPE="text/css">
</HEAD>

<BODY>
<TABLE BORDER=5 ALIGN="CENTER">
  <TR><TH CLASS="TITLE">Session Info</TABLE>
<P>

<jsp:useBean class="moreservlets.listeners.SessionCounter"
          id="sessionCounter" scope="application" />
<UL>
<LI>Total number of sessions in the life of this
   Web application:
   <jsp:getProperty name="sessionCounter"
               property="totalSessionCount" />.
<LI>Number of sessions currently in memory:
  <jsp:getProperty name="sessionCounter"
              property="currentSessionCount" />.
<LI>Maximum number of sessions that have ever been in
    memory at any one time:
   <jsp:getProperty name="sessionCounter"
               property="maxSessionCount" />.
</UL>

</BODY>
</HTML>

Listing 10.23 make-sessions.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN">
<HTML>
<HEAD>
  <TITLE>Session Testing...</TITLE>
</HEAD>
<FRAMESET ROWS="*,*,*,*" COLS="*,*,*,*">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <FRAME SRC="test.jsp">
  <NOFRAMES><BODY>
     This example requires a frame-capable browser.
  </BODY></NOFRAMES>
</FRAMESET>
</HTML>

Listing 10.24 test.jsp

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- The purpose of this page is to force the system
   to create a session. -->
<HTML>
<HEAD><TITLE>Test</TITLE></HEAD>

<%@ page import="moreservlets.*" %>
<BODY BGCOLOR="<%= ColorUtils.randomColor() %>">

</BODY></HTML>

Listing 10.25 ColorUtils.java

package moreservlets;
/** Small utility to generate random HTML color names. */

public class ColorUtils {
  // The official HTML color names.
  private static String[] htmlColorNames =
    { "AQUA", "BLACK", "BLUE", "FUCHSIA", "GRAY", "GREEN",
     "LIME", "MAROON", "NAVY", "OLIVE", "PURPLE", "RED",
     "SILVER", "TEAL", "WHITE", "YELLOW" };

   public static String randomColor() {
     int index = randomInt(htmlColorNames.length);
     return(htmlColorNames[index]);
  }
  // Returns a random number from 0 to n-1 inclusive.

  private static int randomInt(int n) {
    return((int)(Math.random() * n));
  }
}

Disabling Cookies

Figures 10–13 through 10–15 summarize the approach to disabling cookies in Netscape 4, Netscape 6, and Internet Explorer 5. As discussed in the previous subsection, temporarily disabling cookies is useful for testing session usage.

Figures 10–13 To disable cookies in Netscape 4, choose the Edit menu, then Preferences, then Advanced. Select "Disable cookies." Reset the browser after you are done testing; my preferred setting is "Accept only cookies that get sent back to the originating server."

Figures 10–14 To disable cookies in Netscape 6, choose the Edit menu, then Preferences, then Privacy and Security, then Cookies. Select "Disable cookies." Reset the browser after you are done testing; my preferred setting is "Enable cookies for the originating web site only."

Figures 10–15 To disable cookies in Internet Explorer 5, choose the Tools menu, then Internet Options, then Security, then Custom Level. Since the goal here is to generate multiple sessions, you only need to disable per-session cookies. When done testing, reset the browser by changing the setting back to Enable.

  • + 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