A Servlet’s Job Read explicit data sent by client (form data) Read implicit data sent by client (request headers) Generate the results Send the explicit

Java Servlet BasicsA Servlet’s Job• Read explicit data sent by client (form data)• Read implicit data sent by client (request headers)• Generate the results• Send the explicit data back to client (HTML)• Send the implicit data to client(status codes and response headers)

Java Servlet BasicsA Servlet That Generates Plain Text (HelloWorld.java)

package testPackage; // Always use packages.

import java.io.IOException;import java.io.PrintWriter;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;

Java Servlet Basicspublic class HelloWorld extends HttpServlet {

public void doGet(HttpServletRequest request,HttpServletResponse response)

throws ServletException, IOException {PrintWriter out = response.getWriter();out.println("Hello World");}}

Java Servlet BasicsdoGet– Code for an HTTP GET request. doPost also common.

• HttpServletRequest– Contains anything that comes from the browser

• HttpServletResponse– Used to send stuff to the browser. Most common is getWriter for a PrintWriter that points at browser.

Java Servlet BasicsA Servlet That Generates HTML

• Tell the browser that you’re sending it HTML– response.setContentType("text/html");

• Modify the println statements to build a legal Web page

– Print statements should output HTML tags

Java Servlet BasicsA Servlet That Generates HTML(Code)

public class TestServlet extends HttpServlet {public void doPost(HttpServletRequest request,

HttpServletResponse response)throws ServletException, IOException {

response.setContentType("text/html");PrintWriter out = response.getWriter();

Java Servlet Basicsout.println("<!DOCTYPE html>\n" +"<html>\n" +"<head><title>A Test Servlet</title></head>\n" +"<body bgcolor=\"#fdf5e6\">\n" +"<h1>Test</h1>\n" +"<p>Simple servlet for testing.</p>\n" +"</body></html>");} }

Java Servlet Basics

public class TestServlet2 extends HttpServlet {

public void doPost(HttpServletRequest request,HttpServletResponse response)

throws ServletException, IOException {response.setContentType("text/html");PrintWriter out = response.getWriter();String title = "Test Servlet with Utilities";

Java Servlet Basicsout.println(ServletUtilities.headWithTitle(title) +"<body bgcolor=\"#fdf5e6\">\n" +"<h1>" + title + "</h1>\n" +"<p>Simple servlet for testing.</p>\n" +"</body></html>");}}

Java Servlet BasicsThe Servlet Life Cycle• init– Executed once when the servlet is first loaded. Not called for each request. • service– Called in a new thread by server for each request. Dispatches to doGet, doPost, etc. Do not override this method!• doGet, doPost (do override)– Handles GET, POST, etc. requests.– Override these to provide desired behavior.• destroy– Called when server deletes servlet instance. Not called after each request.

Java Servlet BasicsWhy You Should Not Override service• The service method does other things besides just calling doGet– You can add support for other services later by adding doPut, doTrace, etc.– You can add support for modification dates by adding a getLastModified method– The service method gives you automatic support for: • HEAD requests• OPTIONS requests• TRACE requests

Java Servlet BasicsDebugging Servlets• Use print statements; run server on desktop• Integrated debugger in IDE – Right-click in left margin in source to set breakpoint (NetBeans)– “Debug” menu in NetBeans• Look at the HTML source• Return error pages to the client– Plan ahead for missing or malformed data• Use the log file– log("message") or log("message", Throwable)• Separate the request and response data.– Request: see EchoServer at www.coreservlets.com– Response: see WebClient at www.coreservlets.com• Make sure browser is not caching– Internet Explorer: use Shift + F5– Firefox & Chrome: use Control + F5• Stop and restart the server

Java Servlet BasicsThe Role of Form Data• Example URL at online travel agent– http://host/path?user=Marty+Hall&origin=bwi&dest=lax– Names come from HTML author; values from end user• Parsing form (query) data in traditional CGI– Read the data one way (QUERY_STRING) for GET requests, another way (standard input) for POST requests– Chop pairs at ampersands, then separate parameter names (left of the =) from parameter values (right of the =)– URL decode values (e.g., "%7E" becomes "~")• Greatly simplified in servlets– Use request.getParameter in all cases. – Gives URL-decoded result

Java Servlet BasicsCreating Form Data: HTML Forms<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML><HEAD><TITLE>A Sample Form Using GET</TITLE></HEAD><BODY BGCOLOR="#FDF5E6"><H2 ALIGN="CENTER">A Sample Form Using GET</H2><FORM ACTION="http://localhost:8088/SomeProgram"><CENTER>First name:<INPUT TYPE="TEXT" NAME="firstName" VALUE="J. Random"><BR>Last name:<INPUT TYPE="TEXT" NAME="lastName" VALUE="Hacker"><P><INPUT TYPE="SUBMIT"> </CENTER></FORM></BODY></HTML>

Java Servlet BasicsSending POST Data<!DOCTYPE ... ><HTML><HEAD><TITLE>A Sample Form Using POST</TITLE></HEAD><BODY BGCOLOR="#FDF5E6"><H2 ALIGN="CENTER">A Sample Form Using POST</H2><FORM ACTION="http://localhost:8088/SomeProgram"METHOD="POST"><CENTER>First name:<INPUT TYPE="TEXT" NAME="firstName" VALUE="J. Random"><BR>Last name:<INPUT TYPE="TEXT" NAME="lastName" VALUE="Hacker"><P><INPUT TYPE="SUBMIT"></CENTER></FORM></BODY></HTML>

Java Servlet BasicsGET vs. POST• Advantages of POST– URL is simpler– Data is hidden from people looking over your shoulder– Larger amounts of data can be sent– Can send special characters (e.g., in uploaded files)– Browsers will not cache results– Should always be used if the requests changes data on server • Advantages of GET– Can bookmark results page– Browsers can cache results– Easier to test interactively

Java Servlet BasicsReading Form Data In Servlets• request.getParameter("name")– Returns URL-decoded value of first occurrence of name in query string– Works identically for GET and POST requests– Returns null if no such parameter is in query data• request.getParameterValues("name")– Returns an array of the URL-decoded values of alloccurrences of name in query string– Returns a one-element array if param not repeated– Returns null if no such parameter is in query

Java Servlet BasicsAn HTML Form With Three Parameters<FORM ACTION="three-params">First Parameter: <INPUT TYPE="TEXT" NAME="param1"><BR />Second Parameter: <INPUT TYPE="TEXT" NAME="param2"><BR />Third Parameter: <INPUT TYPE="TEXT" NAME="param3"><BR /><CENTER><INPUT TYPE="SUBMIT"></CENTER></FORM>

Java Servlet Basicspublic class ThreeParams extends HttpServlet {

public void doGet(HttpServletRequest request,

HttpServletResponse response)throws ServletException, IOException {

…out.println(docType +"<HTML>\n" +"<HEAD><TITLE>"+title + "</TITLE></HEAD>\n" +"<BODY BGCOLOR=\"#FDF5E6\">\n" +"<H1 ALIGN=\"CENTER\">" + title + "</H1>\n" +"<UL>\n" +" <LI><B>param1</B>: "+ request.getParameter("param1") + "\n" +" <LI><B>param2</B>: "+ request.getParameter("param2") + "\n" +" <LI><B>param3</B>: "+ request.getParameter("param3") + "\n" +"</UL>\n" +"</BODY></HTML>");}}

Java Servlet BasicsReading All Parameters

public class ShowParameters extends HttpServlet {

public void doGet(HttpServletRequest request,HttpServletResponse response)throws ServletException, IOException {

response.setContentType("text/html");

PrintWriter out = response.getWriter();

String docType ="<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 " +"Transitional//EN\">\n";

Java Servlet BasicsString title = "Reading All Request Parameters";out.println(docType +"<html>\n" +"<head><title>"+title + "</title></head>\n"+"<body bgcolor=\"#FDF5E6\">\n" +"<h1 align=center>" + title + "</h1>\n" +"<table border=1 align=center>\n" +"<tr bgcolor=\"#FFAD00\">\n" +"<th>Parameter Name</th><th>Parameter Value(s)“</th></tr>);

Java Servlet BasicsEnumeration<String> paramNames = request.getParameterNames();

while(paramNames.hasMoreElements()) {String paramName = (String)paramNames.nextElement();out.print("<tr><td>" + paramName + "\n</td><td>");String[] paramValues =request.getParameterValues(paramName);if (paramValues.length == 1) {String paramValue = paramValues[0];if (paramValue.length() == 0)out.println("<i>No Value</i>");elseout.println(paramValue);} else {out.println("<ul>");

Java Servlet Basicsfor(int i=0; i<paramValues.length; i++) {out.println("<li>" + paramValues[i] + “</li>”);}out.println("</ul>");}out,.println(“</td></tr>”);}out.println("</table>\n</body></html>");

Java Servlet Basicspublic void doPost(HttpServletRequest request,HttpServletResponse response)throws ServletException, IOException {doGet(request, response);} }

Java Servlet BasicsChecking for Missing and Malformed Data• Missing– Field missing in form• getParameter returns null– Field blank when form submitted• getParameter returns an empty string (or possibly a string with whitespace in it)– Must check for null before checking for empty stringString param = request.getParameter("someName");if ((param == null) || (param.trim().equals(""))) {doSomethingForMissingValues(...);} else {doSomethingWithParameter(param);}

Java Servlet Basics • Malformed – Value is a nonempty string in the wrong formatPrinciples– Assume user data could be missing or in wrong format– Users should never see Java error messages• Only error messages you create, aimed at end users

Java Servlet BasicsUse default values– Replace missing values with application-specific standard values

Java Servlet Basics• Redisplay the form– Show the form again, with missing values flagged– Previously-entered values should be preserved– Best option for implementing this: use framework like JSF or Struts

Java Servlet Basics– Four options to implement this directly

• Have the same servlet present the form, process the data, and present the results.

Have one servlet present the form; have a second servlet process the data and present the results.

• Have a JSP page present the form; have a servlet or JSP page process the data and present the results.

• Have a JSP page present the form, automatically filling in the fields with values obtained from a data object. Have a servlet or JSP page process the data and present the results.

Java Servlet Basics

Java Servlet Basics

Java Servlet Basics

Java Servlet Basics

Documents

A Servlet’s Job Read explicit data sent by client (form data) Read implicit data sent by client (request headers) Generate the results Send the explicit