web.xml Deployment Descriptor Elements

Element

Optional

Location for a small (16x16 pixel) .gif or .jpg image used to represent the Web Application in a GUI tool. Currently, this is not used by WebLogic Server.

Optional

Location for a large (32x32 pixel) .gif or .jpg image used to represent the Web Application in a GUI tool. Currently, this element is not used by WebLogic Server.

Element

Required/
Optional

Description

Optional

Currently, this element is not used by WebLogic Server.

Element

Required/
Optional

Description

Optional

Currently, this element is not used by WebLogic Server.

Element

Required/
Optional

Description

Optional

Currently, this element is not used by WebLogic Server.

Element

Required

The name of a parameter.

Required

The value of a parameter.

Optional

A text description of a parameter.

Element

Optional

Specifies the location within the Web Application for a small and large image used to represent the filter in a GUI tool. Contains a small-icon and large-icon element.

Currently, this element is not used by WebLogic Server.

Required

Defines the name of the filter, used to reference the filter definition elsewhere in the deployment descriptor.

Optional

A short name intended to be displayed by GUI tools.

Optional

A text description of the filter.

Required

The fully-qualified class name of the filter.

Optional

Contains a name/value pair as an initialization parameter of the filter.

Use a separate set of tags for each parameter.

Element

Required

The name of the filter to which you are mapping a URL pattern or servlet. This name corresponds to the name assigned in the element with the element.

Required - or map by

Describes a pattern used to resolve URLs. The portion of the URL after the http://host:port + ContextPath is compared to the by WebLogic Server. If the patterns match, the filter mapped in this element is called.

Example patterns:

/soda/grape/*
/foo/*
/contents
*.foo

The URL must follow the rules specified in Section 10 of the Servlet 2.2 Specification.

Required - or map by

The name of a servlet which, if called, causes this filter to execute.

Element

Optional

Name of the class that responds to a Web Application event.

Element

Optional

Location within the Web Application for a small and large image used to represent the servlet in a GUI tool. Contains a small-icon and large-icon element.

Currently, this element is not used by WebLogic Server.

Required

Defines the canonical name of the servlet, used to reference the servlet definition elsewhere in the deployment descriptor.

Optional

A short name intended to be displayed by GUI tools.

Optional

A text description of the servlet.

Required (or use file>)

The fully-qualified class name of the servlet.

Use only one of either the tags or tags in your servlet body.

Required (or use class>)

The full path to a JSP file within the Web Application, relative to the Web Application root directory.

Use only one of either the tags or tags in your servlet body.

Optional

Contains a name/value pair as an initialization parameter of the servlet.

Use a separate set of tags for each parameter.

Require

WebLogic Server initializes this servlet when WebLogic Server starts up. The content of this element must be a positive integer indicating the order in which the servlet should be loaded. Lower integers are loaded before higher integers. If no value is specified, or if the value specified is not a positive integer, WebLogic Server can load the servlet in any order in the startup sequence.

ref>

Optional

Used to link a security role name defined by to an alternative role name that is hard coded in the servlet logic. This extra layer of abstraction allows the servlet to be configured at deployment without changing servlet code.

Element

Optional

Specifies the location within the Web Application for a small (16x16 pixel) .gif or .jpg image used to represent the servlet in a GUI tool.

Currently, this element is not used by WebLogic Server.

Optional

Specifies the location within the Web Application for a small (32x32 pixel) .gif or .jpg image used to represent the servlet in a GUI tool.

Currently, this element is not used by WebLogic Server.

Element

Required

Defines the name of this parameter.

Required

Defines a String value for this parameter.

Optional

Text description of the initialization parameter.

Element

Optional

Text description of the role.

Required

Defines the name of the security role or principal that is used in the servlet code.

Required

Defines the name of the security role that is defined in a element later in the deployment descriptor.

Element

Required

The name of the servlet to which you are mapping a URL pattern. This name corresponds to the name you assigned a servlet in a declaration tag.

Required

Describes a pattern used to resolve URLs. The portion of the URL after the http://host:port + WebAppName is compared to the by WebLogic Server. If the patterns match, the servlet mapped in this element will be called.

Example patterns:

/soda/grape/*
/foo/*
/contents
*.foo

The URL must follow the rules specified in Section 10 of the Servlet 2.2 Specification.

For additional examples of servlet mapping, see Servlet Mapping.

Element

Optional

The number of minutes after which sessions in this Web Application expire. The value set in this element overrides the value set in the TimeoutSecs parameter of the element in the WebLogic-specific deployment descriptor weblogic.xml, unless one of the special values listed here is entered.

Default value: -2

Maximum value: Integer.MAX_VALUE ÷ 60

Special values:

• -2 = Use the value set by TimeoutSecs in element of weblogic.xml
• -1 = Sessions do not timeout. The value set in element of weblogic.xml is ignored.

For more information, see session-descriptor Element.

Element

Required

A string describing an extension, for example: txt.

Required

A string describing the defined mime type, for example: text/plain. The following default mime types are provided with WebLogic Server (you can override these):

setIfNone(mimeTypesMap, "html", "text/html");

setIfNone(mimeTypesMap, "htm", "text/html");

setIfNone(mimeTypesMap, "gif", "image/gif");

setIfNone(mimeTypesMap, "jpeg", "image/jpeg");

setIfNone(mimeTypesMap, "jpg", "image/jpeg");

setIfNone(mimeTypesMap, "pdf", "application/pdf");

setIfNone(mimeTypesMap, "zip", "application/zip");

setIfNone(mimeTypesMap, "class", "application/x-java-vm");

setIfNone(mimeTypesMap, "jar", "application/x-java-archive");

setIfNone(mimeTypesMap, "ser",

"application/x-java-serialized-object"); setIfNone(mimeTypesMap,

"exe", "application/octet-stream"); setIfNone(mimeTypesMap, "txt",

"text/plain"); setIfNone(mimeTypesMap, "java", "text/plain"); // This

is for JavaWebStart out of the box work setIfNone(mimeTypesMap,

"jnlp", "application/x-java-jnlp-file");

Element

Optional

File name to use as a default welcome file, such as index.html

Element

Optional

A valid HTTP error code, for example, 404.

Optional

A fully-qualified class name of a Java exception type, for example, java.lang.string

Required

The location of the resource to display in response to the error. For example, /myErrorPg.html.

Element

Required

Gives the file name of the tag library descriptor relative to the root of the Web Application. It is a good idea to store the tag library descriptor file under the WEB-INF directory so it is not publicly available over an HTTP request.

Required

Describes a URI, relative to the location of the web.xml document, identifying a Tag Library used in the Web Application.

If the URI matches the URI string used in the taglib directive on the JSP page, this taglib is used.

Element

Optional

A text description.

Required

The name of the resource used in the JNDI tree. Servlets in the Web Application use this name to look up a reference to the resource.

Required

The Java type of the resource that corresponds to the reference name. Use the full package name of the Java type.

Required

Used to control the resource sign on for security.

If set to APPLICATION, indicates that the application component code performs resource sign on programmatically. If set to CONTAINER WebLogic Server uses the security context established with the login-config element. See login-config Element.

Optional

Specifies whether connections obtained through the given resource manager connection factory reference can be shared.

Valid values:

• Shareable
• Unshareable

Element

collection>

Required

Defines the components of the Web Application to which this security constraint is applied.

Optional

Defines which groups or principals have access to the collection of web resources defined in this security constraint. See also auth-constraint Element.

constraint>

Optional

Defines how the client should communicate with the server.

See also user-data-constraint Element

Element

name>

Required

The name of this Web resource collection.

Optional

A text description of this security constraint.

Optional

Use one or more of the <url-pattern> elements to declare to which URL patterns this security constraint applies. If you do not use at least one of these elements, this <web-resource-collection> is ignored by WebLogic Server.

Optional

Use one or more of the <http-method> elements to declare which HTTP methods (usually, GET or POST) are subject to the authorization constraint. If you omit the <http-method> element, the default behavior is to apply the security constraint to all HTTP methods.

Element

Optional

A text description of this security constraint.

Optional

Defines which security roles can access resources defined in this security-constraint. Security role names are mapped to principals using the security-role-ref Element. See security-role-ref Element.

Element

Optional

A text description.

guarantee>

Required

Specifies that the communication between client and server.

WebLogic Server establishes a Secure Sockets Layer (SSL) connection when the user is authenticated using the INTEGRAL or CONFIDENTIAL transport guarantee.

Range of values:

• NONE—The application does not require any transport guarantees.
• INTEGRAL—The application requires that the data be sent between the client and server in such a way that it cannot be changed in transit.
• CONFIDENTIAL—The application requires that data be transmitted so as to prevent other entities from observing the contents of the transmission.

Element

Optional

Specifies the method used to authenticate the user. Possible values:

BASIC - uses browser authentication
FORM - uses a user-written HTML form
CLIENT-CERT

Optional

The name of the realm that is referenced to authenticate the user credentials. If omitted, the realm defined with the Auth Realm Name field on the Web Application—> Configuration—>Other tab of the Administration Console is used by default. For more information, see Specifying a Security Realm.

Note: The element does not refer to security realms within WebLogic Server. This element defines the realm name to use in HTTP Basic authorization.

Note: The system security realm is a collection of security information that is checked when certain operations are performed in the server. The servlet security realm is a different collection of security information that is checked when a page is accessed and basic authentication is used.

config>

Optional

Use this element if you configure the to FORM. See form-login-config Element.

Element

Required

The URI of a Web resource relative to the document root, used to authenticate the user. This can be an HTML page, JSP, or HTTP servlet, and must return an HTML page containing a FORM that conforms to a specific naming convention. For more information, see Setting Up Authentication for Web Applications.

Required

The URI of a Web resource relative to the document root, sent to the user in response to a failed authentication login.

Element

Optional

A text description of this security role.

Required

The role name. The name you use here must have a corresponding entry in the WebLogic-specific deployment descriptor, weblogic.xml, which maps roles to principals in the security realm. For more information, see security-role-assignment Element.

Element

Optional

A textual description.

Required

The name of the environment entry.

Required

The value of the environment entry.

Required

The type of the environment entry.

Can be set to one of the following Java types:

java.lang.Boolean

java.lang.String

java.lang.Integer

java.lang.Double

java.lang.Float

Element

Optional

A text description of the reference.

Required

The name of the EJB used in the Web Application. This name is mapped to the JNDI tree in the WebLogic-specific deployment descriptor weblogic.xml. For more information, see ejb-reference-description Element.

Required

The expected Java class type of the referenced EJB.

Required

The fully qualified class name of the EJB home interface.

Required

The fully qualified class name of the EJB remote interface.

Optional

The of an EJB in an encompassing J2EE application package.

Optional

A security role whose security context is applied to the referenced EJB. Must be a security role defined with the element.