Home > Articles > Programming > Java

Servlet and JSP Application Events Framework

  • Print
  • + Share This
In this sample chapter, Marty Hall discusses the general event-handling strategy. He covers: monitoring servlet context initialization and shutdown, setting application-wide values, detecting changes in attributes of the servlet context, recognizing creation and destruction of HTTP sessions, analyzing overall session usage, watching for changes in session attributes, tracking purchases at an e-commerce site, using multiple cooperating listeners, and packaging listeners in JSP tag libraries.
This sample chapter is excerpted from More Servlets and JavaServer Pages (JSP), by Marty Hall.
This chapter is from the book

Developers have many tools at their disposal for handling the life cycle of individual servlets or JSP pages. The servlet init method (Section 2.3) fires when a servlet is first instantiated. JSP pages use the nearly identical jspInit method (Section 3.3). Both methods can use initialization parameters that are specified with the init-param subelement of the web.xml servlet element (Section 5.5). Requests are handled with service and _jspService, and destruction is handled with destroy and jspDestroy.

This is all fine for individual resources. But what if you want to respond to major events in the life cycle of the Web application itself? What if you want to create application-wide connection pools, locate resources, or set up shared network connections? For example, suppose you want to record the email address of the support group at your company, an address that will be used by many different servlets and JSP pages. Sure, you can use the following to store the information:

context.setAttribute("supportAddress", "balmer@microsoft.com"); 

Better yet, you could use the web.xml context-param element (Section 5.5) to designate the address, then read it with the getInitParameter method of ServletContext. Fine. But which servlet or JSP page should perform this task? Or you could read the address from a database. Fine. But which servlet or JSP page should establish the database connection? There is no good answer to this question; you don't know which resources will be accessed first, so the code that performs these tasks would have to be repeated many different places. You want more global control than any one servlet or JSP page can provide. That's where application life-cycle event listeners come in.

There are four kinds of event listeners that respond to Web application life-cycle events.

  • Servlet context listeners. These listeners are notified when the servlet context (i.e., the Web application) is initialized and destroyed.

  • Servlet context attribute listeners. These listeners are notified when attributes are added to, removed from, or replaced in the servlet context.

  • Session listeners. These listeners are notified when session objects are created, invalidated, or timed out.

  • Session attribute listeners. These listeners are notified when attributes are added to, removed from, or replaced in any session.

Using these listeners involves six basic steps. I'll give a general outline here, then provide listener-specific details in the following sections.

  1. Implement the appropriate interface. Use ServletContext-Listener, ServletContextAttributeListener, Http-SessionListener, or HttpSessionAttributeListener. The first two interfaces are in the javax.servletpackage; the second two are in javax.servlet.http.

  2. Override the methods needed to respond to the events of interest. Provide empty bodies for the other methods in the interface. For example, the ServletContextListenerinterface defines two methods: contextInitialized(the Web application was just loaded and the servlet context was initialized) and contextDestroyed(the Web application is being shut down and the servlet context is about to be destroyed). If you wanted to define an application-wide servlet context entry, you could provide a real implementation for contextInitializedand an empty body for contextDestroyed.

  3. Obtain access to the important Web application objects. There are six important objects that you are likely to use in your event-handling methods: the servlet context, the name of the servlet context attribute that changed, the value of the servlet context attribute that changed, the session object, the name of the session attribute that changed, and the value of the session attribute that changed.

  4. Use these objects. This process is application specific, but there are some common themes. For example, with the servlet context, you are most likely to read initialization parameters (getInitParameter), store data for later access (setAttribute), and read previously stored data (getAttribute).

  5. Declare the listener. You do this with the listenerand listener-classelements of the general Web application deployment descriptor (web.xml) or of a tag library descriptor file.

  6. Provide any needed initialization parameters. Servlet context listeners commonly read context initialization parameters to use as the basis of data that is made available to all servlets and JSP pages. You use the context-paramweb.xml element to provide the names and values of these initialization parameters.

If servlet and JSP filters are the most important new feature in version 2.3 of the servlet specification, then application life-cycle events are the second most important new capability. Remember, however, that these event listeners work only in servers that are compliant with version 2.3 of the servlet specification. If your Web application needs to support older servers, you cannot use life-cycle listeners.

Core Warning

Application life-cycle listeners fail in servers that are compliant only with version 2.2 or earlier versions of the servlet specification.

10.1 Monitoring Creation and Destruction of the Servlet Context

The ServletContextListener class responds to the initialization and destruction of the servlet context. These events correspond to the creation and shutdown of the Web application itself. The ServletContextListener is most commonly used to set up application-wide resources like database connection pools and to read the initial values of application-wide data that will be used by multiple servlets and JSP pages. Using the listener involves the following six steps.

  1. Implement the ServletContextListenerinterface. This interface is in the javax.servletpackage.

  2. Override contextInitialized and contextDestroyed. The first of these (contextInitialized) is triggered when the Web application is first loaded and the servlet context is created. The two most common tasks performed by this method are creating application-wide data (often by reading context initialization parameters) and storing that data in an easily accessible location (often in attributes of the servlet context). The second method (contextDestroyed) is triggered when the Web application is being shut down and the servlet context is about to be destroyed. The most common task performed by this method is the releasing of resources. For example, context-Destroyed can be used to close database connections associated with a now-obsolete connection pool. However, since the servlet context will be destroyed (and garbage collected if the server itself continues to execute), there is no need to use contextDestroyed to remove normal objects from servlet context attributes.

  3. Obtain a reference to the servlet context. The context-Initializedand contextDestroyedmethods each take a ServletContextEventas an argument. The ServletContext-Eventclass has a getServletContextmethod that returns the servlet context.

  4. Use the servlet context. You read initialization parameters with getInitParameter, store data with setAttribute, and make log file entries with log.

  5. Declare the listener. Use the listenerand listener-class elements to simply list the fully qualified name of the listener class, as below.

    <listener>
    <listener-class>somePackage.SomeListener</listener-class>
    </listener>

    For now, assume that this declaration goes in the web.xml file (immediately before the servlet element). However, in Section 10.5 you'll see that if you package listeners with tag libraries, you can use the identical declaration within the TLD (tag library descriptor) file of the tag library.

  6. Provide any needed initialization parameters. Once you have a reference to the servlet context (see Step 3), you can use the get-InitParametermethod to read context initialization parameters as the basis of data that will be made available to all servlets and JSP pages. You use the context-paramweb.xml element to provide the names and values of these initialization parameters, as follows.

    <context-param>
      <param-name>name</param-name>
      <param-value>value</param-value>
    </context-param>
  • + 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