blob: 3a6263a9bd5fb7fd8f22c0c1e07040203a55a205 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Wed Dec 06 14:36:24 CET 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.olingo.odata2.jpa.processor.api (olingo-odata2-parent 2.0.10 API)</title>
<meta name="date" content="2017-12-06">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.olingo.odata2.jpa.processor.api (olingo-odata2-parent 2.0.10 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/access/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.olingo.odata2.jpa.processor.api</h1>
<div class="docSummary">
<div class="block">OData JPA Processor API Library</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAContext.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAContext</a></td>
<td class="colLast">
<div class="block">This class does the compilation of context objects required for OData JPA
Runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAResponseBuilder.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPAResponseBuilder</a></td>
<td class="colLast">
<div class="block">The interface provides methods for building an OData response from a JPA Entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATransaction.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">ODataJPATransaction</a></td>
<td class="colLast">
<div class="block">Interface for JPA-Transaction abstraction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/OnJPAWriteContent.html" title="interface in org.apache.olingo.odata2.jpa.processor.api">OnJPAWriteContent</a></td>
<td class="colLast">
<div class="block"> The interface is a call back interface that enables OData JPA Processor to get JPA provider specific
implementation
of <b>java.sql.Blob</b> and <b>java.sql.Clob</b> instances.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPADefaultProcessor.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPADefaultProcessor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAProcessor.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPAProcessor</a></td>
<td class="colLast">
<div class="block">Extend this class and implement an OData JPA processor if the default
behavior of OData JPA Processor library has to be overwritten.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAQueryExtensionEntityListener.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPAQueryExtensionEntityListener</a></td>
<td class="colLast">
<div class="block">Extend this class to build JPA Query object for a given OData request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAServiceFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPAServiceFactory</a></td>
<td class="colLast">
<div class="block">
Extend this factory class and create own instance of <a href="../../../../../../../org/apache/olingo/odata2/api/ODataService.html" title="interface in org.apache.olingo.odata2.api"><code>ODataService</code></a> that
transforms Java Persistence
Models into an OData Service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneContext.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPATombstoneContext</a></td>
<td class="colLast">
<div class="block">This class provides a thread safe container for accessing Tombstone objects</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPATombstoneEntityListener.html" title="class in org.apache.olingo.odata2.jpa.processor.api">ODataJPATombstoneEntityListener</a></td>
<td class="colLast">
<div class="block">Extend this class and implement a JPA Entity Listener as specified in JSR 317 Java Persistence 2.0.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.olingo.odata2.jpa.processor.api Description">Package org.apache.olingo.odata2.jpa.processor.api Description</h2>
<div class="block"><h3>OData JPA Processor API Library</h3>
The library provides a way for the developers to create an OData Service from a Java Persistence Model.
The library supports Java Persistence 2.0 and is dependent on OData library.
To create an OData service from JPA models
<ol><li>extend the service factory class <a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAServiceFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAServiceFactory</code></a>
and implement the methods</li>
<li>define a JAX-RS servlet in web.xml and configure the service factory as servlet init parameter.
<p><b>See Also:</b><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/ODataJPAServiceFactory.html" title="class in org.apache.olingo.odata2.jpa.processor.api"><code>ODataJPAServiceFactory</code></a></li></ol></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/olingo/odata2/api/uri/info/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../../org/apache/olingo/odata2/jpa/processor/api/access/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/odata2/jpa/processor/api/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>