Java EE 7 SDK

Samples Main Page

# The Programmatic Configuration of HTTP Session Cookies Servlet Sample Application

This sample application demonstrates the programmatic configuration support for session cookies available in servlets.

## Description

This sample application declares a `ServletContextListener` in its deployment descriptor. This `ServletContextListener` configures, via the `SessionCookieConfig` interface, various aspects of the application's cookies used for HTTP session tracking purposes. This application has cookies enabled.

The client accesses the `CreateSession` servlet of the application, which creates an HTTP session, retrieves the value of the corresponding `Set-Cookie` header from the response, and ensures that it matches the configuration that was applied by the `ServletContextListener` during the application's initialization phase.

## Key Features

This sample application demonstrates how to use the `SessionCookieConfig` interface in a `ServletContextListener` to configure cookies for web applications.

## Building, Deploying, and Running the Application

Perform the following steps to build, deploy, and run the application:

1. Set up your build environment and configure the application server with which the build system has to work by following the common build instructions.
2. `app_dir` is the sample application base directory: `samples_install_dir/servlet/session-cookie-config-war`.
3. ````Change directory to `app_dir.
   `
4. Build, deploy, the sample application using the `mvn` target:

   Use the command below to run this sample using the Cargo framework:

   `app_dir> mvn clean verify cargo:run`

   You can point Cargo to an already installed and running Glassfish server:

   `app_dir> mvn clean verify cargo:run -Dglassfish.home=$<glassfish_dir>` (e.g. ../glassfish4)

   You can also build, deploy the sample application without Cargo:

   `app_dir> mvn install`

   `app_dir> asadmin deploy ./target/<app_name>.war`

5. Test the application as follows:
   - Use the browser to access
     `http://<javaee.server.name>:<javaee.server.port>/session-cookie-config-war`
     The following output is expected in the browser:
     `SUCCESS`
6. Use the glassfish command line to undeploy the application.

   `app_dir> asadmin undeploy` <app_name>

7. Use the target `clean` to remove the temporary directories like /target.

   `app_dir> mvn clean`

## Building, Deploying, and Running the Application in NetBeans IDE

Perform the following steps to build, deploy, and run the application using NetBeans IDE:

1. Refer to the common build instructions for setting up NetBeans IDE and Java EE 7 SDK.
2. In the NetBeans IDE, choose File → Open Project (Ctrl-Shift-O), navigate to the `samples_install_dir/servlet/` directory, select `session-cookie-config-war`, and click Open Project.
3. In the Projects tab, right click `session-cookie-config-war` and select Run to build, deploy, and run the project.

## Troubleshooting

If you have problems when running the application, refer the troubleshooting document.

Copyright © 1997-2013 Oracle and/or its affiliates. All rights reserved.