Package jakarta.servlet.annotation
Annotation Type WebServlet
-
@Target(TYPE) @Retention(RUNTIME) @Documented public @interface WebServletThis annotation is used to declare the configuration of aServlet.
If the name attribute is not defined, the fully qualified name of the class is used.
At least one URL pattern MUST be declared in either thevalueorurlPatternattribute of the annotation, but not both.
Thevalueattribute is recommended for use when the URL pattern is the only attribute being set, otherwise theurlPatternattribute should be used.
The class on which this annotation is declared MUST extendHttpServlet.
E.g.@WebServlet("/path")}
public class TestServlet extends HttpServlet ... {
E.g.@WebServlet(name="TestServlet", urlPatterns={"/path", "/alt"})
public class TestServlet extends HttpServlet ... {- Since:
- Servlet 3.0 (Section 8.1.1)
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleanasyncSupportedjava.lang.Stringdescriptionjava.lang.StringdisplayNameWebInitParam[]initParamsjava.lang.StringlargeIconintloadOnStartupjava.lang.Stringnamejava.lang.StringsmallIconjava.lang.String[]urlPatternsjava.lang.String[]valueA convenience method, to allow extremely simple annotation of a class.
-
-
-
-
value
java.lang.String[] value
A convenience method, to allow extremely simple annotation of a class.- Returns:
- array of URL patterns
- See Also:
urlPatterns()
- Default:
- {}
-
-
-
initParams
WebInitParam[] initParams
- Returns:
- array of initialization params for this Servlet
- Default:
- {}
-
-