Annotation Interface WebServlet

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface WebServlet
This annotation is used to declare the configuration of a Servlet.
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 the value or urlPattern attribute of the annotation, but not both.

The value attribute is recommended for use when the URL pattern is the only attribute being set, otherwise the urlPattern attribute should be used.

The class on which this annotation is declared MUST extend HttpServlet.

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
    boolean
    asyncSupported
    Indicates whether this servlet supports asynchronous operation.
    String
    description
    Provides a description of this servlet.
    String
    displayName
    Provides a display name for this servlet.
    WebInitParam[]
    initParams
    Declares initialization parameters for this servlet.
    String
    largeIcon
    Provides the URL of a large icon for this servlet.
    int
    loadOnStartup
    Provides a load-on-startup ordering hint for this servlet.
    String
    name
    Provides the name of this servlet.
    String
    smallIcon
    Provides the URL of a small icon for this servlet.
    String[]
    urlPatterns
    Declares the URL patterns for this servlet.
    String[]
    value
    A convenience method, to allow extremely simple annotation of a class.

  • Element Details

    • name

      String name
      Provides the name of this servlet.
      Returns:
      name of the Servlet
      Default:
      ""

    • value

      String[] value
      A convenience method, to allow extremely simple annotation of a class.
      Returns:
      array of URL patterns
      See Also:
      Default:
      {}

    • urlPatterns

      String[] urlPatterns
      Declares the URL patterns for this servlet.
      Returns:
      array of URL patterns to which this Servlet applies
      Default:
      {}

    • loadOnStartup

      int loadOnStartup
      Provides a load-on-startup ordering hint for this servlet.
      Returns:
      load on startup ordering hint
      Default:
      -1

    • initParams

      WebInitParam[] initParams
      Declares initialization parameters for this servlet.
      Returns:
      array of initialization params for this Servlet
      Default:
      {}

    • asyncSupported

      boolean asyncSupported
      Indicates whether this servlet supports asynchronous operation.
      Returns:
      asynchronous operation supported by this Servlet
      Default:
      false

    • smallIcon

      String smallIcon
      Provides the URL of a small icon for this servlet.
      Returns:
      small icon for this Servlet, if present
      Default:
      ""

    • largeIcon

      String largeIcon
      Provides the URL of a large icon for this servlet.
      Returns:
      large icon for this Servlet, if present
      Default:
      ""

    • description

      String description
      Provides a description of this servlet.
      Returns:
      description of this Servlet, if present
      Default:
      ""

    • displayName

      String displayName
      Provides a display name for this servlet.
      Returns:
      display name of this Servlet, if present
      Default:
      ""