| // |
| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| // |
| |
| = The NetBeans E-commerce Tutorial - Managing Sessions |
| :jbake-type: tutorial |
| :jbake-tags: tutorials |
| :jbake-status: published |
| :icons: font |
| :syntax: true |
| :source-highlighter: pygments |
| :toc: left |
| :toc-title: |
| :description: The NetBeans E-commerce Tutorial - Managing Sessions - Apache NetBeans |
| :keywords: Apache NetBeans, Tutorials, The NetBeans E-commerce Tutorial - Managing Sessions |
| |
| |
| == Tutorial Contents |
| |
| 1. link:intro.html[+Introduction+] |
| 2. link:design.html[+Designing the Application+] |
| 3. link:setup-dev-environ.html[+Setting up the Development Environment+] |
| 4. link:data-model.html[+Designing the Data Model+] |
| 5. link:page-views-controller.html[+Preparing the Page Views and Controller Servlet+] |
| 6. link:connect-db.html[+Connecting the Application to the Database+] |
| 7. link:entity-session.html[+Adding Entity Classes and Session Beans+] |
| 8. *Managing Sessions* |
| * <<session-data,Handling Session Data>> |
| * <<debug,Examining Session Data with the Java Debugger>> |
| * <<session-track,Examining Session Tracking Options>> |
| * <<time-out,Handling Session Time-Outs>> |
| * <<seeAlso,See Also>> |
| |
| [start=9] |
| . link:transaction.html[+Integrating Transactional Business Logic+] |
| |
| [start=10] |
| . link:language.html[+Adding Language Support+] |
| |
| [start=11] |
| . link:security.html[+Securing the Application+] |
| |
| [start=12] |
| . link:test-profile.html[+Testing and Profiling+] |
| |
| [start=13] |
| . link:conclusion.html[+Conclusion+] |
| |
| image::../../../../images_www/articles/68/netbeans-stamp-68-69.png[title="Content on this page applies to NetBeans IDE, versions 6.8 and 6.9"] |
| |
| Every e-commerce application that offers some form of shopping cart functionality needs to be able to remember user-specific data as users click through the website. Unfortunately for you the developer, the HTTP protocol, over which communication on the Internet takes place, is a _stateless_ protocol. Each request received by your server is an independent piece of information that has no relation to previously received requests. Therefore, if a customer clicks a button to add an item to his or her shopping cart, your application must take measures to ensure not only that the state of the user's cart is updated, but that the action doesn't affect the cart of another user who happens to be browsing the site at the same time. |
| |
| In order to properly handle the above-described scenario, you need to implement functionality so that a _session_ can be created and maintained for the duration of a user's visit to the site. Servlet technology, which is the foundation of all Java-based web applications, provides for this with its link:http://java.sun.com/javaee/6/docs/api/javax/servlet/http/HttpSession.html[+`HttpSession`+] interface. You also need to define several classes, namely `ShoppingCart` and `ShoppingCartItem`, that allow the application to temporarily store user data while the session is being maintained. |
| |
| This tutorial unit takes a different approach from others in the NetBeans E-commerce Tutorial. Instead of having you create project files and providing steps with code snippets for you to copy and paste into your own project, you open the completed project snapshot for this unit, and examine the code using the IDE's debugger and other tools. In the process, you'll learn how to apply an `HttpSession` object to your code so that each visit to the website results in a dedicated session. You also learn about _scoped variables_, and their usage in both Java classes and JSP pages. This unit also discusses `HttpSession`'s default mechanism for maintaining sessions (i.e., cookies) and shows what steps need to be taken in the event that cookies are deactivated in a user's browser. Finally, session time-outs are covered, and the unit demonstrates how to handle them by creating a simple filter that intercepts requests to check whether a session exists. |
| |
| You can view a live demo of the application that you build in this tutorial: link:http://services.netbeans.org/AffableBean/[+NetBeans E-commerce Tutorial Demo Application+]. |
| |
| |
| |
| |=== |
| |Software or Resource |Version Required |
| |
| |link:https://netbeans.org/downloads/index.html[+NetBeans IDE+] |Java bundle, 6.8 or 6.9 |
| |
| |link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[+Java Development Kit (JDK)+] |version 6 |
| |
| |<<glassFish,GlassFish server>> |v3 or Open Source Edition 3.0.1 |
| |
| |link:http://dev.mysql.com/downloads/mysql/[+MySQL database server+] |version 5.1 |
| |
| |link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fecommerce%252FAffableBean_snapshot5.zip[+AffableBean project+] |snapshot 5 |
| |=== |
| |
| *Notes:* |
| |
| * The NetBeans IDE requires the Java Development Kit (JDK) to run properly. If you do not have any of the resources listed above, the JDK should be the first item that you download and install. |
| * The NetBeans IDE Java Bundle includes Java Web and EE technologies, which are required for the application you build in this tutorial. |
| * The NetBeans IDE Java Bundle also includes the GlassFish server, which you require for this tutorial. You could link:http://glassfish.dev.java.net/public/downloadsindex.html[+download the GlassFish server independently+], but the version provided with the NetBeans download has the added benefit of being automatically registered with the IDE. |
| * You can follow this tutorial unit without having completed previous units. To do so, see the link:setup.html[+setup instructions+], which describe how to prepare the database and establish connectivity between the IDE, GlassFish, and MySQL. |
| |
| |
| |
| [[session-data]] |
| == Handling Session Data |
| |
| Applications can manage user sessions with the `HttpSession` object. You can bind user-specific data to the `HttpSession` object, then access this data at a later stage. Both bind and access actions can be done from Java classes, as well as from session-scoped variables in EL expressions. |
| |
| * <<httpSession,Working with an HttpSession Object>> |
| * <<scopedVariables,Working with Scoped Variables in Web Applications>> |
| |
| |
| [[httpSession]] |
| === Working with an HttpSession Object |
| |
| The `AffableBean` application uses the `HttpSession` object to identify users over multiple requests. An `HttpSession` object is obtained using `getSession()` on a given request: |
| |
| |
| [source,java] |
| ---- |
| |
| HttpSession session = request.getSession(); |
| ---- |
| |
| If a session object doesn't yet exist for the request, the method creates and returns a new session object. |
| |
| You can use the session object as a vehicle for passing data between requests. You use the `setAttribute` method to bind objects to the session. Likewise, you use `getAttribute` to retrieve objects from the session. In the `AffableBean` application for example, the user's shopping cart is created and bound to the user session in the following manner: |
| |
| |
| [source,java] |
| ---- |
| |
| ShoppingCart cart = new ShoppingCart(); |
| session.setAttribute("cart", cart); |
| ---- |
| |
| In order to retrieve the cart from the session, the `getAttribute` method is applied: |
| |
| |
| [source,java] |
| ---- |
| |
| cart = (ShoppingCart) session.getAttribute("cart"); |
| ---- |
| |
| In JSP pages, you can access objects bound to the session using EL expressions. Continuing with the above example, if a `ShoppingCart` object named '`cart`' is bound to the session, you can access the object using the following EL expression: |
| |
| |
| [source,java] |
| ---- |
| |
| ${cart} |
| ---- |
| |
| Accessing the `ShoppingCart` object on its own is of little value however. What you really want is a way to access values stored in the object. If you explore the new `ShoppingCart` class in the project snapshot, you'll note that it contains the following properties: |
| |
| * `double total` |
| * `int numberOfItems` |
| * `List<String, ShoppingCartItem> items` |
| |
| Provided that properties have matching getter methods, you can access values for singular properties using simple dot notation in an EL expression. If you examine the `cart.jsp` page, you'll see that this is exactly how the value for `numberOfItems` is accessed: |
| |
| |
| [source,html] |
| ---- |
| |
| <p>Your shopping cart contains ${cart.numberOfItems} items.</p> |
| ---- |
| |
| In order to extract data from properties that contain multiple values, such as the above `items` list, the `cart.jsp` page uses a `<c:forEach>` loop: |
| |
| |
| [source,xml] |
| ---- |
| |
| <c:forEach var="cartItem" items="${cart.items}" varStatus="iter"> |
| |
| <c:set var="product" value="${cartItem.product}"/> |
| |
| <tr class="${((iter.index % 2) == 0) ? 'lightBlue' : 'white'}"> |
| <td> |
| <img src="${initParam.productImagePath}${product.name}.png" |
| alt="${product.name}"> |
| </td> |
| |
| <td>${product.name}</td> |
| |
| <td> |
| &euro; ${cartItem.total} |
| <br> |
| <span class="smallText">( &euro; ${product.price} / unit )</span> |
| </td> |
| ... |
| </tr> |
| |
| </c:forEach> |
| ---- |
| |
| `ShoppingCartItem`'s `product` property identifies the product type for a cart item. The above loop takes advantage of this by first setting a `product` variable to the expression `${cartItem.product}`. It then uses the variable to obtain information about that product (e.g., name, price). |
| |
| |
| [[scopedVariables]] |
| === Working with Scoped Variables in Web Applications |
| |
| When working with JSP/Servlet technology, there are four scope objects available to you within the realm of the application. JSP technology implements _implicit objects_ that allows you to access classes defined by the Servlet API. |
| |
| |=== |
| |Scope |Definition |Servlet Class |JSP Implicit Object |
| |
| |*Application* |Global memory for a web application |`link:http://java.sun.com/javaee/6/docs/api/javax/servlet/ServletContext.html[+javax.servlet.ServletContext+]` |`applicationScope` |
| |
| |*Session* |Data specific to a user session |`link:http://java.sun.com/javaee/6/docs/api/javax/servlet/http/HttpSession.html[+javax.servlet.http.HttpSession+]` |`sessionScope` |
| |
| |*Request* |Data specific to an individual server request |`link:http://java.sun.com/javaee/6/docs/api/javax/servlet/http/HttpServletRequest.html[+javax.servlet.HttpServletRequest+]` |`requestScope` |
| |
| |*Page* |Data that is only valid in the context of a single page (JSPs only) |`[n/a]` |`pageScope` |
| |=== |
| |
| If you open your project's `category.jsp` file in the editor, you'll see that EL expressions include various scoped variables, including `${categories}`, `${selectedCategory}` and `${categoryProducts}`. The `${categories}` variable is application-scoped, which is set in the `ControllerServlet`'s `init` method: |
| |
| |
| [source,java] |
| ---- |
| |
| // store category list in servlet context |
| getServletContext().setAttribute("categories", categoryFacade.findAll()); |
| ---- |
| |
| The other two, `${selectedCategory}` and `${categoryProducts}`, are placed in the application's session scope from the `ControllerServlet`. For example: |
| |
| |
| [source,java] |
| ---- |
| |
| // place selected category in session scope |
| session.setAttribute("selectedCategory", selectedCategory); |
| ---- |
| |
| *Note:* If you are continuing from the previous tutorial units, you'll likely note that `${selectedCategory}` and `${categoryProducts}` were originally placed in the request scope. In previous units this was fine, but consider now what happens if a user clicks the 'add to cart' button in a category page. The server responds to an `addToCart` request by returning the currently viewed category page. It therefore needs to know the `selectedCategory` and the `categoryProducts` pertaining to the selected category. Rather than establishing this information for each request, you place it in the session scope from a `category` request so that it is maintained across multiple requests, and can be accessed when you need it. Also, examine the functionality provided by the cart page. (A functional description is <<cartPage,provided below>>.) The 'continue shopping' button returns the user to the previously viewed category. Again, the `selectedCategory` and the `categoryProducts` variables are required. |
| |
| When referencing scoped variables in an EL expression, you do not need to specify the variable's scope (provided that you do not have two variables of the same name in different scopes). The JSP engine checks all four scopes and returns the first variable match it finds. In `category.jsp` for example, you can use the following expression: |
| |
| |
| [source,java] |
| ---- |
| |
| ${categoryProducts} |
| ---- |
| |
| This expression is shorthand for the following expression: |
| |
| |
| [source,java] |
| ---- |
| |
| ${sessionScope.categoryProducts} |
| ---- |
| [tips]#For more information, see the following resources:# |
| |
| * link:http://java.sun.com/blueprints/guidelines/designing_enterprise_applications_2e/web-tier/web-tier5.html#1079198[+Designing Enterprise Applications with the J2EE Platform: State Scopes+] |
| * link:http://download.oracle.com/docs/cd/E17477_01/javaee/5/tutorial/doc/bnafo.html[+Sharing Information > Using Scoped Objects+] |
| * link:http://download.oracle.com/docs/cd/E17477_01/javaee/5/tutorial/doc/bnahq.html#bnaij[+Unified Expression Language > Implicit Objects+] |
| |
| |
| |
| [[debug]] |
| == Examining Session Data with the Java Debugger |
| |
| Begin exploring how the application behaves during runtime. Use the IDE's debugger to step through code and examine how the `HttpSession` is created, and how other objects can be placed in the session scope to be retrieved at a later point. |
| |
| 1. Open the link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fecommerce%252FAffableBean_snapshot5.zip[+project snapshot+] for this tutorial unit in the IDE. Click the Open Project ( image::images/open-project-btn.png[] ) button and use the wizard to navigate to the location on your computer where you downloaded the project. If you are proceeding from the link:entity-session.html[+previous tutorial unit+], note that this project snapshot includes a new `cart` package, containing `ShoppingCart` and `ShoppingCartItem` classes. Also, the following files have been modified: |
| * `WEB-INF/web.xml` |
| * `css/affablebean.css` |
| * `WEB-INF/jspf/header.jspf` |
| * `WEB-INF/jspf/footer.jspf` |
| * `WEB-INF/view/cart.jsp` |
| * `WEB-INF/view/category.jsp` |
| * `WEB-INF/view/checkout.jsp` |
| * `controller/ControllerServlet` |
| |
| [start=2] |
| . Run the project ( image::images/run-project-btn.png[] ) to ensure that it is properly configured with your database and application server. |
| |
| If you receive an error when running the project, revisit the link:setup.html[+setup instructions+], which describe how to prepare the database and establish connectivity between the IDE, GlassFish, and MySQL. |
| |
| |
| [start=3] |
| . Test the application's functionality in your browser. If you are continuing directly from the link:entity-session.html[+previous tutorial unit+], you'll note the following enhancements. |
| |
| |
| === category page |
| |
| * Clicking 'add to cart' for the first time enables the shopping cart and 'proceed to checkout' widgets to display in the header. |
| * Clicking 'add to cart' results in an update to the number of cart items in the header's shopping cart widget. |
| * Clicking 'view cart' results in the cart page displaying. |
| * Clicking 'proceed to checkout' results in the checkout page displaying. |
| image::images/category-page.png[title="Category page includes shopping cart functionality"] |
| |
| |
| [[cartPage]] |
| === cart page |
| |
| * Clicking 'clear cart' results in shopping cart being emptied of items. |
| * Clicking 'continue shopping' results in a return to the previously viewed category. |
| * Clicking 'proceed to checkout' results in the checkout page displaying. |
| * Entering a number (1 - 99) in an item's quantity field then clicking 'update' results in a recalculation of the total price for the item, and of the subtotal. |
| * Entering zero in an item's quantity field then clicking 'update' results in the item being removed from the displayed table. |
| image::images/cart-page.png[title="Cart page includes shopping cart functionality"] |
| |
| |
| === checkout page |
| |
| * Clicking 'view cart' results in the cart page displaying. |
| * Clicking 'submit purchase' results in the confirmation page displaying (without user-specific data). |
| image::images/checkout-page.png[title="Checkout page includes shopping cart functionality"] |
| |
| [start=4] |
| . Use the Go to File dialog to open the `ControllerServlet` in the editor. Press Alt-Shift-O (Ctrl-Shift-O on Mac), then type '`Controller`' in the dialog and click OK. |
| image::images/go-to-file-dialog.png[title="Use the Go to File dialog to quickly open project resources in the editor"] |
| |
| [start=5] |
| . Set a breakpoint in the `doPost` method on the line that creates an `HttpSession` object (line 150). To set a breakpoint, click in the left margin of the editor. |
| image::images/breakpoint.png[title="Click in editor's left margin to set breakpoints"] |
| |
| To toggle line numbers for the editor, right-click in the left margin and choose Show Line Numbers. |
| |
| |
| [start=6] |
| . Run the debugger. Click the Debug Project ( image::images/debug-project-btn.png[] ) button in the IDE's main toolbar. The GlassFish server starts (or restarts, if it is already running) and opens a socket on its debug port number. The application welcome page opens in your browser. |
| |
| You can view and modify the debug port number from the Servers window (Tools > Servers). Select the Java tab for the server you are using. Specify the port number in the 'Address to use' field under Debug Settings. |
| |
| |
| [start=7] |
| . When the application's welcome page displays in the browser, click any category image to navigate to the category page. Recall that clicking the 'add to cart' button sends an `addToCart` request to the server: |
| |
| [source,java] |
| ---- |
| |
| <form action="addToCart" method="post"> |
| ---- |
| As you may recall from link:page-views-controller.html#controller[+Preparing the Page Views and Controller Servlet+], the `ControllerServlet`'s `doPost` method handles requests for the `/addToCart` URL pattern. You can therefore expect that when a user clicks an 'add to cart' button, the `doPost` method is called. |
| |
| [start=8] |
| . Click 'add to cart' for any product in the category page. Switch back to the IDE and note that the debugger suspends on the breakpoint. |
| image::images/breakpoint-suspended.png[title="Debugger suspends on breakpoints in editor"] |
| |
| [start=9] |
| . Place your cursor on the call to `getSession()` and press Ctrl-Space to invoke the Javadoc documentation. |
| image::images/javadoc-getsession.png[title="Press Ctrl-Space to invoke Javadoc documentation"] |
| According to the documentation, `getSession()` returns the `HttpSession` currently associated with the request, and if no session exists, the method creates a new session object. |
| |
| |
| === Taking Advantage of the IDE's Javadoc Support |
| |
| The IDE provides built-in Javadoc support for Java EE development. The IDE bundles with the Java EE 6 API Specification, which you can open in an external browser by choosing Help > Javadoc References > Java EE 6. |
| |
| The IDE also includes various other features that enable easy access to API documentation: |
| |
| * *Javadoc window:* Choose Window > Other > Javadoc. The Javadoc window opens in the bottom region of the IDE, and displays API documentation relevant to your cursor's location in the editor. |
| * *Javadoc Index Search:* Choose Help > Javadoc Index Search (Shift-F1; fn-Shift-F1 on Mac). Type in the name of the class you are looking for, then select a class from the listed results. The complete class description from the API Specification displays in the bottom pane of the window. |
| * *Documentation popup in the editor:* Javadoc documentation displays in a popup window when you press Ctrl-Space on a given element in the editor. You can click the External Browser ( image::images/external-browser-btn.png[] ) button to have the documentation open in your browser. If you want to use Ctrl-Space for code completion only, you can deactivate the documentation popup by opening the Options window (Tools > Options; NetBeans > Preferences on Mac), then selecting Editor > Code Completion. Deselect the 'Auto Popup Documentation Window' option. |
| |
| When you document your own work, consider adding Javadoc comments to your classes and methods. Open the `ShoppingCart` class and examine the Javadoc comments added to the class methods. Javadoc comments are marked by the `/** ... */` delimiters. For example, the `addItem` method has the following comment before its signature: |
| |
| |
| [source,xml] |
| ---- |
| |
| /** |
| * Adds a <code>ShoppingCartItem</code> to the <code>ShoppingCart</code>'s |
| * <code>items</code> list. If item of the specified <code>product</code> |
| * already exists in shopping cart list, the quantity of that item is |
| * incremented. |
| * |
| * @param product the <code>Product</code> that defines the type of shopping cart item |
| * @see ShoppingCartItem |
| */ |
| public synchronized void addItem(Product product) { |
| ---- |
| |
| This enables you (and others working on the project) to view Javadoc documentation on the method. To demonstrate, open the Navigator (Ctrl-7; ⌘-7 on Mac) and hover your mouse over the `addItem` method. |
| |
| image::images/javadoc-additem.png[title="Hover over methods in Navigator to view Javadoc documentation"] |
| |
| You can also use the IDE to generate a set of Javadoc HTML pages. In the Projects window, right-click your project node and choose Generate Javadoc. The IDE generates the Javadoc in the `dist/javadoc` folder of your project's directory and opens the index page in the browser. |
| |
| |
| For more information on Javadoc, see the following resources: |
| |
| * link:http://java.sun.com/j2se/javadoc/[+Javadoc Tool Official Home Page+] |
| * link:http://java.sun.com/j2se/javadoc/writingdoccomments/index.html[+How to Write Doc Comments for the Javadoc Tool+] |
| |
| [start=10] |
| . Hover your mouse over the `session` variable. Note that the debugger suspends on the line _it is about to execute._ The value returned by `getSession()` has not yet been saved into the `session` variable, and you see a popup stating that "`session` is not a known variable in the current context." |
| image::images/session-variable.png[title="Hover your mouse over variables and expressions to determine their current values"] |
| |
| [start=11] |
| . Click the Step Over ( image::images/step-over-btn.png[] ) button in the debugger toolbar located above the editor. The line is executed, and the debugger steps to the next line in the file. |
| |
| [start=12] |
| . Hover your mouse over the `session` variable again. Now you see the value currently set to the `session` variable. |
| [.feature] |
| -- |
| image::images/session-variable-set.png[role="left", link="images/session-variable-set.png"] |
| -- |
| |
| In NetBeans 6.9, you can click the grey pointer ( image::images/grey-pointer.png[] ) in the popup to expand a list of variable values contained in the highlighted element. |
| |
| |
| [start=13] |
| . Click the Step Over ( image::images/step-over-btn.png[] ) button (F8; fn-F8 on Mac) to arrive at the `if` statement (line 154). Because you just clicked the 'add to cart' button in the browser, you know that the expression `userPath.equals("/addToCart")` should evaluate to `true`. |
| |
| [start=14] |
| . Highlight the `userPath.equals("/addToCart")` expression (by control-clicking with your mouse). This time you see a popup indicating the value of the expression you highlighted. |
| image::images/expression.png[title="Highlight expressions to determine their current values"] |
| |
| [start=15] |
| . Press F8 (fn-F8 on Mac) to step to the next line (line 158). The application has been designed so that the `ShoppingCart` object for the user session is only created when the user adds an item to the cart for the first time. Since this is the first time the `addToCart` request has been received in this debug session, you can expect the `cart` object to equal `null`. |
| image::images/cart-null.png[title="Cart object doesn't exist until user adds item to shopping cart"] |
| |
| [start=16] |
| . Press F8 (fn-F8 on Mac) to step to the next line (line 160). Then, on line 160, where the `ShoppingCart` object is created, click the Step Into ( image::images/step-into-btn.png[] ) button. The debugger steps into the method being called. In this case, you are taken directly to the `ShoppingCart`'s constructor. |
| image::images/cart-constructor.png[title="Step into methods to follow runtime execution to other classes"] |
| |
| [start=17] |
| . Press Ctrl-Tab to switch back to the `ControllerServlet`. Note that the IDE provides a Call Stack ( image::images/call-stack-badge.png[] ) badge on line 160, indicating that the debugger is currently suspended somewhere on a method higher up in the call stack. |
| |
| Press Alt-Shift-3 (Ctrl-Shift-3 on Mac) to open the IDE's Call Stack window. |
| |
| |
| [start=18] |
| . Press F8 (fn-F8 on Mac) to continue stepping through code. When the debugger completes the `ShoppingCart` constructor, you are taken back to the `ControllerServlet`. |
| |
| Line 161 of the `ControllerServlet` binds the newly-created `cart` object to the session. |
| |
| [source,java] |
| ---- |
| |
| session.setAttribute("cart", cart); |
| ---- |
| To witness this, open the debugger's Variables window. Choose Window > Debugging > Variables, or press Alt-Shift-1 (Ctrl-Shift-1 on Mac). |
| [.feature] |
| -- |
| image::images/variables-win-session.png[role="left", link="images/variables-win-session.png"] |
| -- |
| |
| If you expand the session > session > attributes node, you are able to view the objects that are bound to the session. In the above image, there are two items currently bound to the session (highlighted). These are `selectedCategory` and `categoryProducts`, instantiated in the `ControllerServlet` at lines 83 and 89, respectively. Both of these items were bound earlier, when you clicked a category image, and the `ControllerServlet` processed the category page request. |
| |
| [start=19] |
| . Press F8 (fn-F8 on Mac) to execute line 161. The `cart` object is bound to the session, and the Variables window updates to reflect changes. In the Variables window, note that the session now contains three attributes, the third being the newly initialized `ShoppingCart` object (highlighted below). |
| [.feature] |
| -- |
| image::images/variables-win-session-cart.png[role="left", link="images/variables-win-session-cart.png"] |
| -- |
| |
| |
| So far, we have not "proven" that the session, as listed in the Variables window, represents an `HttpSession`. As previously mentioned, `HttpSession` is actually an interface, so when we talk about an `HttpSession` object, or session object, we are in fact referring to any object that implements the `HttpSession` interface. In the Variables window, if you hover your cursor over '`session`', a popup displays indicating that the variable represents an `HttpSession` object. The `StandardSessionFacade` type, as displayed, is the internal class that GlassFish uses to implement the `HttpSession` interface. If you are familiar with Tomcat and are puzzled by the '`org.apache.catalina`' paths that appear in the Value column, this is because the GlassFish web/servlet container is in fact a derivative of the Apache Tomcat container. |
| |
| A new `ShoppingCart` is added to the session, and the request continues to be processed. In order to complete implementation of the 'add to cart' functionality, the following actions are taken: |
| * the ID of the selected product is retrieved from the request (line 165) |
| * a `Product` object is created using the ID (line 169) |
| * a new `ShoppingCartItem` is created using the `product` (line 170) |
| * the `ShoppingCartItem` is added to `ShoppingCart`'s `items` list (line 170) |
| |
| [start=20] |
| . Press F8 (fn-F8 on Mac) to continue stepping through code while being mindful of the above-listed four actions. Pause when the debugger suspends on line 170. |
| |
| [start=21] |
| . Create a watch on the session. This will allow you to view values contained in the session when you step into the `addItem` method in the next step. Right-click the session in the Variables window and choose Create Fixed Watch. |
| image::images/create-watch.png[title="Create watches on variables as you step through code in a debug session"] |
| |
| Alternatively, you can place your cursor on the `session` variable in the editor, then right-click and choose New Watch. The New Watch dialog enables you to specify variables or expressions to watch continuously when debugging an application. (In the case of expressions, highlight the expression first, then right-click and choose New Watch.) |
| image::images/new-watch-dialog.png[title="Right-click variables and expressions in the editor and choose New Watch"] |
| |
| A new watch is created on the `session` variable and all variables it contains. The watch is visible from the Watches window (Window > Debugging > Watches) or, if you toggle the Watches ( image::images/watch-btn.png[] ) button in the left margin of the Variables window, it displays in the top row of the Variables window. |
| |
| The debugger enables you to keep an eye on variables as it steps through code. This can be helpful, for example if you'd like to follow changes to specific variable values (and don't want to need to sift through the full list presented in the Variables window with each step), or if you temporarily step into a class that doesn't contain the variables you are interested in. |
| |
| [start=22] |
| . Click the Step Into ( image::images/step-into-btn.png[] ) button to step into `ShoppingCart`'s `addItem` method. |
| |
| [start=23] |
| . Step through the `addItem` method until you reach line 53. As the Javadoc states, `addItem` _"adds a `ShoppingCartItem` to the `ShoppingCart`'s `items` list. If item of the specified `product` already exists in shopping cart list, the quantity of that item is incremented."_ |
| |
| [start=24] |
| . Examine the `session` variable which you created a watch on (<<step21,step 21>> above). The `items.add(scItem)` statement in line 51 added the new `ShoppingCartItem` to the `items` list in the `ShoppingCart`. This is evident by drilling into the third attribute (i.e., the `cart` variable) contained in the session. |
| [.feature] |
| -- |
| image::images/variables-window-add-item.png[role="left", link="images/variables-window-add-item.png"] |
| -- |
| |
| At this stage, you can see how an `HttpSession` is created for the request, how a `ShoppingCart` object is created and attached to the session, and how a `ShoppingCartItem` is created based on the user's product choice, then added to the `ShoppingCart`'s list of `items`. The only remaining action is to forward the request to the `category.jsp` view. |
| |
| [start=25] |
| . Open the header JSP fragment (`header.jspf`) in the editor and place a breakpoint on line 86. This line contains the EL statement within the shopping cart widget that displays the number of cart items. |
| image::images/breakpoint-jsp.png[title="You can suspend the debugger in JSP pages"] |
| |
| [start=26] |
| . Click the Continue ( image::images/continue-btn.png[] ) button in the debugger toolbar. The debugger continues until execution completes, or until it reaches another breakpoint. In this case, the debugger suspends on line 86 in the header JSP fragment. |
| |
| *Note:* In order to suspend the debugger in a JSP page, you need to set a breakpoint. For example, when the `ControllerServlet` forwards the request to the appropriate view, the debugger will not automatically suspend within the JSP page. |
| |
| |
| [start=27] |
| . Open the Variables window (Alt-Shift-1; Ctrl-Shift-1 on Mac) if it is not already open. Unlike with Java classes, the debugger _does not_ provide tooltips when you hover your mouse over variables or expressions in a JSP page. However, the Variables window does enable you to determine variable values as you step through code. So, where can you find the value for `${cart.numberOfItems}`? |
| |
| [start=28] |
| . In the Variables window, expand the Implicit Objects > pageContext > session > session > attributes node. This provides access to the session object, just as you saw earlier when working in the `ControllerServlet`. In fact, you may note that the session which you created a watch on in step 21 above points to the very same object. Here you can verify that the value of `${cart.numberOfItems}` equals '`1`'. |
| [.feature] |
| -- |
| image::images/variables-window-number-of-items.png[role="left", link="images/variables-window-number-of-items.png"] |
| -- |
| |
| Maximize the Variables window, or any window in the IDE, by right-clicking the window header, then choosing Maximize Window (Shift-Esc). |
| |
| The debugger gives you access to the `pageContext` implicit object. `pageContext` represents the context of the JSP page, and offers direct access to various objects including the `HttpServletRequest`, `HttpSession`, and `ServletContext` objects. For more information, see the link:http://java.sun.com/javaee/5/docs/tutorial/doc/bnahq.html#bnaij[+Java EE 5 Tutorial: Implicit Objects+]. |
| |
| [start=29] |
| . Click the Finish Session ( image::images/finish-session-btn.png[] ) button. The runtime finishes executing, and the debug session terminates. The browser displays a fully-rendered category page, and you can see that the shopping cart widget in the page header contains one item. |
| |
| Hopefully you now feel comfortable using the IDE's debugger not only to examine your project when it behaves unexpectedly, but also as a tool to become more familiar with code. Other useful buttons in the debugger toolbar include: |
| |
| * ( image::images/step-out.png[] ) *Step Out:* Steps you out of the current method call. Executes and removes the topmost method call in your call stack. |
| * ( image::images/run-to-cursor.png[] ) *Run to Cursor:* Executes up to the line on which your cursor is placed. |
| * ( image::images/apply-code-changes.png[] ) *Apply Code Changes:* After editing a file, you can press this button so that the file is recompiled and changes are taken into account in the debug session. |
| * ( image::images/step-over-expression.png[] ) *Step Over Expression:* Enables you to view the input parameters and resulting output values of each method call within an expression. You can inspect the output values for the previous method and the input parameters for the next method in the Local Variables window. When there are no further method calls, Step Over Expression behaves like the Step Over ( image::images/step-over-btn.png[] ) command. |
| |
| |
| |
| [[session-track]] |
| == Examining Session Tracking Options |
| |
| There are three conventional ways of tracking sessions between client and server. By far the most common is with cookies. URL rewriting can be applied in the event that cookies are not supported or disabled. Hidden form fields can also be used as a means of "maintaining state" over multiple requests, but these are limited to usage within forms. |
| |
| The `AffableBean` project includes an example of the hidden field method in both the category and cart pages. The 'add to cart' and 'update' buttons that display for product items contain a hidden field which relays the product ID to the server when the button is clicked. If you open the `cart.jsp` page in the editor, you'll see that the `<form>` tags contain a hidden field. |
| |
| |
| [source,xml] |
| ---- |
| |
| <form action="updateCart" method="post"> |
| *<input type="hidden" |
| name="productId" |
| value="${product.id}">* |
| ... |
| </form> |
| ---- |
| |
| In this manner, the product ID is sent as a request parameter which the server uses to identify the item within the user's cart whose quantity needs to be modified. |
| |
| The Servlet API provides a high-level mechanism for managing sessions. Essentially, it creates and passes a cookie between the client and server with each request-response cycle. If the client browser doesn't accept cookies, the servlet engine automatically reverts to URL rewriting. The following two exercises demonstrate this functionality. |
| |
| * <<http-monitor,Examining Client-Server Communication with the HTTP Monitor>> |
| * <<url-rewrite,Maintaining Sessions with URL Rewriting>> |
| |
| |
| [[http-monitor]] |
| === Examining Client-Server Communication with the HTTP Monitor |
| |
| By default, the servlet engine uses cookies to maintain and identify sessions between requests. A random, alphanumeric number is generated for each session object, which serves as a unique identifier. This identifier is passed as a '`JSESSIONID`' cookie to the client. When the client makes a request, the servlet engine reads the value of the `JSESSIONID` cookie to determine the session which the request belongs to. |
| |
| To demonstrate this, we'll use the debugger in tandem with the IDE's HTTP Monitor. |
| |
| 1. Begin by activating the HTTP Monitor for the server you are using. Choose Tools > Servers. In the left column of the Servers window, select the server you are using (GlassFish). Then, in the main column, select the Enable HTTP Monitor option. |
| image::images/servers-win-http-monitor.png[title="Select the Enable HTTP Monitor option to activate the HTTP Monitor"] |
| |
| [start=2] |
| . If your server is already running, you need to restart it. However, since we plan to use the debugger, and running the debugger restarts the server to communicate on a different port, just click the Debug Project ( image::images/debug-project-btn.png[] ) button in the IDE's main toolbar. The server restarts, a debug session begins and the application's welcome page opens in your browser. The HTTP Monitor displays in the bottom region of the IDE. |
| image::images/http-monitor.png[title="HTTP Monitor displays by default in bottom region of the IDE"] |
| |
| [start=3] |
| . Click the AffableBean record in the left column (as shown in the above image). When you select records in the left column, the right (i.e., main) column refreshes to display corresponding data. In the above image, the Request tab displays the requested URI (`/AffableBean/`), the HTTP method (`GET`), and points out that there was no query string sent with the request. |
| |
| [start=4] |
| . Select the Session tab. Note that there is a statement, "The session was created as a result of this request." This is due to the fact that the server has sent a `Set-Cookie` header for the `JSESSIONID` cookie in its response. Also note that the new session ID is listed under 'Session properties'. As will later be shown, the session ID is the value of the `JSESSIONID` cookie. |
| image::images/session-tab.png[title="Session details are displayed under the Session tab in the HTTP Monitor"] |
| You may wonder how a session object was created from a request for the site welcome page. After all, the `ControllerServlet` does not handle the initial request for `/AffableBean/`, and nowhere does this request encounter `getSession()`. Or does it? Recall that JSP pages are compiled into servlets upon deployment. Once you've deployed your project to the server, you can actually use the IDE to view the JSP's compiled servlet on your server. |
| |
| [start=5] |
| . In the Projects window, right-click the `index.jsp` file and choose View Servlet. An `index_jsp.java` file opens in the editor. This is the servlet that was automatically compiled from the `index.jsp` page. |
| |
| [start=6] |
| . Perform a search in the file for `getSession`. Press Ctrl-F (⌘-F on Mac), type '`getSession`' in the search bar, then press Enter. |
| |
| Ctrl-F (⌘-F on Mac) is a keyboard shortcut for Edit > Find. |
| |
| image::images/get-session.png[title="The getSession method exists in the JSP page's compiled servlet"] |
| |
| The `getSession` method is in fact called. The reason this occurs is because JSP pages include the `pageContext.session` implicit object by default. If you wanted to deactivate this behavior, you could add the following directive to the top of a JSP file: |
| |
| |
| [source,java] |
| ---- |
| |
| <%@page session="false" %> |
| ---- |
| |
| If you add the directive the `getSession` method will be removed in the compiled servlet. |
| |
| To find out the location of the compiled servlet on your server, you can hover your mouse over the servlet's name tab above the editor. A popup displays the path to the file on your computer. |
| |
| |
| [start=7] |
| . In the browser, select a category then add an item to your cart. Switch back to the IDE. Note that the debugger suspends on the breakpoint in the `ControllerServlet` you set earlier (line 150). All breakpoints are remembered between sessions. To remove the breakpoint, you could click the breakpoint ( image::images/breakpoint-badge.png[] ) badge in the editor's left margin. However, since there are multiple breakpoints already set in the project, open the debugger's Breakpoints window (Window > Debugging > Breakpoints). |
| image::images/breakpoints-window.png[title="View all breakpoints in your project from the Breakpoints window"] |
| From the Breakpoints window, you can view and call actions on all breakpoints set in projects opened in the IDE. |
| |
| [start=8] |
| . Right-click the breakpoint set in `header.jspf` and choose Delete. Then right-click the breakpoint set in the `ControllerServlet` and choose Disable. (You'll re-enable it later in this exercise.) |
| |
| [start=9] |
| . Click the Continue ( image::images/continue-btn.png[] ) button. The request finishes executing, and the category page displays in the browser with one item added to the cart. |
| |
| [start=10] |
| . In the HTTP Monitor, search for the `addToCart` request in the left column, then select it to display details in the main column. |
| |
| Click the Ascending Sort ( image::images/ascending-sort-btn.png[] ) button so that the most recent records are listed at the top. |
| |
| |
| Under the Request tab, note the requested URI (`/AffableBean/addToCart`), the HTTP method (`POST`), and the request parameters (`productId` and `submit`). |
| [.feature] |
| -- |
| image::images/http-monitor-add-to-cart.png[role="left", link="images/http-monitor-add-to-cart.png"] |
| -- |
| |
| [start=11] |
| . Select the Cookies tab. Here you see that a cookie named `JSESSIONID` exists, and was sent from the client to the server. Note that the value for the cookie is the same as the Session ID displayed under the Session tab. |
| image::images/cookies-tab.png[title="Cookies are displayed under the Cookies tab in the HTTP Monitor"] |
| Likewise, if you click the Header tab, you see the cookie listed, since '`Cookie`' is a request header that was sent by the client. |
| image::images/headers-tab.png[title="Cookies are displayed under the Cookies tab in the HTTP Monitor"] |
| |
| See Wikipedia's link:http://en.wikipedia.org/wiki/List_of_HTTP_headers[+List of HTTP headers+] for more information on request and response headers. |
| |
| |
| [start=12] |
| . Select the Session tab. There is a statement which indicates, "The session existed before this request." Also note that the `cart` attribute is listed under 'Session attributes after the request'. This makes sense, since we know that the `cart` object is bound to the session when the `addToCart` request is processed for the first time. |
| image::images/session-tab-add-to-cart.png[title="Session attributes are displayed under the Session tab in the HTTP Monitor"] |
| |
| In the next few steps, locate the session ID and `JSESSIONID` cookie in the Variables window. |
| |
| [start=13] |
| . Re-enable the breakpoint you set earlier in the `ControllerServlet`. Press Alt-Shift-5 (Ctrl-Shift-5 on Mac) to open the Breakpoints window, then click in the checkbox next to the breakpoint entry to re-enable it. |
| |
| [start=14] |
| . In the browser, click the 'add to cart' button for one of the listed products. |
| |
| [start=15] |
| . Switch to the IDE and note that the debugger is suspended on the breakpoint set in the `ControllerServlet`. Click the Step Over ( image::images/step-over-btn.png[] ) button so that the `session` variable is assigned to the session object. |
| |
| [start=16] |
| . Open the Variables window (Alt-Shift-1; Ctrl-Shift-1 on Mac) and expand session > session. You'll find the session ID listed as the value for the `id` variable. |
| |
| [start=17] |
| . To locate the `JSESSIONID` cookie, recall that you can normally access cookies from a servlet by calling the link:http://java.sun.com/webservices/docs/1.6/api/javax/servlet/http/HttpServletRequest.html#getCookies%28%29[+`getCookies`+] method on the `HttpServletRequest`. Therefore, drill into the request object: request > Inherited > request > request > Inherited > cookies. Here you see the `cookies` ArrayList. If you expand the list, you'll find the `JSESSIONID` cookie, the value of which is the session ID. |
| |
| [start=18] |
| . Click the Finish Session ( image::images/finish-session-btn.png[] ) button to terminate the debug session. |
| |
| |
| [[url-rewrite]] |
| === Maintaining Sessions with URL Rewriting |
| |
| As mentioned, the servlet engine detects whether cookies are supported for the client browser, and if not, it switches to URL rewriting as a means of maintaining sessions. This all happens transparently for the client. For you, the developer, the process isn't entirely transparent. |
| |
| You need to ensure that the application is capable of rewriting URLs whenever cookies are disabled. You do this by calling the response’s `encodeURL` method on all URLs returned by servlets in your application. Doing so enables the session ID to be appended to the URL in the event that the use of cookies is not an option; otherwise, it returns the URL unchanged. |
| |
| For example, the browser sends a request for `AffableBean`'s third category (bakery): `category?3`. The server responds with session ID included in the URL: |
| |
| |
| [source,java] |
| ---- |
| |
| /AffableBean/category*;jsessionid=364b636d75d90a6e4d0085119990*?3 |
| ---- |
| |
| As stated above, _all URLs returned by your application's servlets must be encoded_. Keep in mind that JSP pages are compiled into servlets. How can you encode URLs in JSP pages? JSTL's link:http://java.sun.com/products/jsp/jstl/1.1/docs/tlddocs/c/url.html[+`<c:url>`+] tag serves this purpose. The following exercise demonstrates the problem and illustrates a solution. |
| |
| 1. Temporarily disable cookies in your browser. If you are using Firefox, you can choose Tools > Options (Firefox > Preferences on Mac). In the window that displays, select the Privacy tab, then under History, select 'Use custom settings for history' in the provided drop-down. Deselect the 'Accept cookies from sites' option. |
| image::images/firefox.png[title="Temporarily disable cookies in your browser"] |
| |
| [start=2] |
| . Run the `AffableBean` project. When the welcome page displays, click into a category, then try adding an item to your cart. You'll see that the application's functionality is severely compromised in its present state. |
| image::images/compromised.png[title="The application's functionality is compromised when the client doesn't accept cookies"] |
| As before, the server generates a session and binds objects to it. This is how the category page is able to display the selected category and products. However, the server has failed in its attempt to set a `JSESSIONID` cookie. Therefore, when the client makes a second request (when user clicks 'add to cart'), the server has no way of identifying the session which the request belongs to. It therefore cannot locate any of the attributes previously set in the session, such as `selectedCategory` and `categoryProducts`. This why the rendered response lacks the information specified by these attributes. |
| |
| [start=3] |
| . Open the project's `category.jsp` page in the editor. Locate the line that implements the 'add to cart' button (line 58). The `<form>` element's `action` attribute determines the request sent to the server. |
| |
| [source,java] |
| ---- |
| |
| <form action="addToCart" method="post"> |
| ---- |
| |
| [start=4] |
| . Modify the request so that it is passed through the `<c:url>` tag. |
| |
| [source,java] |
| ---- |
| |
| <form action="*<c:url value='addToCart'/>*" method="post"> |
| ---- |
| |
| [start=5] |
| . Press Ctrl-S (⌘-S on Mac) to save changes to the file. Recall that the IDE provides the Deploy on Save feature, which is enabled by default. This means that any saved changes are automatically deployed to your server. |
| |
| [start=6] |
| . In the browser, select a different category so that the application renders the newly modified category page. |
| |
| [start=7] |
| . Examine the source code for the page. In Firefox, you can press Ctrl-U (⌘-U on Mac). The 'add to cart' button for each product displays with the session ID appended to the URL. |
| |
| [source,java] |
| ---- |
| |
| <form action="addToCart*;jsessionid=4188657e21d72f364e0782136dde*" method="post"> |
| ---- |
| |
| [start=8] |
| . Click the 'add to cart' button for any item. You see that the server is now able to determine the session which the request belongs to, and renders the response appropriately. |
| |
| [start=9] |
| . Before proceeding, make sure to re-enable cookies for your browser. |
| |
| Again, every link that a user is able to click on within the application, whose response requires some form of session-related data, needs to be properly encoded. Sometimes implementation is not as straight-forward as the example shown above. For example, the 'clear cart' widget used in `cart.jsp` currently sets a `clear` parameter to `true` when the link is clicked. |
| |
| |
| [source,xml] |
| ---- |
| |
| <%-- clear cart widget --%> |
| <c:if test="${!empty cart && cart.numberOfItems != 0}"> |
| <a href="viewCart*?clear=true*" class="bubble hMargin">clear cart</a> |
| </c:if> |
| ---- |
| |
| The `<c:url>` tag can be applied to the URL in the following manner: |
| |
| |
| [source,xml] |
| ---- |
| |
| <%-- clear cart widget --%> |
| <c:if test="${!empty cart && cart.numberOfItems != 0}"> |
| |
| *<c:url var="url" value="viewCart"> |
| <c:param name="clear" value="true"/> |
| </c:url>* |
| |
| <a href="*${url}*" class="bubble hMargin">clear cart</a> |
| </c:if> |
| ---- |
| |
| The `clear=true` parameter is set by adding a `<c:param` tag between the `<c:url>` tags. A variable named '`url`' is set using <c:url>'s `var` attribute, and `var` is then accessed in the HTML anchor tag using the `${url}` expression. |
| |
| You can download and examine link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fecommerce%252FAffableBean_snapshot6.zip[+snapshot 6+] to see how all links in the project have been encoded. |
| |
| URL rewriting should only be used in the event that cookies are not an available tracking method. URL rewriting is generally considered a suboptimal solution because it exposes the session ID in logs, bookmarks, referer headers, and cached HTML, in addition to the browser's address bar. It also requires more server-side resources, as the server needs to perform additional steps for each incoming request in order to extract the session ID from the URL and pair it with an existing session. |
| |
| |
| |
| [[time-out]] |
| == Handling Session Time-Outs |
| |
| * <<time-interval,Setting Session Time Intervals>> |
| * <<programmatically,Programmatically Handling Session Time-Outs>> |
| |
| |
| [[time-interval]] |
| === Setting Session Time Intervals |
| |
| You should consider the maximum time interval which your server maintains sessions for. If your website receives heavy traffic, a large number of sessions could expend your server's memory capacity. You might therefore shorten the interval in hopes of removing unused sessions. On the other hand, you certainly wouldn't want to cut sessions too short, as this could become a usability issue that might have a negative impact on the business behind the website. Taking the `AffableBean` application as an example, a user proceeds to checkout after filling her shopping cart with items. She then realizes she needs to enter her credit card details and goes off to find her purse. After returning to her computer with credit card in hand, she fills in the checkout form and clicks submit. During this time however, her session has expired on the server. The user sees that her shopping cart is empty and is redirected to the homepage. Will she really take the time to step through the process again? |
| |
| The following steps demonstrate how to set the session time-out interval in the `AffableBean` project to 10 minutes. Of course, the actual duration ultimately depends on your server resources, the business objectives of the application, and the popularity of your website. |
| |
| 1. Open the application's deployment descriptor in the editor. Press Alt-Shift-O (Ctrl-Shift-O on Mac) to use the IDE's Go to File dialog. Type in '`web`', then click OK. |
| image::images/go-to-file.png[title="The Go to File dialog enables quick navigation to project files"] |
| The editor displays the `web.xml` file in the XML view. The template that NetBeans provides for the `web.xml` file includes a default setting for 30 minutes. |
| |
| [source,xml] |
| ---- |
| |
| <session-config> |
| <session-timeout> |
| 30 |
| </session-timeout> |
| </session-config> |
| ---- |
| |
| [start=2] |
| . Click the General tab, and type in '`10`' in the Session Timeout field. |
| image::images/session-timeout.png[title="Specify session time-out for the application under the web.xml's General tab"] |
| |
| [start=3] |
| . Save the file (Ctrl-S; ⌘-S on Mac). |
| |
| If you switch back to the XML view, you'll see that the `<session-timeout>` element has been updated. |
| |
| [source,xml] |
| ---- |
| |
| <session-config> |
| <session-timeout>10</session-timeout> |
| </session-config> |
| ---- |
| |
| *Note:* Alternatively, you could remove the `<session-timeout>` element altogether, and edit the `session-properties` element in the GlassFish-specific deployment descriptor (`sun-web.xml`). This would set the global time-out for all applications in the server's web module. See the link:http://docs.sun.com/app/docs/doc/821-1752/beaha[+Oracle GlassFish Server 3.0.1 Application Development Guide: Creating and Managing Sessions+] for more details. |
| |
| |
| [[programmatically]] |
| === Programmatically Handling Session Time-Outs |
| |
| If your application relies on sessions, you need to take measures to ensure that it can gracefully handle situations in which a request is received for a session that has timed out or cannot be identified. You can accomplish this in the `AffableBean` application by creating a simple filter that intercepts requests heading to the `ControllerServlet`. The filter checks if a session exists, and if not, it forwards the request to the site's welcome page. |
| |
| 1. Start by examining the problem that arises when a session times out midway through a user's visit to the site. Temporarily reset the session time-out interval to one minute. Open the web deployment descriptor (`web.xml`) and enter '`1`' between the `<session-timeout>` tags. |
| |
| [source,xml] |
| ---- |
| |
| <session-config> |
| <session-timeout>*1*</session-timeout> |
| </session-config> |
| ---- |
| |
| [start=2] |
| . Run the `AffableBean` project. In the browser, click into a category page, add several items to your cart, then click 'view cart'. |
| image::images/cart-page-session-intact.png[title="The cart page relies on a session object to display items in shopping cart"] |
| |
| [start=3] |
| . Wait at least one full minute. |
| |
| [start=4] |
| . Update the quantity for one of the items displayed in the cart page. (Any number between 1 and 99 is acceptable.) Click 'update'. The server returns an HTTP Status 500 message. |
| image::images/glassfish-error-report.png[title="NullPointerException occurs when request for expired session is received"] |
| |
| [start=5] |
| . Examine the GlassFish server log in the IDE. Open the Output window (Ctrl-4; ⌘-4 on Mac) and select the GlassFish Server tab. Scroll to the bottom of the log to examine the error's stack trace. |
| [.feature] |
| -- |
| image::images/gf-server-output.png[role="left", link="images/gf-server-output.png"] |
| -- |
| |
| The server log indicates that a `NullPointerException` occurred at line 184 in the `ControllerServlet`. The Output window forms a link to the line where the exception occurred. |
| |
| [start=6] |
| . Click the link. You navigate directly to line 184 in the `ControllerServlet`. Hovering your mouse over the error badge in the editor's left margin provides a tooltip describing the exception. |
| image::images/nullpointer-exception.png[title="Error badge and tooltip indicate the location and cause of the problem"] |
| Because the session had already expired before the request was received, the servlet engine was unable to associate the request with its corresponding session. It was therefore unable to locate the `cart` object (line 151). The exception finally occurred in line 184 when the engine attempted to call a method on a variable equating to `null`. |
| |
| Now that we've identified the problem, let's fix it by implementing a filter. |
| |
| [start=7] |
| . Click the New File ( image::images/new-file-btn.png[] ) button in the IDE's toolbar. (Alternatively, press Ctrl-N; ⌘-N on Mac.) |
| |
| [start=8] |
| . Select the *Web* category, then select *Filter* and click Next. |
| |
| [start=9] |
| . Name the filter `SessionTimeoutFilter`. Type `filter` into the Packages field so that the filter class is placed in a new package when created. |
| |
| [start=10] |
| . Click Next. Accept default settings and click Finish. A template for the `SessionTimeoutFilter` is generated and opens in the editor. |
| |
| *Note:* Currently, in NetBeans 6.9, it isn't possible to use the wizard to set a mapping to a servlet that isn't registered in the web deployment descriptor. (`ControllerServlet` was registered using the `@WebServlet` annotation.) We'll therefore modify the generated code in the next step. |
| |
| |
| [start=11] |
| . Modify the `@WebFilter` annotation signature so that it appears as follows. |
| |
| [source,java] |
| ---- |
| |
| @WebFilter(*servletNames = {"Controller"}*) |
| public class SessionTimeoutFilter implements Filter { |
| ---- |
| This sets the filter to intercept any requests that are handled by the `ControllerServlet`. (Alternatively, you could have kept the `urlPatterns` attribute, and listed all patterns that the `ControllerServlet` handles.) |
| |
| Note that '`Controller`' is the name of the `ControllerServlet`, as specified in the servlet's `@WebServlet` annotation signature. Also note that you've removed the `filterName` attribute, since the name of the filter class is used by default. |
| |
| The IDE's filter template provides a lot of interesting code which is worth inspecting in its own right. However, most of it is not needed for our purposes here. Any filter class must implement the `Filter` interface, which defines three methods: |
| * *`init`:* performs any actions after the filter is initialized but before it is put into service |
| * *`destroy`:* removes the filter from service. This method can also be used to perform any cleanup operations. |
| * *`doFilter`:* used to perform operations for each request the filter intercepts |
| |
| Use the Javadoc Index Search to pull up documentation on the `Filter` interface. Press Shift-F1 (fn-Shift-F1 on Mac), then type '`Filter`' into the search field and hit Enter. Select the 'Interface in javax.servlet' entry. The Javadoc documentation displays in the lower pane of the index search tool. |
| |
| |
| [start=12] |
| . Replace the body of the `SessionTimeoutFilter` with the following contents. |
| |
| [source,java] |
| ---- |
| |
| @WebFilter(servletNames = {"Controller"}) |
| public class SessionTimeoutFilter implements Filter { |
| |
| *public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) |
| throws IOException, ServletException { |
| |
| HttpServletRequest req = (HttpServletRequest) request; |
| |
| HttpSession session = req.getSession(false); |
| |
| // if session doesn't exist, forward user to welcome page |
| if (session == null) { |
| try { |
| req.getRequestDispatcher("/index.jsp").forward(request, response); |
| } catch (Exception ex) { |
| ex.printStackTrace(); |
| } |
| return; |
| } |
| |
| chain.doFilter(request, response); |
| } |
| |
| public void init(FilterConfig filterConfig) throws ServletException {} |
| |
| public void destroy() {}* |
| |
| } |
| ---- |
| |
| [start=13] |
| . Press Ctrl-Shift-I (⌘-Shift-I on Mac) to fix import statements. (Imports need to be added for `HttpServletRequest` and `HttpSession`.) Also, use the editor hints to add the `@Override` annotation to the `init`, `destroy`, and `doFilter` methods. |
| |
| In the coming steps, you run the debugger on the project and step through the `doFilter` method to see how it determines whether the request is bound to an existing session. |
| |
| [start=14] |
| . Open the Breakpoints window (Alt-Shift-5; Ctrl-Shift-5 on Mac) and ensure that you do not have any existing breakpoints set. To delete a breakpoint, right-click the breakpoint and choose Delete. (If you completed the above exercise, <<http-monitor,Examining Client-Server Communication with the HTTP Monitor>>, you may have an outstanding breakpoint set in the `ControllerServlet`.) |
| |
| [start=15] |
| . Run the debugger. Click the Debug Project ( image::images/debug-project-btn.png[] ) button in the IDE's main toolbar. |
| |
| [start=16] |
| . When the welcome page displays in the browser, select a category, then add several items to your shopping cart. |
| |
| [start=17] |
| . Set a breakpoint on the line in `SessionTimeoutFilter`'s `doFilter` method that tries to access the session (line 32). |
| image::images/filter-breakpoint.png[title="Set a breakpoint on the getSession method"] |
| |
| [start=18] |
| . In the browser, click the 'view cart' button. Switch to the IDE and note that the debugger has suspended on the breakpoint. |
| |
| Recall that `getSession()` creates a new session object if the current one doesn't exist. Here, we use `getSession(false)`, which refrains from creating a new object if none is found. In other words, the method returns `null` if the session doesn't exist. |
| |
| [start=19] |
| . Click the Step Over ( image::images/step-over-btn.png[] ) button, then hover your mouse over the `session` variable. Provided that a minute hasn't passed since the previous request was sent, you'll see that the variable has been assigned to a `StandardSessionFacade`. This represents the session object for the request. |
| image::images/session-exists.png[title="Hover your mouse over variables to determine their current value"] |
| |
| [start=20] |
| . Continue stepping through the method until the request is processed. Since `session` doesn't equal `null`, you skip the `if` statement and `chain.doFilter` then forwards the request to the `ControllerServlet` (line 44). |
| |
| [start=21] |
| . In the browser, make sure a full minute has passed, then update a quantity for one of the product items in your cart. This is the same procedure we went through earlier in the exercise when the status 500 message was returned. Now that the filter intercepts requests heading to the `ControllerServlet`, let's see what happens when a session time-out occurs. |
| |
| [start=22] |
| . After clicking 'update', switch to the IDE and note that the debugger is again suspended on the breakpoint set in the filter. |
| |
| [start=23] |
| . Highlight the `req.getSession(false)` expression, then hover your mouse over it. Here you see the expression equates to `null`, as the session has already expired. |
| image::images/session-null.png[title="Highlight expressions and hover your mouse over them to determine their current value"] |
| |
| [start=24] |
| . Continue stepping through the code. Now that the `session` variable equals `null`, the `if` statement on line 35 is processed, and the request is forwarded to `/index.jsp`. When the debugger finishes executing, you'll see that the browser displays the site's welcome page. |
| |
| [start=25] |
| . Click the Finish Session ( image::images/finish-session-btn.png[] ) button to terminate the debug session. |
| |
| [start=26] |
| . Open the project's `web.xml` file and change the session time-out interval back to 10 minutes. |
| |
| [source,xml] |
| ---- |
| |
| <session-config> |
| <session-timeout>*10*</session-timeout> |
| </session-config> |
| ---- |
| |
| [start=27] |
| . Save (Ctrl-S; ⌘-S on Mac) the file. |
| |
| link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fecommerce%252FAffableBean_snapshot6.zip[+Snapshot 6+] provides you with the completed project version for this tutorial unit. One final topic concerning session management should be mentioned. You can explicitly terminate a session by calling the `invalidate` method on the session object. If the session is no longer needed, it should be removed in order to conserve the memory available to your server. After you complete the next unit, link:transaction.html[+Integrating Transactional Business Logic+], you will see how the `ControllerServlet`, upon successfully processing a customer order, destroys the user's `cart` object and terminates the session using the `invalidate` method. |
| |
| |
| [source,java] |
| ---- |
| |
| // if order processed successfully send user to confirmation page |
| if (orderId != 0) { |
| |
| // dissociate shopping cart from session |
| cart = null; |
| |
| // end session |
| session.invalidate(); |
| |
| ... |
| } |
| ---- |
| |
| This is demonstrated in link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fecommerce%252FAffableBean_snapshot8.zip[+project snapshot 8+] (and later snapshots). |
| |
| link:/about/contact_form.html?to=3&subject=Feedback: NetBeans E-commerce Tutorial - Managing Sessions[+Send Us Your Feedback+] |
| |
| |
| |
| [[seeAlso]] |
| == See Also |
| |
| |
| === NetBeans Resources |
| |
| * link:../../../../features/java/debugger.html[+NetBeans IDE Features: Debugger+] |
| * link:../../java/debug-multithreaded.html[+Debugging Multithreaded Applications+] |
| * link:../../java/debug-multithreaded-screencast.html[+Video of the Multithreaded Debugging with the NetBeans IDE+] |
| * link:../../java/debug-evaluator-screencast.html[+Video of Using the Code Snippet Evaluator in the NetBeans Debugger+] |
| * link:../../../../community/media.html[+Video Tutorials and Demos for NetBeans IDE+] |
| * link:https://netbeans.org/projects/www/downloads/download/shortcuts.pdf[+Keyboard Shortcuts & Code Templates Card+] |
| * link:../javaee-gettingstarted.html[+Getting Started with Java EE Applications+] |
| * link:../javaee-intro.html[+Introduction to Java EE Technology+] |
| * link:../../../trails/java-ee.html[+Java EE & Java Web Learning Trail+] |
| |
| |
| === GlassFish Resources |
| |
| * link:http://wiki.glassfish.java.net/Wiki.jsp?page=Screencasts[+GlassFish Screencasts+] |
| * link:http://glassfish.dev.java.net/docs/index.html[+GlassFish v3 Documentation+] |
| * link:http://www.sun.com/offers/details/GlassFish_Tomcat.html[+Learning GlassFish for Tomcat Users+] |
| * link:http://docs.sun.com/app/docs/doc/821-1751[+Oracle GlassFish Server 3.0.1 Administration Guide+] |
| * link:http://docs.sun.com/app/docs/doc/821-1750[+Oracle GlassFish Server 3.0.1 Application Deployment Guide+] |
| * link:http://docs.sun.com/app/docs/doc/821-1752[+Oracle GlassFish Server 3.0.1 Application Development Guide+] |
| |
| |
| === Technical Articles & Miscellaneous Resources |
| |
| * link:http://java.sun.com/javaee/reference/code/[+Java EE Code Samples & Apps+] |
| * link:http://java.sun.com/j2se/javadoc/[+Javadoc Tool+] [product homepage] |
| * link:http://java.sun.com/j2se/javadoc/writingdoccomments/index.html[+How to Write Doc Comments for the Javadoc Tool+] |
| * link:http://java.sun.com/products/servlet/Filters.html[+The Essentials of Filters+] |
| * link:http://java.sun.com/blueprints/corej2eepatterns/Patterns/InterceptingFilter.html[+Core J2EE Patterns - Intercepting Filter+] |
| * link:http://courses.coreservlets.com/Course-Materials/csajsp2.html[+Beginning and Intermediate-Level Servlet, JSP, and JDBC Tutorials+] |
| * link:http://courses.coreservlets.com/Course-Materials/msajsp.html[+Advanced Servlet and JSP Tutorials+] |
| * link:http://courses.coreservlets.com/Course-Materials/java5.html[+Java 5 & Java 6 Tutorials+] |
| * link:http://www.ibm.com/developerworks/java/library/j-jstl0211.html[+A JSTL primer, Part 1: The expression language+] |
| * link:http://www.ibm.com/developerworks/java/library/j-jstl0318/index.html[+A JSTL primer, Part 2: Getting down to the core+] |
