blob: c28e46e7c04330f200ffe92dc483429a953f2c16 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>web.xml Visual Editor: General</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="dd_multiview_overview_overviewNode" name="dd_multiview_overview_overviewNode"></a></p>
<div id="NBCSH3756"><!-- infolevel="all" infotype="General" --><a id="sthref511" name="sthref511"></a>
<h1>web.xml Visual Editor: General</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Use to add, remove, and display the <code dir="ltr">web.xml</code> file's general information.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<a id="NBCSH3757" name="NBCSH3757"></a>
<p><b>Overview of the Web Application Deployment Descriptor</b></p>
<p>Each web application has a deployment descriptor, which is an XML file that describes how the application should be deployed. The deployment descriptor tells the server about the components that make up the application. The elements of a deployment descriptor are listed below.</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t2">Element</th>
<th align="left" valign="bottom" id="r1c2-t2">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t2" headers="r1c1-t2">
<p>Context Parameters</p>
</td>
<td align="left" headers="r2c1-t2 r1c2-t2">These define the shared String constants that are used by the web application. Set these in the Context Parameters section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t2" headers="r1c1-t2">
<p>Web Application Listeners</p>
</td>
<td align="left" headers="r3c1-t2 r1c2-t2">These list the listeners that the web application uses. Set these in the Web Application Listeners section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t2" headers="r1c1-t2">
<p>Servlet Declarations</p>
</td>
<td align="left" headers="r4c1-t2 r1c2-t2">These list the servlets that the web application uses and provide initialization parameters. Set these in the Servlets section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t2" headers="r1c1-t2">
<p>Servlet Mappings</p>
</td>
<td align="left" headers="r5c1-t2 r1c2-t2">These tell the servlet container which servlet to call for a given (context-relative) request URI or for a request URI pattern. Set these in the Servlets section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t2" headers="r1c1-t2">
<p>Filter Declarations</p>
</td>
<td align="left" headers="r6c1-t2 r1c2-t2">These tell the servlet which filters to invoke for a servlet. Set these in the Filters section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t2" headers="r1c1-t2">
<p>Welcome File List</p>
</td>
<td align="left" headers="r7c1-t2 r1c2-t2">This list specifies the file to use for the default welcome file, such as index.html. Set these in the Welcome Files section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t2" headers="r1c1-t2">
<p>Error Page Declarations</p>
</td>
<td align="left" headers="r8c1-t2 r1c2-t2">These declare the JSP and HTML files that are to be used for handling specified error states and exceptions. Set these in the Error Pages section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t2" headers="r1c1-t2">
<p>JSP Property Groups</p>
</td>
<td align="left" headers="r9c1-t2 r1c2-t2">These declare a set of properties defined for a group of JSP files within a web application. Note that this is supported from J2EE 1.4 onwards only. Set these in the JSP Property Groups section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t2" headers="r1c1-t2">
<p>References</p>
</td>
<td align="left" headers="r10c1-t2 r1c2-t2">These declare logical names for different types of references used in the web application. Set these in the Environment Entries section, the Resource References section, the Resource Environment References section, the EJB References section, or the Message Destination References section.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u></u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t2" headers="r1c1-t2">
<p>Security</p>
</td>
<td align="left" headers="r11c1-t2 r1c2-t2">These declare the login configuration, security roles, and security constraints for the application.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1114">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<p>You can define most of the contents of a <code dir="ltr">web.xml</code> file in the <code dir="ltr">web.xml</code> Visual Editor. For elements that cannot be defined in the editor, click <b>Source</b> at the top to view and edit the deployment descriptor's XML code.</p>
<p>The following general elements of the <code dir="ltr">web.xml</code> file can be defined in the General section.</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t3">Element</th>
<th align="left" valign="bottom" id="r1c2-t3">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t3" headers="r1c1-t3">
<p>Display Name</p>
</td>
<td align="left" headers="r2c1-t3 r1c2-t3">Specifies the file's display name, such as <code dir="ltr">Pizza Delivery Application, Version 1.13</code>.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t3" headers="r1c1-t3">
<p>Description</p>
</td>
<td align="left" headers="r3c1-t3 r1c2-t3">Specifies a description, such as <code dir="ltr">Deployment information for Version 1.13 of Pizza Delivery Application</code>.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t3" headers="r1c1-t3">
<p>Distributable</p>
</td>
<td align="left" headers="r4c1-t3 r1c2-t3">Specifies that all requests that are part of a session must be handled by one Java Virtual Machine (JVM) at a time. See section 7.7.2 of the Java Servlet Specification Version 2.4 for details.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t3" headers="r1c1-t3">
<p>Session Timeout</p>
</td>
<td align="left" headers="r5c1-t3 r1c2-t3">Specifies the default session timeout interval in minutes for all sessions created in the current web application. To set the session timeout interval for a specific session, use the <code dir="ltr">HttpSession.setMaxInactiveInterval(int interval)</code> method. By definition, if the timeout period for a session is set to <code dir="ltr">-1</code>, the session will never expire.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH3772" name="NBCSH3772"></a>
<hr><p><b>Related Topics</b></p>
<p><i>Developing Applications with NetBeans IDE</i>,
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2810">
<param name="text" value="<html><u>&quot;Using Annotations and Deployment Descriptors&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p><i>Developing Applications with NetBeans IDE</i>,
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1111">
<param name="text" value="<html><u>&quot;Configuring a Web Application&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<!-- -->
<!-- Start Footer -->
<table summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="legal_notice.htm">
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a>
</td>
</tr>
</table>
<!-- -->
</body>
</html>