Home > Articles > Programming > Java

This chapter is from the book

10.4 Example: Monitoring Changes to Commonly Used Data

Section 10.2 shows how to read the current and former company names when the Web application is loaded and how to make use of those values in JSP pages. But what if you want to change the company name during the execution of the Web application? It is reasonable to expect a routine that makes this change to modify the companyName servlet context attribute. After all, in this context, that's what it means to change the company name. It is not reasonable, however, to expect that routine to modify (or even know about) the formerCompanyName attribute. But, if the company name changes, the former company name must change as well. Enter servlet context attribute listeners!

The following steps summarize a listener that automatically updates the former company name whenever the current company name changes.

  1. Implement the ServletContextAttributeListenerinter-face. Listing 10.5 shows a class (ChangedCompanyNameListener) that implements this interface.

  2. Override attributeAdded, attributeReplaced, and attributeRemoved. The attributeReplacedmethod is used to detect modification to context attributes. Empty bodies are supplied for the attributeAddedand attributeRemovedmethods.

  3. Obtain references to the attribute name, attribute value, and servlet context. The attributeReplacedmethod calls getName and getValueon its ServletContextAttributeEventargu-ment to obtain the name and value of the modified attribute. The method also calls getServletContexton its argument to get a reference to the servlet context.

  4. Use the objects. The attribute name is compared to "company-Name". If the name matches, the attribute value is used as the new value of the formerCompanyNameservlet context attribute.

  5. Declare the listener. The listener is declared in the deployment descriptor with the listenerand listener-classelements, as below.

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

    The web.xml file is shown in Listing 10.6.

Listing 10.7 presents a JSP page containing a form that displays the current company name, lets users enter a new name, and submits the new name to the Change-CompanyName servlet (Listing 10.8). Since changing the company name is a privileged operation, access to the form and the servlet should be restricted.

So, the form is placed in the admin directory and the servlet and servlet-mapping elements are used to assign the servlet a URL that also starts with /admin. See Section 5.3 (Assigning Names and Custom URLs) for details on servlet and servlet-mapping; see the deployment descriptor in Listing 10.6 for the usage in this example.

Next, the security-constraint element is used to stipulate that only authenticated users in the ceo role can access the admin directory. Then, the login-config element is used to specify that form-based authentication be used, with login.jsp (Listing 10.9) collecting usernames and passwords and login-error.jsp (Listing 10.10) displaying messages to users who failed authentication. Listing 10.11 shows a Tomcat-specific password file used to designate a user who is in the ceo role. See Section 7.1 (Form-Based Authentication) for details on these types of security settings; see the deployment descriptor in Listing 10.6 for the usage in this example.

Figures 10–3 through 10–8 show the results of logging in, changing the company name, and revisiting the pages that display the current and former company names.

Figures 10–3 Only users who are in the ceo role can access the form that changes the company name.

Figures 10–4 A failed login attempt.

Figures 10–5 The form to change the company name when the page is accessed by an authenticated user who is in the ceo role.

Figures 10–6 The name change confirmation page.

Figures 10–7 When the company name changes, the company home page (Listing 10.3) is automatically updated.

Figures 10–8 When the company name changes, the company information page (Listing 10.4) is also updated automatically.

Listing 10.5 ChangedCompanyNameListener.java

package moreservlets.listeners;

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

/** Listener that monitors changes in the company
 * name (which is stored in the companyName attribute
 * of the servlet context).
 */

public class ChangedCompanyNameListener
   implements ServletContextAttributeListener {
  /** When the companyName attribute changes, put
  * the previous value into the formerCompanyName
  * attribute.
  */

  public void attributeReplaced
               (ServletContextAttributeEvent event) {
   if (event.getName().equals("companyName")) {
     String oldName = (String)event.getValue();
     ServletContext context = event.getServletContext();
     context.setAttribute("formerCompanyName", oldName);
   }
  }
  public void attributeAdded
              (ServletContextAttributeEvent event) {}
  public void attributeRemoved
              (ServletContextAttributeEvent event) {}
}
<?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 listener that monitors changes to
    the company name.
  -->
  <listener>
   <listener-class>
     moreservlets.listeners.ChangedCompanyNameListener
   </listener-class>
  </listener>
  <!-- ... -->

  <!-- Assign the name ChangeCompanyName to
    moreservlets.ChangeCompanyName. -->
  <servlet>
   <servlet-name>ChangeCompanyName</servlet-name>
   <servlet-class>moreservlets.ChangeCompanyName</servlet-class>
  </servlet>

  <!-- Give a name to the servlet that redirects users
    to the home page.
  -->
  <servlet>
   <servlet-name>Redirector</servlet-name>
   <servlet-class>moreservlets.RedirectorServlet</servlet-class>
  </servlet>

  <!-- Assign the URL /admin/ChangeCompanyName to the
    servlet that is named ChangeCompanyName.
  -->
  <servlet-mapping>
   <servlet-name>ChangeCompanyName</servlet-name>
   <url-pattern>/admin/ChangeCompanyName</url-pattern>
  </servlet-mapping>

  <!-- Turn off invoker. Send requests to index.jsp. -->
  <servlet-mapping>
   <servlet-name>Redirector</servlet-name>
   <url-pattern>/servlet/*</url-pattern>
  </servlet-mapping>
  <!-- ... -->

  <!-- Protect everything within the "admin" directory.
     Direct client access to this directory requires
     authentication.
  -->
  <security-constraint>
   <web-resource-collection>
     <web-resource-name>Admin</web-resource-name>
     <url-pattern>/admin/*</url-pattern>
   </web-resource-collection>
   <auth-constraint>
     <role-name>ceo</role-name>
   </auth-constraint>
  </security-constraint>

  <!-- Tell the server to use form-based authentication. -->
  <login-config>
   <auth-method>FORM</auth-method>
   <form-login-config>
     <form-login-page>/admin/login.jsp</form-login-page>
    <form-error-page>/admin/login-error.jsp</form-error-page>
   </form-login-config>
  </login-config>
</web-app>

Listing 10.7 change-company-name.jsp

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<%@ page import="moreservlets.listeners.*" %>
<%
String companyName =
  InitialCompanyNameListener.getCompanyName(application);
%>
<TITLE>Changing Company Name</TITLE>
<LINK REL=STYLESHEET
      HREF="../events-styles.css"
      TYPE="text/css">
</HEAD>

<BODY>
<TABLE BORDER=5 ALIGN="CENTER">
  <TR><TH CLASS="TITLE">Changing Company Name
</TABLE>
<P>

<FORM ACTION="ChangeCompanyName">
New name:
<INPUT TYPE="TEXT" NAME="newName" VALUE="<%= companyName %>">
<P>
<CENTER><INPUT TYPE="SUBMIT" VALUE="Submit Change"></CENTER>
</FORM>

</BODY>
</HTML>

Listing 10.8 ChangeCompanyName.java

package moreservlets;

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

/** Servlet that changes the company name. The web.xml
 * file specifies that only authenticated users in the
 * ceo role can access the servlet. A servlet context
 * attribute listener updates the former company name
 * when this servlet (or any other program) changes
 * the current company name.
 */

public class ChangeCompanyName extends HttpServlet {
  public void doGet(HttpServletRequest request,
               HttpServletResponse response)
     throws ServletException, IOException {
   boolean isNameChanged = false;
   String newName = request.getParameter("newName");
   if ((newName != null) && (!newName.equals(""))) {
     isNameChanged = true;
     getServletContext().setAttribute("companyName",
                             newName);
}
  response.setContentType("text/html");
  PrintWriter out = response.getWriter();
  String docType =
   "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 " +
   "Transitional//EN\">\n";
  String title = "Company Name";
   out.println
     (docType +
     "<HTML>\n" +
     "<HEAD><TITLE>" + title + "</TITLE></HEAD>\n" +
     "<BODY BGCOLOR=\"#FDF5E6\">\n" +
     "<H2 ALIGN=\"CENTER\">" + title + "</H2>");
   if (isNameChanged) {
     out.println("Company name changed to " + newName + ".");
   } else {
     out.println("Company name not changed.");
   }
   out.println("</BODY></HTML>");
  }
}

Listing 10.9 login.jsp

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

<BODY>
<TABLE BORDER=5 ALIGN="CENTER">
  <TR><TH CLASS="TITLE">Log In</TABLE>
<P>
<H3>Sorry, you must log in before accessing this resource.</H3>
<FORM ACTION="j_security_check" METHOD="POST">
<TABLE>
<TR><TD>User name: <INPUT TYPE="TEXT" NAME="j_username">
<TR><TD>Password: <INPUT TYPE="PASSWORD" NAME="j_password">
<TR><TH><INPUT TYPE="SUBMIT" VALUE="Log In">
</TABLE>
</FORM>

</BODY>
</HTML>

Listing 10.10 login-error.jsp

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

<BODY>
<TABLE BORDER=5 ALIGN="CENTER">
  <TR><TH CLASS="TITLE">Begone!</TABLE>

<H3>Begone, ye unauthorized peon.</H3>

</BODY>
</HTML>

Listing 10.11 tomcat-users.xml (Excerpt for events examples)

<?xml version="1.0" encoding="ISO-8859-1"?>
<tomcat-users>
  <!-- ... -->
  <user name="gerstner" password="lou"
      roles="ceo" />
</tomcat-users>

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