Form-based Authentication Sample Application


This document describes how to use the Form-based Authentication sample application with Sun Java System Web Server.

This sample application document contains the following sections:

• Overview

• Compiling and Assembling the Sample Application

• Deploying the Sample Application

• Running the Sample Application

• Undeploying the Sample Application

• Troubleshooting

Overview

---

The following instructions describe how to manually deploy the application. You might want to experiment by modifying and redeploying the sample.

Precompilation Tasks

Complete these prerequisites before you begin to compile and deploy the code.

You must add user names in the keyfile. To do so, complete the following steps:

1. Log on to the Administration GUI.
2. Click the Configurations tab.
3. Select the correct configuration.
4. Click the Access Control tab.
5. Click the Users tab.
6. Select the correct Authentication Database. Make sure it's the keyfile database and pointing to the default keyfile.
7. Click the New button and enter the following information:
1. Enter j2ee for the User ID.
2. Enter secret for the Password.
3. Enter secret for the Password (Again).
8. Click OK.
9. Click the Groups tab.
10. Select the correct Authentication Database. Make sure it's the keyfile database and pointing to the default keyfile.
11. Click the New button and enter the following information:
1. Enter staff for the Group Name.
2. Click Search button.
3. Select the user j2ee.
12. Click OK.
13. Click Deploy.

Compiling and Assembling the Sample Application

---

To compile and assemble the form-based security web sample application:

Note - Make sure that the necessary parameters for running the samples are specified in install_root/samples/java/webapps/common.properties.

1. Set the keyfile.location property within the install_root/samples/java/webapps/security/auth.build.properties file.

   
   

   For example, keyfile.location=install_root/instance_name/config/keyfile
   

2. Change to install_root/samples/java/webapps/security/form-auth/src and execute the ant command.
   

    The default target default is executed to build the WAR file..
    

3. Deploy the application.

   After you have created the sample application from scratch, you can proceed to Deploying the Sample Application.
    

4. (Optional.) Clean the web application project area.

   # ant clean

Deploying the Sample Application

---

To deploy the form-based security sample application:

1. Change to the source directory at install_root/samples/java/webapps/security/form-auth/src.

   
    

2. Run ant using the deploy task:

   # ant deploy

If you want to verify the registration of the application, proceed to Verifying Deployment. Otherwise, proceed to Running the Sample Application.

Verifying Deployment

To verify the registration and deployment of the application, complete the following steps:

• Change to the source directory at install_root/samples/java/webapps/security/form-auth/src.
  
  
• Run the ant tool using the list_apps task.
  # ant list_apps
  
  The webapps-formbased-security module is listed as one of the components.

Running the Sample Application

---

You can run the application through the following URL:

http://Sun_Java_System_Web_Server_hostname:port/webapps-formbased-security

Log on as j2ee with password secret.

The message "You are Authenticated Successfully!" is displayed.

Undeploying the Sample Application

---

After successfully deploying and running the application, you might decide to undeploy it and remove the files. To undeploy the application, complete the following steps:

1. Change to the source directory at install_root/samples/java/webapps/security/form-auth/src.
   
2. Run the ant tool using the undeploy task.

   # ant undeploy

Troubleshooting

---

• Close all browser instances before you try to log in again; if you are using Netscape, you must also close the email session. Otherwise, session information from the previous logins will be picked up to grant access for you.

• While appending data to the keyfile, make sure that the user names entered are unique.

• If you encounter problems when running the application, review the log files at instance_root/logs/errors to determine what went wrong.

---

Company Info   |   Contact   |   Copyright 2007 Sun Microsystems, Inc.