Lab 4: Servlet Configuration and Session State

Preparing for the Project

If you have a GitHub account, email your username to Professor Sprenkle.

If you don't have a GitHub account, create an account and email your username to Professor Sprenkle.

Set up

• Create a new Dynamic Web Project called Lab4. When creating the project, don't just select Finish on the first panel. Click next twice to get to the Web Module configuration page. Select the checkbox for "Generate web.xml deployment descriptor".
• Copy your Login servlet and form from Lab 3 into this project. (Remember the appropriate locations for both of these files.) In general, you'll want to do such tasks within Eclipse, rather than "underneath" Eclipse, so that Eclipse can update various other data accordingly.
• Copy pet.html and SurveyServlet.java from their current location to the Lab4 project.
• Create an index.html page in your Lab4 project. Add links to the pet.html and login.html pages.

Adding init and destroy Methods (45 pts)

SurveyServlet is not implemented very efficiently. The file has to be read and written every time a vote is cast, i.e., every time a request comes in. We don't want that overhead because we expect this survey to be taken a lot! (Not really but...)

Add init and destroy methods to SurveyServlet. init will read the file and initialize the votes. destroy will write the votes out to the file. More detailed instructions follow:

1. First, recall that you can use the "Refactor" and "Source" menus of Eclipse to quickly do trivial tasks.
2. In the SurveyServlet.java editor pane, right-click, select "Source" and then "Override/Implement Methods".
3. Under the GenericServlet class, select init and destroy, select where to put them (I put them below the constructor), and then click "OK". These method stubs will be automatically generated for you.
4. Move the variables surveyData, votesForAnimals, and totalVotes so that they are instance variables for the class rather than temporary variables for the doGet method.
5. Move the code that reads in the file into the init method. Keep the call to super.init() first. You will have to handle some compiler errors appropriately.
6. Move the code that writes the file into the destroy method. Make the call to super.destroy() last. You will have to handle some compiler errors appropriately.
7. Stop and restart your server.
8. Test your servlet several times.
9. Stop and restart your server.
10. Test again. It's using the updated data, right? Good!

Web Application Structure and Deployment

build Directory

Within a terminal (not within Eclipse), look at the contents of the build directory inside of your FirstServlets project. You should see the .class files for each of your servlets, within the classes/servlets (or whatever package name you used). The build directory and the contents of the WebContent directory are what are deployed on the server.

Eclipse Web Tools Platform (WTP)

Typically, web applications are put in Tomcat's webapps directory to be deployed. The Eclipse WTP handles putting your files in an appropriate location.

Within a terminal, if you go into your workspace, and then from there go into .metadata/.plugins/org.eclipse.wst.server.core/tmp0/wtpwebapps/Lab4, you should see your .html and .css files as well as a META-INF and WEB-INF directory.

Go into the WEB-INF directory. You should see a classes directory and a lib directory and, perhaps, a web.xml file. The classes directory contains the servlets you wrote. The lib directory contains any jar files that you imported for your applications (beyond the standard Java EE classes).

Configuration (20 pts)

Sometimes, you need to configure your servlets. For example, you want want to tell the servlet the location of a file or the parameters to a database or the email address of the administrator.

URL Mapping

1. Modify the LoginServlet such that its @WebServlet annotation for the URL mapping is /login instead of /LoginServlet
2. Modify the login form to send requests (its action) to login instead of LoginServlet
3. Test that the login functionality still works as expected.

Init Parameters

1. Modify the SurveyServlet to include an init parameter. The init parameter's name is surveyFile and the value is survey.dat.

   You can modify the web.xml file or add the annotations to SurveyServlet. To see examples of annotations, look at the slides or use Eclipse to create a new servlet and generate an example annotation for you. To create a web.xml file, you can right-click on the project, go to JavaEE Tools, and then select Generate Deployment Descriptor Stub

You modify web.xml from the Source or the Design view, which ever you are more comfortable with. In Design view, you can right click on the SurveyServlet's servlet element and select "Add Child" and add "init-param". If you expand init-param, you'll see the two elements that you need to fill in. Click on "Source" view to see the result. I want you to be very comfortable with XML files.

2. Modify SurveyServlet's init method to access the init parameter. (Look at the methods that SurveyServlet inherits from HttpServlet).
3. Stop and restart the server.
4. Test that the code still works correctly.
5. Stop the server. Modify the parameter so that the SurveyServlet's init parameter has a different file name, such as survey2.dat.
6. Restart the server and test your code. You should not get the data you had before: it should be all 0s, except for whatever you just voted for.

Using Sessions and Session Variables (25 pts)

Modify your Login servlet so that, if the user's name and password are correct, it starts a new HttpSession and stores an attribute with name authenticated and value a Boolean object that has a true value. (Note that this must be a Boolean object and not a boolean.)

Also set your session's maximum inactive interval to 60 seconds.

To test that your servlet is working correctly:

1. Copy this form and this image into an html file in your WebContent directory.
2. Update your index.html file to have a link to your authentication test.
3. Create a new servlet in the servlets package named AuthenticatedTest
4. Copy this code into the doGet method of the servlet you just created (AuthenticatedTest). Look at the code to understand what it is supposed to do. Handle compiler errors appropriately.
5. Restart your server.
6. Try clicking the button of the authenticate test form. You should see a message that says that you're not authenticated.
7. Login, using your login form copied from last lab.
8. Try clicking the button of the authenticate test form again. You should now see a message that you are authenticated.
9. Wait 60 seconds and test the authenticate test form again. You should no longer be authenticated because the session expired.

Turnin

Create a .war file from your Lab4 project and copy it into your turnin directory. Make sure to include the source code.

Grading (90 pts)

Due tonight at 11:59 p.m.

• SurveyServlet: init, destroy (45 pts)
• LoginServlet: URL mapping (5 pts)
• SurveyServlet: configuration parameter (15 pts)
• LoginServlet: sessions (25 pts)