A web.xml Deployment Descriptor Elements

<small-icon>

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.

<large-icon>

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.

weblogic.httpd.
clientCertProxy

optional

This attribute specifies that certifications from clients of the Web application are provided in the special WL-Proxy-Client-Cert header sent by a proxy plug-in or HttpClusterServlet.

This setting is useful if user authentication is performed on a proxy server—setting clientCertProxy causes the proxy server to pass on the certs to the cluster in a special header, WL-Proxy-Client-Cert.

A WL-Proxy-Client-Cert header could be provided by any client with access to WebLogic Server. WebLogic Server takes the certificate information from that header, trusting that is came from a secure source (the plug-in) and uses that information to authenticate the user.

For this reason, if you set clientCertProxy, use a connection filter to ensure that WebLogic Server accepts connections only from the machine on which the plug-in is running.

In addition to setting this attribute for an individual Web application, you can define this attribute:

For all Web applications hosted by a server instance, on the Server-->Configuration-->General page in the Administration Console. For all Web applications hosted by server instances in a cluster, on the Cluster-->Configuration-->General page.

weblogic.httpd.inputCharset

Defines code set behavior for non-unicode operations.

input-charset (defined within charset-param) in weblogic.xml. See input-charset.

weblogic.httpd.servlet.reloadCheckSecs

Define how often WebLogic Server checks whether a servlet has been modified, and if so, reloads it. A value of -1 is never reload, 0 is always reload. The default is set to 1 second.

servlet-reload-check-secs(defined within container-descriptor) in weblogic.xml.See auth-filter.

weblogic.httpd.servlet.classpath

When this values has been set, the container appends this path to the Web application classpath. This is not a recommended method and is supported only for backward compatibility.

No replacement. Use other means such as manifest classpath or WEB-INF/lib or WEB-INF/classes or virtual directories.

weblogic.httpd.defaultServlet

Sets the default servlet for the Web application. This is not a recommended

method and is supported only for backward compatibility.

No replacement. Instead use the servlet and servlet-mapping elements in web.xml to define a default servlet. The URL pattern for default-servlet should be "/". See servlet-mapping. For additional examples of servlet mapping, see Servlet Mapping.

<icon>

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.

<filter-name>

Required

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

<display-name>

Optional

A short name intended to be displayed by GUI tools.

<description>

Optional

A text description of the filter.

<filter-class>

Required

The fully-qualified class name of the filter.

<init-param>

Optional

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

Use a separate set of <init-param> tags for each attribute.

<filter-name>

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 <filter> element with the <filter-name> element.

<url-pattern>

Required - or map by <servlet>

Describes a pattern used to resolve URLs. The portion of the URL after the http://host:port + ContextPath is compared to the <url-pattern> 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 the Servlet 2.3 Specification.

<servlet>

Required - or map by <url-pattern>

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

<listener-class>

Optional

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

<icon>

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.

<servlet-name>

Required

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

<display-name>

Optional

A short name intended to be displayed by GUI tools.

<description>

Optional

A text description of the servlet.

<servlet-class>

Required (or use <jsp-

file>)

The fully-qualified class name of the servlet.

Use only one of either the <servlet-class> tags or <jsp-file> tags in your servlet body.

<jsp-file>

Required (or use <servlet-

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 <servlet-class> tags or <jsp-file> tags in your servlet body.

<init-param>

Optional

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

Use a separate set of <init-param> tags for each attribute.

<load-on-startup>

Optional

WebLogic Server initializes this servlet when WebLogic Server starts up. The optional 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 during application startup.

<run-as>

Optional

Specifies the run-as identity to be used for the execution of the Web application. It contains an optional description and the name of a security role.

<security-role-
ref>

Optional

Used to link a security role name defined by <security-role> 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.

<servlet-name>

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 <servlet> declaration tag.

<url-pattern>

Required

Describes a pattern used to resolve URLs. The portion of the URL after the http://host:port + WebAppName is compared to the <url-pattern> 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 the Servlet 2.3 Specification.

For additional examples of servlet mapping, see Servlet Mapping.

<session-timeout>

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 attribute of the <session-descriptor> element in the WebLogic-specific deployment descriptor weblogic.xml, unless one of the special values listed here is entered.

Default value: 60

Maximum value: Integer.MAX_VALUE ÷ 60

Special values:

-1 = Sessions do not timeout. The value set in <session-descriptor> element of weblogic.xml is ignored.

For more information, see session-descriptor.

<extension>

Required

A string describing an extension, for example: txt.

<mime-type>

Required

A string describing the defined mime type, for example: text/plain.

<welcome-file>

Optional

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

<error-code>

Optional

A valid HTTP error code, for example, 404.

<exception-type>

Optional

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

<location>

Required

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

<taglib>

Optional

Provides information on a tag library that is used by a JSP page within the Web application.

<jsp-property-group>

Optional

Used to group a number of files so they can be given global property information. All files so described are deemed to be JSP files.

<description>

Optional

Provides a description of the resource environment reference.

<resource-env-ref-name>

Required

Specifies the name of a resource environment reference; its value is the environment entry name used in the Web application code. The name is a JNDI name relative to the java:comp/env context and must be unique within a Web application.

<resource-env-ref-type>

Required

Specifies the type of a resource environment reference. It is the fully qualified name of a Java language class or interface.

<description>

Optional

A text description.

<res-ref-name>

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.

<res-type>

Required

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

<res-auth>

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.

<res-sharing-scope>

Optional

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

Valid values:

Shareable

Unshareable

<web-resource-
collection>

Required

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

<auth-constraint>

Optional

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

<user-data-
constraint>

Optional

Defines how the client should communicate with the server.

See also user-data-constraint

<auth-method>

Optional

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

BASIC—uses browser authentication. (This is the default value.)

FORM—uses a user-written HTML form.

CLIENT-CERT

You can define multiple authentication methods as a comma separated list to provide a fall-back mechanism. Authentication will be attempted in the order the values are defined in the auth-method list. See "Providing a Fallback Mechanism for Authentication Methods" in Programming Security for Oracle WebLogic Server.

<realm-name>

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.

The <realm-name> element does not refer to system security realms within WebLogic Server. This element defines the realm name to use in HTTP Basic authorization. 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.

<form-login-
config>

Optional

Use this element if you configure the <auth-method> to FORM. See form-login-config.

<description>

Optional

A text description of this security role.

<role-name>

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.

<description>

Optional

A textual description.

<env-entry-name>

Required

The name of the environment entry.

<env-entry-value>

Required

The value of the environment entry.

<env-entry-type>

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

<description>

Optional

A text description of the reference.

<ejb-ref-name>

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.

<ejb-ref-type>

Required

The expected Java class type of the referenced EJB.

<home>

Required

The fully qualified class name of the EJB home interface.

<remote>

Required

The fully qualified class name of the EJB remote interface.

<ejb-link>

Optional

The <ejb-name> of an EJB in an encompassing Java EE application package.

<run-as>

Optional

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

<description>

Optional

A text description of the reference.

<ejb-ref-name>

Required

Contains the name of an EJB reference. The EJB reference is an entry in the Web application's environment and is relative to the java:comp/env context. The name must be unique within the Web application. It is recommended that name is prefixed with ejb/.

For example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

<ejb-ref-type>

Required

The ejb-ref-type element contains the expected type of the referenced enterprise bean. The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type>

<ejb-ref-type>Session</ejb-ref-type>

<local-home>

Required

Contains the fully-qualified name of the enterprise bean's local home interface.

<local>

Required

Contains the fully-qualified name of the enterprise bean's local interface.

<ejb-link>

Optional

The ejb-link element is used in the ejb-ref or ejb-local-ref elements to specify that an EJB reference is linked to an EJB.

The name in the ejb-link element is composed of a path name. This path name specifies the ejb-jar containing the referenced EJB with the ejb-name of the target bean appended and separated from the path name by #.

The path name is relative to the WAR file containing the Web application that is referencing the EJB. This allows multiple EJBs with the same ejb-name to be uniquely identified.

Used in: ejb-local-ref and ejb-ref elements.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

<version>

Required

All Servlet deployment descriptors must indicate the 2.4 version of the schema in order to enforce Servlet 2.4 behavior.