blob: 9285bc44fd89999b7ee657f589eaff41c7482c06 [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: Resource Environment References</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="dd_multiview_references_resEnvRefsNode" name="dd_multiview_references_resEnvRefsNode"></a></p>
<div id="NBCSH3860"><!-- infolevel="all" infotype="General" --><a id="sthref522" name="sthref522"></a>
<h1>web.xml Visual Editor: Resource Environment References</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Use the Resource Environment References section to add, remove, and view the web application's resource environment references. Resource environment references contain a declaration of a web application's reference to an administered object associated with a resource in the web application's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the web application code.
<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>
<p>To declare an resource environment reference, you must register it in the <code dir="ltr">web.xml</code> file. When you do this, you provide information needed by the server to use the reference.</p>
<p>In the Visual Editor, click <b>References</b> at the top of the editor to open the References section, then click the Resource Environment References header to open the Resource Environment 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>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p>Click Add to define a resource environment reference with the following properties:</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-t19">Element</th>
<th align="left" valign="bottom" id="r1c2-t19">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t19" headers="r1c1-t19">
<p>Resource Name</p>
</td>
<td align="left" headers="r2c1-t19 r1c2-t19">Specifies the name of a resource environment reference, such as <code dir="ltr">jms/SharePriceQueue</code>. The specified value is the environment entry name used in the web application code. The name is a JNDI name relative to the <code dir="ltr">java:comp/env</code> context and must be unique within a web application.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t19" headers="r1c1-t19">
<p>Resource Type</p>
</td>
<td align="left" headers="r3c1-t19 r1c2-t19">Specifies the type of a resource environment reference, either <code dir="ltr">javax.jms.Queue</code> or <code dir="ltr">javax.jms.Topic</code>. It is the fully qualified name of a Java language class or interface.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t19" headers="r1c1-t19">
<p>Description</p>
</td>
<td align="left" headers="r4c1-t19 r1c2-t19">Specifies a description, such as <code dir="ltr">Queue for My Share Prices</code>.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH3864" name="NBCSH3864"></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=NBDAG2812">
<param name="text" value="<html><u>&quot;About 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>