|
Oracle | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=java.lang.annotation.ElementType.TYPE) @Retention(value=RUNTIME) public @interface WLServlet
The WLServlet annotation is used to mark a Servlet class with necessary metadata so it can be deployed without being declared in the web.xml descriptor.
Example:
@WLServlet ( name = "FOO", runAs = "SuperUser" initParams = { @WLInitParam (name="one", value="1") } mapping = {"/foo/*"} ) public class MyServlet extends HttpServlet { . . . }
Annotating a Servlet class with the above annotation is equivalent to declaring the following in the web.xml descriptor:
. . . <servlet> <servlet-name>FOO</servlet-name> <servlet-class>MyServlet</servlet-class> <init-param> <param-name>one</param-name> <param-value>1</param-value> </init-param> </servlet> . . . <servlet-mapping> <servlet-name>FOO</servlet-name> <url-pattern>/foo/*</url-pattern> </servlet-mapping> . . .
Optional Element Summary | |
---|---|
String |
description
The description attribute for the Servlet. |
String |
displayName
The display name attribute for the Servlet. |
String |
icon
The icon attribute for the Servlet. |
WLInitParam[] |
initParams
The init parameters for the Servlet. |
int |
loadOnStartup
The load-on-startup attribute for the Servlet, as defined on the servlet element
in the web.xml descriptor. |
String[] |
mapping
The url patterns for the Servlet mapping. |
String |
name
The name attribute for the Servlet. |
String |
runAs
The 'run-as' attribute for the Servlet, as defined on the servlet element
in the web.xml descriptor. |
public abstract String description
servlet
element in the web.xml descriptor.
Defaults to an empty string.
public abstract String icon
servlet
element in the web.xml descriptor.
Defaults to an empty string.
public abstract String displayName
servlet
element in the web.xml descriptor.
Defaults to an empty string.
public abstract String name
servlet
element in the web.xml descriptor.
If absent, this will default to the class name
of the Servlet being annotated.
public abstract WLInitParam[] initParams
servlet
element in the web.xml descriptor.
public abstract int loadOnStartup
servlet
element
in the web.xml descriptor.
Defaults to -1.
public abstract String runAs
servlet
element
in the web.xml descriptor.
Defaults to an empty string.
public abstract String[] mapping
servlet
element in the web.xml descriptor.
|
Documentation is available at http://download.oracle.com/docs/cd/E12839_01/web.1111 Copyright 1996,2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Part Number E13941-01 Oracle WebLogic Server 10.3.1 API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |