blob: 701e0766e019789428f2eb444e147bf870e5677c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>Understanding the DBWS Builder File Properties | EclipseLink 3.0 EclipseLink DBWS</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" />
<meta name="date" content="2014-06-10T10:32:28Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Understanding the DBWS Builder File Properties" />
<meta name="relnum" content="Release 3.0" />
<link rel="stylesheet" type="text/css" href="../../dcommon/style.css" media="screen" />
<link rel="copyright" href="../../dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
<link rel="prev" href="overview001.htm" title="Previous" type="text/html" />
<link rel="next" href="overview003.htm" title="Next" type="text/html" />
<!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head>
<body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:1hjujor5_fg', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div>
<div class="header"><a id="top" name="top"></a>
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" valign="top"><font face="helvetica, arial, sans-serif"><b>Developing Persistence Architectures Using EclipseLink Database Web Services</b><br />
<b>Release 3.0</b><br />
</font></td>
<td valign="bottom" align="right" width="144">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<hr />
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<tr>
<td align="center"><a href="overview001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="overview003.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
<td>&nbsp;</td>
</tr>
</table>
</div>
<!-- class="header" -->
<div class="ind"><!-- End Header --><a id="CJACBGBI" name="CJACBGBI"></a>
<div class="sect1"><!-- infolevel="all" infotype="General" -->
<h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Understanding the DBWS Builder File Properties</font></h1>
<p>Use the <code>&lt;property&gt;</code> element in the DBWS Builder XML file to define the necessary server properties, as shown in <a href="#CJAHEECA">Example 1-4</a></p>
<div class="example"><a id="CJAHEECA" name="CJAHEECA"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 1-4 Sample DBWS Builder XML file</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema"
&lt;properties&gt;
&lt;<strong>property</strong> name="projectName"&gt;procedure_test&lt;/<strong>property</strong>&gt;
&lt;<strong>property</strong> name="logLevel"&gt;off&lt;/<strong>property</strong>&gt;
&lt;<strong>property</strong> name="username"&gt;myName&lt;/<strong>property</strong>&gt;
...
&lt;/properties&gt;
...
</pre></div>
<!-- class="example" -->
<p>See <a href="overview003.htm#CJAIABED">Example 1-5</a> and <a href="overview003.htm#CJAGDJAI">Example 1-6</a> for additional samples of a DBWS Builder XML file.</p>
<p><a href="#CJAGGEJF">Table 1-2</a> defines the valid <code>&lt;property&gt;</code> values:</p>
<div class="tblhruleformal"><a id="sthref16" name="sthref16"></a><a id="CJAGGEJF" name="CJAGGEJF"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Table 1-2 DBWS Builder File Properties</font></em></strong></p>
<table class="HRuleFormal" title="DBWS Builder File Properties" summary="This table describes the DBWS Builder properties." dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
<col width="36%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t4"><font face="Arial, Helvetica, sans-serif"><strong>Property</strong></font></th>
<th align="left" valign="bottom" id="r1c2-t4"><font face="Arial, Helvetica, sans-serif"><strong>Description</strong></font></th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t4" headers="r1c1-t4">
<p><code>projectName</code></p>
</td>
<td align="left" headers="r2c1-t4 r1c2-t4">
<p>Name of the DBWS project.</p>
<p>Default = <code>myProject</code></p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t4" headers="r1c1-t4">
<p><code>logLevel</code></p>
</td>
<td align="left" headers="r3c1-t4 r1c2-t4">
<p>Defines the amount and detail EclipseLink writes to the log. Valid values: <code>off</code>, <code>severe</code>, <code>warning</code>, <code>info</code> (default), <code>config</code>, <code>fine</code>, <code>fine</code>, <code>finest</code>, and <code>all</code>.</p>
<p>See in "logging.level" in <em>Jakarta Persistence API (JPA) Extensions Reference for EclipseLink</em> for details.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t4" headers="r1c1-t4">
<p><code>username</code></p>
</td>
<td align="left" headers="r4c1-t4 r1c2-t4">
<p>Username used to log into the database.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t4" headers="r1c1-t4">
<p><code>password</code></p>
</td>
<td align="left" headers="r5c1-t4 r1c2-t4">
<p>Password of the <code>username</code> used to log into the database.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t4" headers="r1c1-t4">
<p><code>url</code></p>
</td>
<td align="left" headers="r6c1-t4 r1c2-t4">
<p>Database URL.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t4" headers="r1c1-t4">
<p><code>driver</code></p>
</td>
<td align="left" headers="r7c1-t4 r1c2-t4">
<p>Database driver.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t4" headers="r1c1-t4">
<p><code>platformClassname</code></p>
</td>
<td align="left" headers="r8c1-t4 r1c2-t4">
<p>Specify the database platform. This must be a fully qualified class name that extends <code>DatabasePlatform</code>.</p>
<p>Default = <code>org.eclipse.persistence.platform.database.OraclePlatform</code></p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t4" headers="r1c1-t4">
<p><code>targetNamespace</code></p>
</td>
<td align="left" headers="r9c1-t4 r1c2-t4">
<p>The target namespace value applied to generated types.</p>
<p>Default = <code>urn:</code><em><code>projectName</code></em></p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t4" headers="r1c1-t4">
<p><code>orSessionCustomizerClassName</code></p>
</td>
<td align="left" headers="r10c1-t4 r1c2-t4">
<p>Name of the session customizer applied to the ORM session.</p>
<p>See in "session.customizer" in <em>Jakarta Persistence API (JPA) Extensions Reference for EclipseLink</em> for details.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t4" headers="r1c1-t4">
<p><code>oxSessionCustomizerClassName</code></p>
</td>
<td align="left" headers="r11c1-t4 r1c2-t4">
<p>Name of the session customizer applied to the OXM session.</p>
<p>See in "session.customizer" in <em>Jakarta Persistence API (JPA) Extensions Reference for EclipseLink</em> for details.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t4" headers="r1c1-t4">
<p><code>dataSource</code></p>
</td>
<td align="left" headers="r12c1-t4 r1c2-t4">
<p>JNDI name of the data source, as defined on the target application server.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r13c1-t4" headers="r1c1-t4">
<p><code>wsdlLocationURI</code></p>
</td>
<td align="left" headers="r13c1-t4 r1c2-t4">
<p>Location URI value, set in generated WSDL.</p>
<p>Default = <code>REPLACE_WITH_ENDPOINT_ADDRESS</code></p>
</td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="tblhruleformal" --></div>
<!-- class="sect1" --></div>
<!-- class="ind" -->
<!-- Start Footer -->
<div class="footer">
<hr />
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="33%" />
<col width="*" />
<col width="33%" />
<tr>
<td valign="bottom">
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<col width="*" />
<col width="48%" />
<col width="48%" />
<tr>
<td>&nbsp;</td>
<td align="center"><a href="overview001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="overview003.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
</tr>
</table>
</td>
<td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br />
<td valign="bottom" align="right">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!-- class="footer" -->
<div id="copyright">Copyright &copy; 2014 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body>
</html>