Home > Articles

Getting Started with Servlets

Getting Started with Servlets

In This Chapter:

  • A "Hello World" Servlet

  • The Anatomy of a Servlet

  • Sending a Response to the Browser

  • The HttpServlet Class

  • Choosing Between Java Server Pages and Servlets

A "Hello World" Servlet

Servlets are a little more involved than Java Server Pages, but in simple cases they aren't too bad. Listing 3.1 shows you the "Hello World" program in servlet form.

Listing 3.1 Source Code for HelloWorldServlet.java

package usingjsp;
import javax.servlet.*;
import java.io.*;
public class HelloWorldServlet extends GenericServlet
 public void service(ServletRequest request,
  ServletResponse response)
  throws IOException 
// Tell the Web server that the response is HTML

// Get the PrintWriter for writing out the response
  PrintWriter out = response.getWriter();

// Write the HTML back to the browser
  out.println("<H1>Hello World!</H1>");

The HTML portion of the HelloWorldServlet is probably the most recognizable part. For the sake of completeness, the browser's view of the HelloWorldServlet is shown in Figure 3.1.

Figure 3.1 A servlet can generate HTML code.

Unlike Java Server Pages, servlets are pure Java classes. The good news is that you don't have to learn any additional syntax to create a servlet; the bad news is that you have to do a bit more work in your programs. As you can see from the "Hello World" servlet, the amount of work isn't really that great.

Compiling the Servlet

Before you compile the servlet, make sure the servlet classes are in your classpath. The location of the servlet classes varies depending on which servlet engine you are using, but typically they are in a file called servlet.jar. If you are using the Resin servlet engine, the servlet classes are in a file called jsdk22.jar (for version 2.2 of the Servlet API). The location of the jar file also varies depending on the servlet engine, but you usually find it in the lib direc-tory. Appendixes C-F in this book contain configuration information about several popular Web servers. If all else fails, consult the documentation for your servlet engine. In fact, you should probably consult the documentation first.

If you are having trouble compiling your servlet, see the "Troubleshooting" section at the end of this chapter.

Runtime Classpath

Unlike Java Server Pages, servlets must be in the servlet engine's classpath. When a Java Server Page runs, the JSP engine ensures that the servlet it generates is visible to the JSP engine. Unfortunately, you don't have the luxury of the JSP engine to help you out when you write servlets. Most servlet engines enable you to modify the classpath for the purpose of loading servlets, so you won't have to add all your servlet directories to the system classpath.

Listing 3.1 showed that you can put your servlet into a package. The name of the servlet becomes the fully qualified classname of the servlet. The URL used to load the servlet specifies the pathname for the servlet as /servlet/usingjsp.HelloWorldServlet (refer to Figure 3.1). Most servlet engines contain a special URL mapping for the /servlet directory, which signals that you want to run a servlet. When the Web server sees this special URL, it passes it on to the servlet engine. This /servlet directory usually picks up servlets from the classpath, so you can easily run any servlet that is in your system classpath just by appending the classname to /servlet/.


You almost always have to set up a specific URL pattern for running servlets (such as /servlet/) or you need to set up a full URL that points to a servlet. Unlike a JSP, a servlet doesn't have an extension on the end of its name to indicate what kind of a file it is.

If you are having trouble running your servlet, see the"Troubleshooting" section at the end of this chapter.

The HelloWorldServlet In-Depth

The first thing your servlet must do is implement the Servlet interface. There are two ways to do it: subclass from a class that implements the Servlet interface or implement the Servlet interface directly in the servlet. The HelloWorldServlet takes the easier approach by subclassing an existing class that implements Servlet. There are other classes that also implement the Servlet interface, and they will be discussed shortly.

When a request comes in for a particular servlet, the servlet engine loads the servlet (if it has not yet been loaded) and invokes the servlet's service method. The method takes two arguments: an object containing information about the request from the browser and an object containing information about the response going back to the browser.


Currently, most servlet engines don't automatically reload a servlet after it has been loaded. If you recompile a servlet, you usually need to restart the servlet engine to pick up the changes. This problem should slowly disappear over time as vendors create special class loaders to reload servlets when needed.

Next, the servlet must tell the Web browser what kind of content is being returned. Most of the time, you will be returning HTML content, so set the content type to text/html. As you will see in Chapter 24, "Creating an XML Application," you can also set the content type to text/xml and return XML data back to the browser. Earlier in this chapter, Listing 3.1 showed that you set the content type of the response by invoking setContentType in the response object.

After you have set the content type you are ready to start sending text back to the browser. Of course you need some sort of output object to send the text back. Again, the response object has the methods necessary to get an output stream for writing a response. Because the "Hello World" servlet is writing out text, it only needs a PrintWriter object, so it calls the getWriter method in the response object. If you need to send binary data back to the browser, you should use the getOutputStream method in the response object.

The final part of the "Hello World" servlet should be the most obvious, and if you paid attention in Chapter 2, "Getting Started with Java Server Pages," this part should be the most familiar. The "Hello World" servlet uses the println method in the PrintWriter to send HTML back to the browser. Remember, in Chapter 2 you saw a portion of the servlet code generated by the "Hello World" Java Server Page. Aside from some extra comments, that code is almost identical to the code at the end of the "Hello World" servlet. After all, Java Server Pages eventually become servlets and there are only so many ways to send output from a servlet, so why shouldn't they be similar?


InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020