| <!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>Using an EclipseLink SessionCustomizer | EclipseLink 2.7 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:29Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="Using an EclipseLink SessionCustomizer" /> |
| <meta name="relnum" content="Release 2.7" /> |
| <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="creating_dbws_services001.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="creating_dbws_services003.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 2.7</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> </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> </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> </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="creating_dbws_services001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="creating_dbws_services003.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| <td> </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="header" --> |
| <div class="ind"><!-- End Header --><a id="CJAIJBFJ" name="CJAIJBFJ"></a><a id="TLDBW149" name="TLDBW149"></a> |
| <div class="sect1"><!-- infolevel="all" infotype="General" --> |
| <h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Using an EclipseLink SessionCustomizer</font></h1> |
| <p>When using an EclipseLink <code>SessionCustomizer</code> with DBWS, you can access to the EclipseLink API to retrieve the OR (<code>object-relational</code>) or OX (<code>object-XML</code>) mapping descriptors from the session. You can then use the descriptors to add, change, or delete mappings.</p> |
| <p>For more information, see "Session Customization in the EclipseLink documentation:<br /> |
| <code><a href="http://wiki.eclipse.org/Introduction_to_EclipseLink_Sessions_%28ELUG%29#Session_Customization">http://wiki.eclipse.org/Introduction_to_EclipseLink_Sessions_%28ELUG%29#Session_Customization</a></code></p> |
| <a id="TLDBW150" name="TLDBW150"></a> |
| <div class="sect2"><a id="sthref37" name="sthref37"></a> |
| <h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Example</font></h2> |
| <p>This example illustrates how to implement an EclipseLink <code>SessionCustomizer</code>:</p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| package some.java.package; |
| |
| import org.eclipse.persistence.config.SessionCustomizer; |
| import org.eclipse.persistence.sessions.Session; |
| import org.eclipse.persistence.sessions.DatabaseLogin; |
| |
| public class MySessionCustomizer implements SessionCustomizer { |
| |
| public MySessionCustomizer() { |
| } |
| |
| public void customize(Sesssion session) { |
| DatabaseLogin login = (DatabaseLogin)session.getDatasourceLogin(); |
| // enable 'dirty' reads |
| login.setTransactionIsolation(DatabaseLogin.TRANSACTION_READ_UNCOMMITTED); |
| } |
| } |
| |
| </pre> |
| <p>In the <code>DBWSBuilder</code> configuration file, you must use the <code>orSessionCustomizerClassName</code> or <code>oxSessionCustomizerClassName</code> to specify if the customization applies to the ORM or ORX project (respectively), as shown here:</p> |
| <div class="example"><a id="TLDBW151" name="TLDBW151"></a><a id="sthref38" name="sthref38"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-3 ORM Project</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
| <properties> |
| <property name="projectName">customize_test</property> |
| ... |
| <property name="orSessionCustomizerClassName">some.java.package.MyORSessionCustomizer</property> |
| |
| </pre></div> |
| <!-- class="example" --> |
| <div class="example"><a id="TLDBW152" name="TLDBW152"></a><a id="sthref39" name="sthref39"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-4 ORX Project</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
| <properties> |
| <property name="projectName">customize_test</property> |
| ... |
| <property name="oxSessionCustomizerClassName">some.java.package.MyOXSessionCustomizer</property> |
| |
| </pre></div> |
| <!-- class="example" --></div> |
| <!-- class="sect2" --> |
| <a id="TLDBW153" name="TLDBW153"></a> |
| <div class="sect2"><a id="sthref40" name="sthref40"></a> |
| <h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Advanced Customization</font></h2> |
| <p>You can further customize an EclipseLink DBWS service by creating your own EclipseLink <code>project.xml</code> and <code>sessions.xml</code> files. Using your preferred utility, you can:</p> |
| <ul> |
| <li> |
| <p>map your objects to your relational database in an EclipseLink relational project</p> |
| </li> |
| <li> |
| <p>map your objects to your XML schema in an EclipseLink XML project</p> |
| </li> |
| <li> |
| <p>create an EclipseLink <code>sessions.xml</code> file that references both projects.</p> |
| </li> |
| </ul> |
| <p>In this way, you can control all aspects of the relational and XML mapping. This approach is best when you want to customize most or all details.</p> |
| <p>In <a href="#CJADIDDI">Example 2-5</a>, a DBWS service is constructed from existing EclipseLink project maps with identical case-sensitive aliases (for Descriptors that are common between the projects).</p> |
| <div class="example"><a id="CJADIDDI" name="CJADIDDI"></a><a id="TLDBW154" name="TLDBW154"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 2-5 Sample DBWS Service</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <object-persistence version="Eclipse Persistence Services - some version (some build date)" xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:eclipselink="http://www.eclipse.org/eclipselink/xsds/persistence"> |
| <name>SomeORProject</name> |
| <class-mapping-descriptors> |
| <class-mapping-descriptor xsi:type="relational-class-mapping-descriptor"> |
| <class>some.package.SomeClass</class> |
| <alias>SomeAlias</alias> |
| ... |
| |
| |
| <?xml version="1.0" encoding="UTF-8"?> |
| <object-persistence version="Eclipse Persistence Services - some version (some build date)" xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:eclipselink="http://www.eclipse.org/eclipselink/xsds/persistence"> |
| <name>SomeOXProject</name> |
| <class-mapping-descriptor xsi:type="xml-class-mapping-descriptor"> |
| <class>some.package.SomeClass</class> |
| <alias>SomeAlias</alias> |
| ... |
| |
| </pre></div> |
| <!-- class="example" --> |
| <div align="center"> |
| <div class="inftblnote"><br /> |
| <table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <tbody> |
| <tr> |
| <td align="left"> |
| <p class="note"><img src="../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p> |
| <p>When building a DBWS web service in this way (that is, without the <code>DBWSBuilder</code> Utility) be sure to create all the necessary deployment artifacts.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblnote" --></div> |
| </div> |
| <!-- class="sect2" --></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> </td> |
| <td align="center"><a href="creating_dbws_services001.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="creating_dbws_services003.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> </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> </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> </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 © 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> |
