As we learned in previous chapters, the Servlet life cycle will be managed by the Servlet container that is under the Web/Application server. Whenever an HttpRequest comes from the client browser, the servlet container will map the request to the corresponding servlet based on the URL mappings provided in the deployment descriptor file - web.xml. For example: Consider the below servlet mappings in the web.xml file.
XML
<servlet>
<servlet-name>HelloServlet</servlet-name>
<servlet-class>HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>HelloServlet</servlet-name>
<url-pattern>/hello</url-pattern>
</servlet-mapping>
Here, whenever there is a "/hello" URL coming from the client request, we are mapping it to the "HelloServlet" class. Instead of providing these mappings in the web.xml file, we can simply provide an annotation in the Servlet as below,
Java
@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
// Code to be executed...
}
Servlet Annotations
Java Servlets provides a number of annotations to allow users to declare servlets, filters, listeners in the javax.servlet.annotation package. It also provides annotations to specify metadata for the components that are declared.
Annotation Type WebServlet:
Java
public @interface WebServlet
- Available in javax.servlet.annotation package.
- Used to declare a Servlet.
- At the time of deployment, the servlet container will identify and process the annotation and makes the corresponding servlet available at the specified URL patterns.
Elements of @WebServlet Annotation:
Name
| Modifier and Type
| Description
| Default value
|
|---|
| asyncSupported | boolean | To specify whether the servlet supports asynchronous mode or not. | false |
| description | String | To provide a description of the servlet. | "" |
| displayName | String | To provide the Display name of the Servlet. | "" |
| initParams | WebInitParam[] | To specify initialization parameters of the servlet. | {} |
| name | String | To provide the name of the servlet. | "" |
| value | String[] | To specify the URL pattern of the servlet that is to be mapped. | {} |
| urlPatterns | String[] | To provide the URL patterns of the servlet that are to be mapped. | {} |
| smallIcon | String | To specify the small icon name of the servlet. | "" |
| loadOnStartup | int | To provide the load on the startup order of the servlet. | -1 |
| largeIcon | String | To specify the large icon name of the servlet. | "" |
The elements displayName, description, smallIcon and largeIcon are basically used by IDEs, tools or servlet containers. These do not affect the execution of the servlet.
Servlet with Annotation Examples
For better understanding, we will create a simple HTML page to map the Servlet with the URL.
Example 1:
Servlet annotated with only URL pattern:
index.html
HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="ISO-8859-1">
<title>Home</title>
</head>
<body>
<form action="hello" method="post">
Welcome Page: <input type="submit" />
</form>
</body>
</html>
Html page which maps the servlet with URL "/hello".
HelloServlet.java
Java
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println(
"<h3>Hello, Welcome to GeeksforGeeks!!</h3>");
out.close();
}
}
- When user clicks submit for the welcome page, container will process the "@WebServlet("/hello")" annotation and maps the "HelloServlet" class.
- As the method is mentioned as "post" in Html page, container will execute "doPost()" method in "HelloServlet" class.
Output:
- Run the project on the server to get the output.
- URL: http://localhost:8081/ServletFlow/index.html
You can see the URL mapping to the "HelloServlet" class and the output.
Example 2:
Servlet annotated with servlet information:
HelloServlet.java
Java
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(name = "Hello Servlet",
displayName = "Annotated Hello Servlet",
description
= "This is annotated servlet example.",
value = "/hello")
public class HelloServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println(
"<h3>Hello, Welcome to GeeksforGeeks!!</h3>");
out.println(
"<h4>Annotated servlet with elements - name, displayName, description and value</h4>");
out.close();
}
}
- To include the name of the servlet and any description related to the servlet, we can use annotated elements as shown above.
- The URL mapping can be specified using value element.
Output:
- Run the project and click on submit.
Example 3:
Servlet annotated with Initialization parameters:
HelloServlet.java
Java
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(
value = "/hello",
initParams
= { @WebInitParam(name = "name", value = "Geek")
, })
public class HelloServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// Get the initialized parameter value
String name = getInitParameter("name");
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println("<h3>Hello " + name
+ ", Welcome to GeeksforGeeks!!</h3>");
out.println(
"<h4>Annotated servlet with Initialization parameter.</h4>");
out.close();
}
}
- Here, we are specifying the parameter values using @WebInitParam annotation. We need to provide the parameter name which we want to initialize and the value to be set.
- While Servlet Initialization, container will process the @WebInitParam annotation inside the @WebServlet annotation and initializes the specified values.
- So, we are initializing the parameter "name" to value "Geek" and the same will written to the output in the response.
Output:
- Run the project and click on submit.
Example 4:
Servlet annotated with load-on-start up value and asynchronous support:
HelloServlet.java
Java
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(value = "/hello", loadOnStartup = 1,
asyncSupported = true)
public class HelloServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
public void init(ServletConfig config)
{
System.out.println(
"Hello Servlet has been initialized");
}
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println(
"<h3>Hello, Welcome to GeeksforGeeks!!</h3>");
out.println(
"<h4>Annotated servlet with load-on-start up value and asynchronous support.</h4>");
out.close();
}
}
- Generally, when the first request comes from the client, then servlet container will identify the corresponding servlet and it will load, instantiate and initialize the servlet.
- So, the response time for the first request to client is more when compared to the next client requests.
- If we specify the Load-on-startup value as 1, at the time of servlet deployment into the server itself, container will load, instantiate and initialize the servlet when the server is started.
- To specify this servlet can support asynchronous mode, set the element asyncSupported value as true.
Output:
- Run the project on the server.
- You can see the servlet is loaded, instantiated(init() method) and Initialized at the time of servlet deployment into the server.
- You can see the initialization message in the console at the time of server start and the servlet deployment.
- And the response will be generated in the browser as below.
Example 5:
Servlet annotated with multiple URL patterns:
index.html
HTML
<!DOCTYPE html>
<html>
<head>
<meta charset="ISO-8859-1">
<title>Home</title>
</head>
<body>
<form action="hello" method="post">
Click here for Welcome Page(using /hello URL): <input type="submit" />
</form>
<form action="welcome" method="get">
Click here for Welcome Page(using /welcome URL): <input type="submit" />
</form>
</body>
</html>
Include two form pages with different URL mapping.
HelloServlet.java
Java
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@WebServlet(urlPatterns = { "/welcome", "/hello" })
public class HelloServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println(
"<h3>Hello, Welcome to GeeksforGeeks!!</h3>");
out.println(
"<h4>Annotated servlet with multiple URLs inside Get method.</h4>");
out.close();
}
protected void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException
{
// set the response content type
response.setContentType("text/html");
PrintWriter out = response.getWriter();
// Print hello message to the client browser in
// response object
out.println(
"<h3>Hello, Welcome to GeeksforGeeks!!</h3>");
out.println(
"<h4>Annotated servlet with multiple URLs inside Post method.</h4>");
out.close();
}
}
- When the URL request comes to the servlet, whether it is "/hello" or "/welcome", both will be mapped to the same servlet.
- As specified in the HTML form, "/hello" action is with method "/post". so, container will execute "doPost()" method in the servlet and "/welcome" action is with method "/get". so, container will execute "doGet()" method in the servlet.
Output:
- When click on "/hello" submit button, container will execute "doPost()" method in the "HelloServlet" and below output will be generated with that URL.
- When click on "/welcome" submit button, container will execute "doGet()" method in the "HelloServlet" and below output will be generated with that URL.
- You can see the difference between the URL based on the action which we are calling the corresponding servlet.
- As we included multiple URLs in the Servlet, the container is able to map the request coming from both "/hello" and "/welcome" to the "HelloServlet" and generate the response.
Conclusion
This way we can use different annotations available in javax.servlet.annotation package to declare and set the metadata of the Java Servlets inside the servlet itself instead of using web.xml file based on our project requirement.
Similar Reads
Java Tutorial Java is a high-level, object-oriented programming language used to build web apps, mobile applications, and enterprise software systems. Known for its Write Once, Run Anywhere capability, which means code written in Java can run on any device that supports the Java Virtual Machine (JVM).Syntax and s
10 min read
Basics
Introduction to JavaJava is a high-level, object-oriented programming language developed by Sun Microsystems in 1995. It is platform-independent, which means we can write code once and run it anywhere using the Java Virtual Machine (JVM). Java is mostly used for building desktop applications, web applications, Android
4 min read
Java Programming BasicsJava is one of the most popular and widely used programming language and platform. A platform is an environment that helps to develop and run programs written in any programming language. Java is fast, reliable and secure. From desktop to web applications, scientific supercomputers to gaming console
4 min read
Java MethodsJava Methods are blocks of code that perform a specific task. A method allows us to reuse code, improving both efficiency and organization. All methods in Java must belong to a class. Methods are similar to functions and expose the behavior of objects.Example: Java program to demonstrate how to crea
7 min read
Access Modifiers in JavaIn Java, access modifiers are essential tools that define how the members of a class, like variables, methods, and even the class itself, can be accessed from other parts of our program. They are an important part of building secure and modular code when designing large applications. In this article
6 min read
Arrays in JavaIn Java, an array is an important linear data structure that allows us to store multiple values of the same type. Arrays in Java are objects, like all other objects in Java, arrays implicitly inherit from the java.lang.Object class. This allows you to invoke methods defined in Object (such as toStri
9 min read
Java StringsIn Java, a String is the type of object that can store a sequence of characters enclosed by double quotes and every character is stored in 16 bits, i.e., using UTF 16-bit encoding. A string acts the same as an array of characters. Java provides a robust and flexible API for handling strings, allowin
8 min read
Regular Expressions in JavaIn Java, Regular Expressions or Regex (in short) in Java is an API for defining String patterns that can be used for searching, manipulating, and editing a string in Java. Email validation and passwords are a few areas of strings where Regex is widely used to define the constraints. Regular Expressi
7 min read
OOPs & Interfaces
Classes and Objects in JavaIn Java, classes and objects are basic concepts of Object Oriented Programming (OOPs) that are used to represent real-world concepts and entities. A class is a template to create objects having similar properties and behavior, or in other words, we can say that a class is a blueprint for objects.An
10 min read
Java ConstructorsIn Java, constructors play an important role in object creation. A constructor is a special block of code that is called when an object is created. Its main job is to initialize the object, to set up its internal state, or to assign default values to its attributes. This process happens automaticall
10 min read
Java OOP(Object Oriented Programming) ConceptsBefore Object-Oriented Programming (OOPs), most programs used a procedural approach, where the focus was on writing step-by-step functions. This made it harder to manage and reuse code in large applications.To overcome these limitations, Object-Oriented Programming was introduced. Java is built arou
10 min read
Java PackagesPackages in Java are a mechanism that encapsulates a group of classes, sub-packages and interfaces. Packages are used for: Prevent naming conflicts by allowing classes with the same name to exist in different packages, like college.staff.cse.Employee and college.staff.ee.Employee.They make it easier
8 min read
Java InterfaceAn Interface in Java programming language is defined as an abstract type used to specify the behaviour of a class. An interface in Java is a blueprint of a behaviour. A Java interface contains static constants and abstract methods. Key Properties of Interface:The interface in Java is a mechanism to
11 min read
Collections
Exception Handling
Java Exception HandlingException handling in Java is an effective mechanism for managing runtime errors to ensure the application's regular flow is maintained. Some Common examples of exceptions include ClassNotFoundException, IOException, SQLException, RemoteException, etc. By handling these exceptions, Java enables deve
8 min read
Java Try Catch BlockA try-catch block in Java is a mechanism to handle exceptions. This make sure that the application continues to run even if an error occurs. The code inside the try block is executed, and if any exception occurs, it is then caught by the catch block.Example: Here, we are going to handle the Arithmet
4 min read
Java final, finally and finalizeIn Java, the keywords "final", "finally" and "finalize" have distinct roles. final enforces immutability and prevents changes to variables, methods or classes. finally ensures a block of code runs after a try-catch, regardless of exceptions. finalize is a method used for cleanup before an object is
4 min read
Chained Exceptions in JavaChained Exceptions in Java allow associating one exception with another, i.e. one exception describes the cause of another exception. For example, consider a situation in which a method throws an ArithmeticException because of an attempt to divide by zero.But the root cause of the error was an I/O f
3 min read
Null Pointer Exception in JavaA NullPointerException in Java is a RuntimeException. It occurs when a program attempts to use an object reference that has the null value. In Java, "null" is a special value that can be assigned to object references to indicate the absence of a value.Reasons for Null Pointer ExceptionA NullPointerE
5 min read
Exception Handling with Method Overriding in JavaException handling with method overriding in Java refers to the rules and behavior that apply when a subclass overrides a method from its superclass and both methods involve exceptions. It ensures that the overridden method in the subclass does not declare broader or new checked exceptions than thos
4 min read
Java Advanced
Java Multithreading TutorialThreads are the backbone of multithreading. We are living in the real world which in itself is caught on the web surrounded by lots of applications. With the advancement in technologies, we cannot achieve the speed required to run them simultaneously unless we introduce the concept of multi-tasking
15+ min read
Synchronization in JavaIn multithreading, synchronization is important to make sure multiple threads safely work on shared resources. Without synchronization, data can become inconsistent or corrupted if multiple threads access and modify shared variables at the same time. In Java, it is a mechanism that ensures that only
10 min read
File Handling in JavaIn Java, with the help of File Class, we can work with files. This File Class is inside the java.io package. The File class can be used to create an object of the class and then specifying the name of the file.Why File Handling is Required?File Handling is an integral part of any programming languag
6 min read
Java Method ReferencesIn Java, a method is a collection of statements that perform some specific task and return the result to the caller. A method reference is the shorthand syntax for a lambda expression that contains just one method call. In general, one does not have to pass arguments to method references.Why Use Met
9 min read
Java 8 Stream TutorialJava 8 introduces Stream, which is a new abstract layer, and some new additional packages in Java 8 called java.util.stream. A Stream is a sequence of components that can be processed sequentially. These packages include classes, interfaces, and enum to allow functional-style operations on the eleme
15+ min read
Java NetworkingWhen computing devices such as laptops, desktops, servers, smartphones, and tablets and an eternally-expanding arrangement of IoT gadgets such as cameras, door locks, doorbells, refrigerators, audio/visual systems, thermostats, and various sensors are sharing information and data with each other is
15+ min read
JDBC TutorialJDBC stands for Java Database Connectivity. JDBC is a Java API or tool used in Java applications to interact with the database. It is a specification from Sun Microsystems that provides APIs for Java applications to communicate with different databases. Interfaces and Classes for JDBC API comes unde
12 min read
Java Memory ManagementJava memory management is the process by which the Java Virtual Machine (JVM) automatically handles the allocation and deallocation of memory. It uses a garbage collector to reclaim memory by removing unused objects, eliminating the need for manual memory managementJVM Memory StructureJVM defines va
4 min read
Garbage Collection in JavaGarbage collection in Java is an automatic memory management process that helps Java programs run efficiently. Java programs compile to bytecode that can be run on a Java Virtual Machine (JVM). When Java programs run on the JVM, objects in the heap are created, which is a portion of memory dedicated
7 min read
Memory Leaks in JavaIn programming, a memory leak happens when a program keeps using memory but does not give it back when it's done. It simply means the program slowly uses more and more memory, which can make things slow and even stop working. Working of Memory Management in JavaJava has automatic garbage collection,
3 min read
Practice Java
Java Interview Questions and AnswersJava is one of the most popular programming languages in the world, known for its versatility, portability, and wide range of applications. Java is the most used language in top companies such as Uber, Airbnb, Google, Netflix, Instagram, Spotify, Amazon, and many more because of its features and per
15+ min read
Java Programs - Java Programming ExamplesIn this article, we will learn and prepare for Interviews using Java Programming Examples. From basic Java programs like the Fibonacci series, Prime numbers, Factorial numbers, and Palindrome numbers to advanced Java programs.Java is one of the most popular programming languages today because of its
8 min read
Java Exercises - Basic to Advanced Java Practice Programs with SolutionsLooking for Java exercises to test your Java skills, then explore our topic-wise Java practice exercises? Here you will get 25 plus practice problems that help to upscale your Java skills. As we know Java is one of the most popular languages because of its robust and secure nature. But, programmers
7 min read
Java Quiz | Level Up Your Java SkillsThe best way to scale up your coding skills is by practicing the exercise. And if you are a Java programmer looking to test your Java skills and knowledge? Then, this Java quiz is designed to challenge your understanding of Java programming concepts and assess your excellence in the language. In thi
1 min read
Top 50 Java Project Ideas For Beginners and Advanced [Update 2025]Java is one of the most popular and versatile programming languages, known for its reliability, security, and platform independence. Developed by James Gosling in 1982, Java is widely used across industries like big data, mobile development, finance, and e-commerce.Building Java projects is an excel
15+ min read