ide/usersguide/javahelp/org/netbeans/modules/usersguide/f1_web_apps013.htm - netbeans - Git at Google

 <!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 References</title>
 <link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
 </head>

 <body>
 <p><a id="dd_multiview_references_resRefsNode" name="dd_multiview_references_resRefsNode"></a></p>
 <div id="NBCSH3865"><!-- infolevel="all" infotype="General" --><a id="sthref523" name="sthref523"></a>
 <h1>web.xml Visual Editor: Resource References</h1>
 <a name="BEGIN" id="BEGIN"></a>
 <p>Use the Resource References section to add, remove, and view the web application's resource references.
 <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 access a data source, a JMS connection factory, a JavaMail session, or a URL link from a web application, you must declare a resource reference in the application's web application deployment descriptor. The resource reference specifies a JNDI name, the object type, and the kind of authentication used when the resource is accessed. To connect the resource reference to the resource, you must map the JNDI name of the former to the latter. This mapping is done in the server-specific deployment descriptor file, such as the <code dir="ltr">sun-web.xml</code> file for the Glassfish application server.</p>
 <p>You use the resource reference in your code to extract the resource you need. For example, a resource reference defined in the <code dir="ltr">web.xml</code> file is used to extract data from a data source as shown in <a href="#CHDHFBIA">Example: Resource Reference</a></p>
 <div id="NBCSH3866"><a id="CHDHFBIA" name="CHDHFBIA"></a>
 <p>Example: Resource Reference</p>
 <pre xml:space="preserve" dir="ltr">
 public BookDBAO () throws Exception {
    try  {
       Context initCtx = new InitialContext();
       Context envCtx = (Context)
         initCtx.lookup("java:comp/env");
       DataSource ds = (DataSource) envCtx.lookup("jdbc/BookDB");
       con =  ds.getConnection();
      System.out.println("Created connection to database.");
    } catch (Exception ex) {
      System.out.println("Couldn't create connection." +
        ex.getMessage());
    throw new
        Exception("Couldn't open connection to database: "
        + ex.getMessage());
 }
 </pre>
 <!-- -->
 <p>To declare a resource 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 resource 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 References header to open the Resource 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 <b>Add</b> to define a resource reference element 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-t20">Element</th>
 <th align="left" valign="bottom" id="r1c2-t20">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr align="left" valign="top">
 <td align="left" id="r2c1-t20" headers="r1c1-t20">
 <p>Resource Name</p>
 </td>
 <td align="left" headers="r2c1-t20 r1c2-t20">Specifies the resource reference's name, such as <code dir="ltr">myDataSource</code>.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r3c1-t20" headers="r1c1-t20">
 <p>Resource Type</p>
 </td>
 <td align="left" headers="r3c1-t20 r1c2-t20">Specifies the variable's name for validation, such as <code dir="ltr">java.lang.String</code>.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r4c1-t20" headers="r1c1-t20">
 <p>Authentification</p>
 </td>
 <td align="left" headers="r4c1-t20 r1c2-t20">Specifies the source of the authentification credentials.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r5c1-t20" headers="r1c1-t20">
 <p>&nbsp;&nbsp;&nbsp;&nbsp;Application</p>
 </td>
 <td align="left" headers="r5c1-t20 r1c2-t20">Programmatic authentification, provided by the application.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r6c1-t20" headers="r1c1-t20">
 <p>&nbsp;&nbsp;&nbsp;&nbsp;Container</p>
 </td>
 <td align="left" headers="r6c1-t20 r1c2-t20">(Default) Provided by the caller who logged in to the server and created the component instance.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r7c1-t20" headers="r1c1-t20">
 <p>Sharing Scope</p>
 </td>
 <td align="left" headers="r7c1-t20 r1c2-t20">By default, connections to a resource manager are shareable across web components in an application that use the same resource in the same transaction context.</td>
 </tr>
 <tr align="left" valign="top">
 <td align="left" id="r8c1-t20" headers="r1c1-t20">
 <p>Description</p>
 </td>
 <td align="left" headers="r8c1-t20 r1c2-t20">Specifies a description, such as <code dir="ltr">Resource Reference for My Data Source</code>.</td>
 </tr>
 </tbody>
 </table>
 <br />
 <!-- -->
 <a id="NBCSH3874" name="NBCSH3874"></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>
	<!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 References</title>
	<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
	</head>

	<body>
	<p><a id="dd_multiview_references_resRefsNode" name="dd_multiview_references_resRefsNode"></a></p>
	<div id="NBCSH3865"><!-- infolevel="all" infotype="General" --><a id="sthref523" name="sthref523"></a>
	<h1>web.xml Visual Editor: Resource References</h1>
	<a name="BEGIN" id="BEGIN"></a>
	<p>Use the Resource References section to add, remove, and view the web application's resource references.
	<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 access a data source, a JMS connection factory, a JavaMail session, or a URL link from a web application, you must declare a resource reference in the application's web application deployment descriptor. The resource reference specifies a JNDI name, the object type, and the kind of authentication used when the resource is accessed. To connect the resource reference to the resource, you must map the JNDI name of the former to the latter. This mapping is done in the server-specific deployment descriptor file, such as the <code dir="ltr">sun-web.xml</code> file for the Glassfish application server.</p>
	<p>You use the resource reference in your code to extract the resource you need. For example, a resource reference defined in the <code dir="ltr">web.xml</code> file is used to extract data from a data source as shown in <a href="#CHDHFBIA">Example: Resource Reference</a></p>
	<div id="NBCSH3866"><a id="CHDHFBIA" name="CHDHFBIA"></a>
	<p>Example: Resource Reference</p>
	<pre xml:space="preserve" dir="ltr">
	public BookDBAO () throws Exception {
	try {
	Context initCtx = new InitialContext();
	Context envCtx = (Context)
	initCtx.lookup("java:comp/env");
	DataSource ds = (DataSource) envCtx.lookup("jdbc/BookDB");
	con = ds.getConnection();
	System.out.println("Created connection to database.");
	} catch (Exception ex) {
	System.out.println("Couldn't create connection." +
	ex.getMessage());
	throw new
	Exception("Couldn't open connection to database: "
	+ ex.getMessage());
	}
	</pre>
	<!-- -->
	<p>To declare a resource 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 resource 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 References header to open the Resource 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 <b>Add</b> to define a resource reference element 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-t20">Element</th>
	<th align="left" valign="bottom" id="r1c2-t20">Description</th>
	</tr>
	</thead>
	<tbody>
	<tr align="left" valign="top">
	<td align="left" id="r2c1-t20" headers="r1c1-t20">
	<p>Resource Name</p>
	</td>
	<td align="left" headers="r2c1-t20 r1c2-t20">Specifies the resource reference's name, such as <code dir="ltr">myDataSource</code>.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r3c1-t20" headers="r1c1-t20">
	<p>Resource Type</p>
	</td>
	<td align="left" headers="r3c1-t20 r1c2-t20">Specifies the variable's name for validation, such as <code dir="ltr">java.lang.String</code>.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r4c1-t20" headers="r1c1-t20">
	<p>Authentification</p>
	</td>
	<td align="left" headers="r4c1-t20 r1c2-t20">Specifies the source of the authentification credentials.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r5c1-t20" headers="r1c1-t20">
	<p>    Application</p>
	</td>
	<td align="left" headers="r5c1-t20 r1c2-t20">Programmatic authentification, provided by the application.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r6c1-t20" headers="r1c1-t20">
	<p>    Container</p>
	</td>
	<td align="left" headers="r6c1-t20 r1c2-t20">(Default) Provided by the caller who logged in to the server and created the component instance.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r7c1-t20" headers="r1c1-t20">
	<p>Sharing Scope</p>
	</td>
	<td align="left" headers="r7c1-t20 r1c2-t20">By default, connections to a resource manager are shareable across web components in an application that use the same resource in the same transaction context.</td>
	</tr>
	<tr align="left" valign="top">
	<td align="left" id="r8c1-t20" headers="r1c1-t20">
	<p>Description</p>
	</td>
	<td align="left" headers="r8c1-t20 r1c2-t20">Specifies a description, such as <code dir="ltr">Resource Reference for My Data Source</code>.</td>
	</tr>
	</tbody>
	</table>
	<br />
	<!-- -->
	<a id="NBCSH3874" name="NBCSH3874"></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>"About Deployment Descriptors"</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>"Configuring a Web Application"</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>