WebServlet

```
@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface WebServlet
```
Annotation used to declare a servlet.
This annotation is processed by the container at deployment time, and the corresponding servlet made available at the specified URL patterns.

Since:

Servlet 3.0

See Also:

Servlet

Examples (en):

vaadin-lts-v08-simple, security-custom-identitystore, resources-declared-in-webapp, moviefun, cdi-session-scope, cdi-realm, async-servlet

Examples (es):

vaadin-lts-v08-simple

Examples (pt):

vaadin-lts-v08-simple, cdi-session-scope, cdi-realm, async-servlet

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`boolean`	`asyncSupported` Declares whether the servlet supports asynchronous operation mode.
`java.lang.String`	`description` The description of the servlet
`java.lang.String`	`displayName` The display name of the servlet
`WebInitParam[]`	`initParams` The init parameters of the servlet
`java.lang.String`	`largeIcon` The large-icon of the servlet
`int`	`loadOnStartup` The load-on-startup order of the servlet
`java.lang.String`	`name` The name of the servlet
`java.lang.String`	`smallIcon` The small-icon of the servlet
`java.lang.String[]`	`urlPatterns` The URL patterns of the servlet
`java.lang.String[]`	`value` The URL patterns of the servlet

- Element Detail
  - name
```
public abstract java.lang.String name
```
    The name of the servlet
    
    Returns:
    
    the name of the servlet
    
    Default:
    
    ""
- - value
```
public abstract java.lang.String[] value
```
    The URL patterns of the servlet
    
    Returns:
    
    the URL patterns of the servlet
    
    Default:
    
    {}
- - urlPatterns
```
public abstract java.lang.String[] urlPatterns
```
    The URL patterns of the servlet
    
    Returns:
    
    the URL patterns of the servlet
    
    Default:
    
    {}
- - loadOnStartup
```
public abstract int loadOnStartup
```
    The load-on-startup order of the servlet
    
    Returns:
    
    the load-on-startup order of the servlet
    
    Default:
    
    -1
- - initParams
```
public abstract WebInitParam[] initParams
```
    The init parameters of the servlet
    
    Returns:
    
    the init parameters of the servlet
    
    Default:
    
    {}
- - asyncSupported
```
public abstract boolean asyncSupported
```
    Declares whether the servlet supports asynchronous operation mode.
    
    Returns:
    
    true if the servlet supports asynchronous operation mode
    
    See Also:
    
    ServletRequest.startAsync(), ServletRequest.startAsync( jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse)
    
    Default:
    
    false
- - smallIcon
```
public abstract java.lang.String smallIcon
```
    The small-icon of the servlet
    
    Returns:
    
    the small-icon of the servlet
    
    Default:
    
    ""
- - largeIcon
```
public abstract java.lang.String largeIcon
```
    The large-icon of the servlet
    
    Returns:
    
    the large-icon of the servlet
    
    Default:
    
    ""
- - description
```
public abstract java.lang.String description
```
    The description of the servlet
    
    Returns:
    
    the description of the servlet
    
    Default:
    
    ""
- - displayName
```
public abstract java.lang.String displayName
```
    The display name of the servlet
    
    Returns:
    
    the display name of the servlet
    
    Default:
    
    ""

Annotation Type WebServlet

Optional Element Summary

Element Detail

name

value

urlPatterns

loadOnStartup

initParams

asyncSupported

smallIcon

largeIcon

description

displayName