Package javax.servlet.annotation

Annotation Type WebServlet

@Target(TYPE)
@Retention(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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	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

java.lang.String name

The name of the servlet

Default:

""

value

java.lang.String[] value

The URL patterns of the servlet

Default:

{}

urlPatterns

java.lang.String[] urlPatterns

The URL patterns of the servlet

Default:

{}

loadOnStartup

int loadOnStartup

The load-on-startup order of the servlet

Default:

-1

initParams

WebInitParam[] initParams

The init parameters of the servlet

Default:

{}

asyncSupported

boolean asyncSupported

Declares whether the servlet supports asynchronous operation mode.

See Also:

ServletRequest.startAsync(), ServletRequest.startAsync(ServletRequest, ServletResponse)

Default:

false

smallIcon

java.lang.String smallIcon

The small-icon of the servlet

Default:

""

largeIcon

java.lang.String largeIcon

The large-icon of the servlet

Default:

""

description

java.lang.String description

The description of the servlet

Default:

""

displayName

java.lang.String displayName

The display name of the servlet

Default:

""