blob: afc0096a75fe2aac52221318ff166af6e410dd19 [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>Using MetadataSource | EclipseLink 2.7 EclipseLink MOXy</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" />
<meta name="date" content="2014-06-10T10:25:31Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Using MetadataSource" />
<meta name="relnum" content="Release 2.7" />
<meta name="partnum" content="" />
<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="runtime003.htm" title="Previous" type="text/html" />
<link rel="next" href="runtime005.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"><div class="booktitle">Developing JAXB Applications Using EclipseLink MOXy,
<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>&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="runtime003.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="runtime005.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="CACDDJHJ" name="CACDDJHJ"></a><a id="TLJAX156" name="TLJAX156"></a>
<div class="sect1"><!-- infolevel="all" infotype="General" -->
<h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Using MetadataSource</font></h1>
<p>The <code>MetadataSource</code>, introduced in EclipseLink 2.3, is responsible for serving up EclipseLink metadata. This allows you to store mapping information outside of your application and have it retrieved when the application's <code>JAXBContext</code> is being created or refreshed.</p>
<a id="TLJAX157" name="TLJAX157"></a>
<div class="sect2"><a id="sthref34" name="sthref34"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Implementing a MetadataSource</font></h2>
<p>To implement your own <code>MetadataSource</code>, you can:</p>
<ul>
<li>
<p>Create a new class that implements the <code>org.eclipse.persistence.jaxb.metadata.MetadataSource interface</code>.</p>
</li>
<li>
<p>Create a new class that extends the <code>org.eclipse.persistence.jaxb.metadata.MetadataSourceAdapter</code> class. Using this method is preferred, as it will insulate you from future additions to the interface.</p>
</li>
</ul>
<p>In either case, you will be responsible for implementing the following method:</p>
<div class="example"><a id="TLJAX158" name="TLJAX158"></a><a id="sthref35" name="sthref35"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 2-20 Implementing the XMlBindings Method</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
/**
* Retrieve XmlBindings according to the JAXBContext bootstrapping information.
*
* @param properties - The properties passed in to create the JAXBContext
* @param classLoader - The ClassLoader passed in to create the JAXBContext
* @return the XmlBindings object representing the metadata
*/
XmlBindings getXmlBindings(Map&lt;String, ?&gt; properties, ClassLoader classLoader);
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="TLJAX159" name="TLJAX159"></a>
<div class="sect2"><a id="sthref36" name="sthref36"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Using an XmlBindings Object</font></h2>
<p>Internally, EclipseLink metadata is stored in an <code>XmlBindings</code> object, which itself is mapped with JAXB. This means that you can actually use a JAXB unmarshaller to read external metadata and create an <code>XmlBindings</code> from it:</p>
<div class="example"><a id="TLJAX160" name="TLJAX160"></a><a id="sthref37" name="sthref37"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 2-21 Sample XmlBindings Object</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import org.eclipse.persistence.jaxb.xmlmodel.XmlBindings;
...
JAXBContext xmlBindingsContext = JAXBContext.newInstance("org.eclipse.persistence.jaxb.xmlmodel");
FileReader bindingsFile = new FileReader("xml-bindings.xml");
XmlBindings bindings = (XmlBindings) xmlBindingsContext.createUnmarshaller().unmarshal(bindingsFile);
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="TLJAX161" name="TLJAX161"></a>
<div class="sect2"><a id="sthref38" name="sthref38"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Specifying the MetadataSource</font></h2>
<p>To use a <code>MetadataSource</code> in creating a <code>JAXBContext</code>, add it to the properties map with the key <code>JAXBContextProperties.OXM_METADATA_SOURCE</code>:</p>
<div class="example"><a id="TLJAX162" name="TLJAX162"></a><a id="sthref39" name="sthref39"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 2-22 Adding MetadataSource to the Properties Map</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
MetadataSource metadataSource = new MyMetadataSource();
Map&lt;String, Object&gt; properties = new HashMap&lt;String, Object&gt;(1);
properties.put(<strong>JAXBContextProperties.OXM_METADATA_SOURCE</strong>, metadataSource);
JAXBContext jc = JAXBContext.newInstance(new Class[] { Customer.class }, properties);
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="TLJAX163" name="TLJAX163"></a>
<div class="sect2"><a id="sthref40" name="sthref40"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">MetadataSource Example</font></h2>
<p>The following example creates an <code>XmlBindings</code> object by unmarshalling from a URL:</p>
<div class="example"><a id="TLJAX164" name="TLJAX164"></a><a id="sthref41" name="sthref41"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 2-23 Sample XmlBindings Object</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import java.net.URL;
import java.util.Map;
import javax.xml.bind.JAXBContext;
import org.eclipse.persistence.jaxb.metadata.MetadataSourceAdapter;
import org.eclipse.persistence.jaxb.xmlmodel.XmlBindings;
public class MyMetadataSource extends MetadataSourceAdapter {
private JAXBContext bindingsContext;
private URL bindingsUrl;
private final String XML_BINDINGS_PACKAGE = "org.eclipse.persistence.jaxb.xmlmodel";
private final String METADATA_URL = "http://www.example.com/private/metadata/xml-bindings.xml";
public MyMetadataSource() {
try {
bindingsContext = JAXBContext.newInstance(XML_BINDINGS_PACKAGE);
bindingsUrl = new URL(METADATA_URL);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
@Override
public XmlBindings getXmlBindings(Map&lt;String, ?&gt; properties, ClassLoader classLoader) {
try {
Unmarshaller u = bindingsContext.createUnmarshaller();
XmlBindings bindings = (XmlBindings) u.unmarshal(bindingsUrl);
return bindings;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
</pre></div>
<!-- class="example" --></div>
<!-- class="sect2" -->
<a id="TLJAX165" name="TLJAX165"></a>
<div class="sect2"><a id="sthref42" name="sthref42"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Building XmlBindings Programatically</font></h2>
<p>You also have the option of building your own <code>XmlBindings</code> object from scratch in code. The example below modifies the <code>pCode</code> field of the <strong>Address</strong> class to use a locale-specific name:</p>
<div class="example"><a id="TLJAX166" name="TLJAX166"></a><a id="sthref43" name="sthref43"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 2-24 Sample XmlBindings Object</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import java.util.Locale;
import java.util.Map;
import org.eclipse.persistence.jaxb.metadata.MetadataSourceAdapter;
import org.eclipse.persistence.jaxb.xmlmodel.JavaType;
import org.eclipse.persistence.jaxb.xmlmodel.JavaType.JavaAttributes;
import org.eclipse.persistence.jaxb.xmlmodel.ObjectFactory;
import org.eclipse.persistence.jaxb.xmlmodel.XmlBindings;
import org.eclipse.persistence.jaxb.xmlmodel.XmlBindings.JavaTypes;
import org.eclipse.persistence.jaxb.xmlmodel.XmlElement;
public class AddressMetadataSource extends MetadataSourceAdapter {
private ObjectFactory factory;
private XmlBindings xmlBindings;
public AddressMetadataSource() {
factory = new ObjectFactory();
xmlBindings = new XmlBindings();
xmlBindings.setPackageName("example");
xmlBindings.setJavaTypes(new JavaTypes());
}
@Override
public XmlBindings getXmlBindings(Map&lt;String, ?&gt; properties, ClassLoader classLoader) {
JavaType javaType = new JavaType();
javaType.setName("Address");
javaType.setJavaAttributes(new JavaAttributes());
XmlElement pCodeElement = new XmlElement();
pCodeElement.setJavaAttribute("pCode");
String country = Locale.getDefault().getCountry();
if (country.equals(Locale.US.getCountry())) {
pCodeElement.setName("zip-code");
} else if (country.equals(Locale.UK.getCountry())) {
pCodeElement.setName("post-code");
} else if (country.equals(Locale.CANADA.getCountry())) {
pCodeElement.setName("postal-code");
}
javaType.getJavaAttributes().getJavaAttribute().add(factory.createXmlElement(pCodeElement));
xmlBindings.getJavaTypes().getJavaType().add(javaType);
return xmlBindings;
}
}
</pre></div>
<!-- class="example" --></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>&nbsp;</td>
<td align="center"><a href="runtime003.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="runtime005.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; 2013 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>