diff options
| author | nhauge | 2009-05-01 16:46:16 +0000 |
|---|---|---|
| committer | nhauge | 2009-05-01 16:46:16 +0000 |
| commit | 90f3473eab3ed00defabb45147d9b8f2c1dbeb9d (patch) | |
| tree | 8d7f7268303fcfa830a027f05cccfbbc61cb32bf /jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm | |
| parent | 97b0550847a242f73d11c3bcfeb8edec8939d9b8 (diff) | |
| download | webtools.dali-90f3473eab3ed00defabb45147d9b8f2c1dbeb9d.tar.gz webtools.dali-90f3473eab3ed00defabb45147d9b8f2c1dbeb9d.tar.xz webtools.dali-90f3473eab3ed00defabb45147d9b8f2c1dbeb9d.zip | |
261107 - Update docs for 2.2 release.
Diffstat (limited to 'jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm')
| -rw-r--r-- | jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm | 242 |
1 files changed, 165 insertions, 77 deletions
diff --git a/jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm b/jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm index 395b15aec7..ccfeeded9b 100644 --- a/jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm +++ b/jpa/plugins/org.eclipse.jpt.doc.user/reference021.htm @@ -2,149 +2,237 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> -<!-- Run date = July 23, 2008 8:59:51 --> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> -<title>Customization</title> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.0" /> -<meta name="date" content="2005-07-10T12:57:20+08:00" /> +<title>Logging</title> +<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1.1 Build 004" /> +<meta name="date" content="2009-05-01T8:12:52Z" /> <meta name="robots" content="noarchive" /> -<meta name="doctitle" content="Customization" /> -<meta name="relnum" content="Release 2.0" /> +<meta name="doctitle" content="Logging" /> +<meta name="relnum" content="Release 2.2" /> <meta name="copyright" content="Copyright (c) 2000, 2008 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Oracle - initial API and implementation" /> <link rel="copyright" href="dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> <link rel="stylesheet" href="dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" /> -<!-- start--> <!-- contents --> </head> <body> -<p><a id="CIAJAFEG" name="CIAJAFEG"></a></p> +<p><a id="CIABGHHI" name="CIABGHHI"></a></p> <div class="sect3"><!-- infolevel="all" infotype="General" --> -<h1>Customization</h1> -<p>The following table lists the properties available in the Customization page of the <a href="reference018.htm#CIACCHID">persistence.xml Editor</a>.</p> -<div class="tblformal"><a id="sthref222" name="sthref222"></a><a id="sthref223" name="sthref223"></a> -<p class="titleintable">Properties of the Customization Page</p> -<table class="Formal" title="Properties of the Customization Page" summary="This table lists the properties of the persistence.xml Editor’s Customization page." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> +<h1>Logging</h1> +<p>This table lists the properties of the Logging page of the <a href="ref_persistence_xmll_editor.htm#CIACCHID">persistence.xml Editor</a>.</p> +<div align="center"> +<div class="inftblnote"><br /> +<table class="Note oac_no_warn" summary="" cellpadding="3" cellspacing="0"> +<tbody> +<tr> +<td align="left"> +<p class="notep1">Note:</p> +This page is not available for projects using the <span class="bold">Generic</span> platform.</td> +</tr> +</tbody> +</table> +<br /></div> +<!-- class="inftblnote" --></div> +<div class="tblformal"><a id="sthref265" name="sthref265"></a><a id="sthref266" name="sthref266"></a> +<p class="titleintable">Properties of the Logging Page</p> +<table class="Formal" title="Properties of the Logging Page" summary="This table lists the properties of the Logging page of the persistence.xml Editor." dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> +<col width="24%" /> +<col width="*" /> +<col width="24%" /> <thead> <tr align="left" valign="top"> -<th align="left" valign="bottom" id="r1c1-t18">Property</th> -<th align="left" valign="bottom" id="r1c2-t18">Description</th> -<th align="left" valign="bottom" id="r1c3-t18">Default</th> +<th align="left" valign="bottom" id="r1c1-t31">Property</th> +<th align="left" valign="bottom" id="r1c2-t31">Description</th> +<th align="left" valign="bottom" id="r1c3-t31">Default</th> </tr> </thead> <tbody> <tr align="left" valign="top"> -<td align="left" id="r2c1-t18" headers="r1c1-t18"> -<p>Weaving</p> +<td align="left" id="r2c1-t31" headers="r1c1-t31"> +<p>Logging Level</p> </td> -<td align="left" headers="r2c1-t18 r1c2-t18"> -<p>Specifies if weaving of the entity classes is performed. The EclipseLink JPA persistence provider uses weaving to enhance JPA entities for such properties as lazy loading, change tracking, fetch groups, and internal optimizations. Select from the following options:</p> +<td align="left" headers="r2c1-t31 r1c2-t31"> +<p>Specifies the amount and detail of log output by selecting the log level (in ascending order of information):</p> +<p>The following are the valid values for the <code>java.util.logging.Level</code>:</p> <ul> <li> -<p><span class="bold">No Weaving</span></p> +<p><span class="bold">OFF</span>–disables logging</p> +</li> +<li> +<p><span class="bold">SEVERE</span>–logs exceptions indicating TopLink cannot continue, as well as any exceptions generated during login. This includes a stack trace.</p> +</li> +<li> +<p><span class="bold">WARNING</span>–logs exceptions that do not force TopLink to stop, including all exceptions not logged with severe level. This does not include a stack trace.</p> </li> <li> -<p><span class="bold">Weave Dynamically</span></p> +<p><span class="bold">INFO</span>–logs the login/logout per sever session, including the user name. After acquiring the session, detailed information is logged.</p> </li> <li> -<p><span class="bold">Weave Statically</span> -- Use this option if you plan to execute your application outside of a Java EE 5 container in an environment that does not permit the use of <code>-javaagent:eclipselink.jar</code> on the JVM command line. This assumes that classes have already been statically woven. Run the static weaver on the classes before deploying them.</p> +<p><span class="bold">CONFIG</span>–logs only login, JDBC connection, and database information.</p> +</li> +<li> +<p><span class="bold">FINE</span>–logs SQL.</p> +</li> +<li> +<p><span class="bold">FINER</span>–similar to warning. Includes stack trace.</p> +</li> +<li> +<p><span class="bold">FINEST</span>–includes additional low level information.</p> </li> </ul> -</td> -<td align="left" headers="r2c1-t18 r1c3-t18"> -<p>Weave Dynamically</p> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.level" value="INFO"/> +</pre></td> +<td align="left" headers="r2c1-t31 r1c3-t31"> +<p>Info</p> </td> </tr> <tr align="left" valign="top"> -<td align="left" id="r3c1-t18" headers="r1c1-t18"> -<p> Weaving Lazy</p> +<td align="left" id="r3c1-t31" headers="r1c1-t31"> +<p> Timestamp</p> </td> -<td align="left" headers="r3c1-t18 r1c2-t18"> -<p>Select this optoin to enable lazy weaving.</p> +<td align="left" headers="r3c1-t31 r1c2-t31"> +<p>Control whether the timestamp is logged in each log entry.</p> +<p>The following are the valid values:</p> +<ul> +<li> +<p><span class="bold">true</span>–log a timestamp.</p> +</li> +<li> +<p><span class="bold">false</span>–do not log a timestamp.</p> +</li> +</ul> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.timestamp" value="false"/> +</pre></td> +<td align="left" headers="r3c1-t31 r1c3-t31"> +<p>true</p> </td> -<td align="left" headers="r3c1-t18 r1c3-t18"><br /></td> </tr> <tr align="left" valign="top"> -<td align="left" id="r4c1-t18" headers="r1c1-t18"> -<p> Weaving Fetch Groups</p> +<td align="left" id="r4c1-t31" headers="r1c1-t31"> +<p> Thread</p> </td> -<td align="left" headers="r4c1-t18 r1c2-t18"> -<p>Select this option to enable fetch groups through weaving. Set this option to false if:</p> +<td align="left" headers="r4c1-t31 r1c2-t31"> +<p>Control whether a thread identifier is logged in each log entry.</p> +<p>The following are the valid values:</p> <ul> <li> -<p>There is no weaving.</p> +<p><span class="bold">true</span>–log a thread identifier.</p> </li> <li> -<p>Classes should not be changed during weaving (for example, when debugging).</p> +<p><span class="bold">false</span>–do not log a thread identifier.</p> </li> </ul> -<p>Set this property to false for platforms where it is not supported.</p> </td> -<td align="left" headers="r4c1-t18 r1c3-t18"><br /></td> +<td align="left" headers="r4c1-t31 r1c3-t31"> +<p>true</p> +</td> </tr> <tr align="left" valign="top"> -<td align="left" id="r5c1-t18" headers="r1c1-t18"> -<p> Weaving Change Tracking</p> +<td align="left" id="r5c1-t31" headers="r1c1-t31"> +<p> Session</p> </td> -<td align="left" headers="r5c1-t18 r1c2-t18"> -<p>Select this option to use weaving to detect which fields or properties of the object change.</p> +<td align="left" headers="r5c1-t31 r1c2-t31"> +<p>Control whether an EclipseLink session identifier is logged in each log entry.</p> +<p>The following are the valid values:</p> +<ul> +<li> +<p><span class="bold">true</span>–log a EclipseLink session identifier.</p> +</li> +<li> +<p><span class="bold">false</span>–do not log a EclipseLink session identifier.</p> +</li> +</ul> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.session" value="false"/> +</pre></td> +<td align="left" headers="r5c1-t31 r1c3-t31"> +<p>true</p> </td> -<td align="left" headers="r5c1-t18 r1c3-t18"><br /></td> </tr> <tr align="left" valign="top"> -<td align="left" id="r6c1-t18" headers="r1c1-t18"> -<p> Throw Exceptions</p> +<td align="left" id="r6c1-t31" headers="r1c1-t31"> +<p> Exceptions</p> </td> -<td align="left" headers="r6c1-t18 r1c2-t18"> -<p>Select this option to set EclipseLink to throw an exception or log a warning when it encounters a problem with any of the files listed in a <span class="bold">persistence.xml</span> file <code><mapping-file></code> element.</p> +<td align="left" headers="r6c1-t31 r1c2-t31"> +<p>Control whether the exceptions thrown from within the EclipseLink code are logged prior to returning the exception to the calling application. Ensures that all exceptions are logged and not masked by the application code.</p> +<p>The following are the valid values:</p> +<ul> +<li> +<p><span class="bold">true</span>–log all exceptions.</p> +</li> +<li> +<p><span class="bold">false</span>–do not log exceptions.</p> +</li> +</ul> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.exceptions" value="true"/> +</pre></td> +<td align="left" headers="r6c1-t31 r1c3-t31"> +<p>false</p> </td> -<td align="left" headers="r6c1-t18 r1c3-t18"><br /></td> </tr> <tr align="left" valign="top"> -<td align="left" id="r7c1-t18" headers="r1c1-t18"> -<p>Session Customizer</p> +<td align="left" id="r7c1-t31" headers="r1c1-t31"> +<p>Log file</p> </td> -<td align="left" headers="r7c1-t18 r1c2-t18"> -<p>Select a session customizer class: a Java class that implements the <code>eclipselink.tools.sessionconfiguration.SessionCustomizer</code> interface and provides a default (zero-argument) constructor. Use this class' <code>customize</code> method, which takes an <code>eclipselink.sessions.Session</code>, to programmatically access advanced EclipseLink session API.</p> -</td> -<td align="left" headers="r7c1-t18 r1c3-t18"><br /></td> +<td align="left" headers="r7c1-t31 r1c2-t31"> +<p>Specify a file location for the log output (instead of the standard out).</p> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.file" value="C:\myout\" /> +</pre></td> +<td align="left" headers="r7c1-t31 r1c3-t31"><br /></td> </tr> <tr align="left" valign="top"> -<td align="left" id="r8c1-t18" headers="r1c1-t18"> -<p>Descriptor Customizer</p> +<td align="left" id="r8c1-t31" headers="r1c1-t31"> +<p>Logger</p> </td> -<td align="left" headers="r8c1-t18 r1c2-t18"> -<p>Select an EclipseLink descriptor customizer class–a Java class that implements the <code>eclipselink.tools.sessionconfiguration.DescriptorCustomizer</code> interface and provides a default (zero-argument) constructor. Use this class's <code>customize</code> method, which takes an <code>eclipselink.descriptors.ClassDescriptor</code>, to programmatically access advanced EclipseLink descriptor and mapping API for the descriptor associated with the JPA entity named <code><ENTITY></code>.</p> +<td align="left" headers="r8c1-t31 r1c2-t31"> +<p>Select the type of logger to use:</p> +<p>The following are the valid values:</p> +<ul> +<li> +<p><span class="bold">DefaultLogger</span>–the EclipseLink native logger <code>eclipselink.logging.DefaultSessionLog</code>.</p> +</li> +<li> +<p><span class="bold">JavaLogger</span>–the <code>java.util.logging</code> logger <code>eclipselink.logging.JavaLog</code>.</p> +</li> +<li> +<p><span class="bold">ServerLogger</span>–the <code>java.util.logging</code> logger <code>eclipselink.platform.server.ServerLog</code>. Integrates with the application server's logging as define in the <code>eclipselink.platform.server.ServerPlatform.</code></p> +</li> +<li> +<p>Fully qualified class name of a custom logger. The custom logger must implement the <code>eclipselink.logging.SessionLog</code> interface.</p> +</li> +</ul> +<p><span class="bold">Example</span>: <code>persistence.xml</code> file</p> +<pre xml:space="preserve" class="oac_no_warn"> +<property name="eclipselink.logging.logger" value="acme.loggers.MyCustomLogger" /> +</pre></td> +<td align="left" headers="r8c1-t31 r1c3-t31"> +<p>DefaultLogger</p> </td> -<td align="left" headers="r8c1-t18 r1c3-t18"><br /></td> </tr> </tbody> </table> <br /></div> -<!-- class="tblformal" --> -<p>The following table lists the properties of the <a href="reference018.htm#CIACCHID">persistence.xml Editor</a>.</p> -<div align="center"> -<div class="inftblnote"><br /> -<table class="Note oac_no_warn" summary="" cellpadding="3" cellspacing="0"> -<tbody> -<tr> -<td align="left"> -<p class="notep1">Note:</p> -This page is not available for projects using the <span class="bold">Generic</span> platform.</td> -</tr> -</tbody> -</table> -<br /></div> -<!-- class="inftblnote" --></div> -</div> +<!-- class="tblformal" --></div> <!-- class="sect3" --> <!-- Start Footer --> <div class="footer"> <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> +<col width="86%" /> +<col width="*" /> <tr> -<td align="left" width="86%"><a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Copyright © 2006, 2008, Oracle. All rights reserved.</span></a></td> +<td align="left"><span class="copyrightlogo">Copyright © 2006, 2009, Oracle and/or its affiliates. All rights reserved.</span><br /> +<a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td> </tr> </table> </div> |