Added: websites/staging/olingo/trunk/content/doc/odata2/tutorials/CreateWebApp.html ============================================================================== --- websites/staging/olingo/trunk/content/doc/odata2/tutorials/CreateWebApp.html (added) +++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/CreateWebApp.html Tue Sep 16 12:34:18 2014 @@ -0,0 +1,332 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> +<html lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> + <meta name="author" content=""> + <link rel="icon" href="/favicon.ico"> + <title> + Apache Olingo + </title><!-- Bootstrap core CSS --> + <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link rel="stylesheet" href="/css/main.css"> + <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> +</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> + + <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> +</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="/js/html5shiv.min.js"></script> + <script src="/js/respond.min.js"></script> + <![endif]--> + </head> + + <body> + <div class="container"> + <!-- Static navbar --> + <div class="navbar navbar-default" role="navigation"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > + <a class="navbar-brand" href="#">Apache Olingoâ¢</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + + <li><a href="/">Home</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/";>ASF Home</a></li> + <li><a href="http://projects.apache.org/";>Projects</a></li> + <li><a href="http://people.apache.org/";>People</a></li> + <li><a href="http://www.apache.org/foundation/getinvolved.html";>Get Involved</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi";>Download</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Support Apache</a></li> + </ul> + </li> + + <li><a href="http://www.apache.org/licenses/";>License</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> + <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> + <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> + </ul> + </li> + <li><a href="/support.html">Support</a></li> + + </ul> + + <img class="navbar-right" height="50px" src="/img/asf-logo.gif"> + + </div><!--/.nav-collapse --> + </div><!--/.container-fluid --> + </div><!-- Main component for a primary marketing message or call to action --><h2 id="creating-a-web-application-project-for-transforming-jpa-models-into-odata-services">Creating a Web Application Project for Transforming JPA Models into OData Services</h2> +<p>In this section, information on how to create a web application (Maven) for transforming JPA Models into OData Services using OData JPA Processor Library is provided. +The table gives the list of Maven dependencies you need to include in the POM.xml of your application.</p> +<p><em>Note</em>: The following dependencies are applicable for an application using EclipseLink as the JPA Provider and HSQLDB as the database. However, you are free to use any JPA provider (like Hibernate, OpenJPA and so on) and database of your choice.</p> +<table> +<thead> +<tr> +<th>Group ID</th> +<th>Artifact ID</th> +<th>Version</th> +</tr> +</thead> +<tbody> +<tr> +<td>javax.servlet</td> +<td>servlet-api</td> +<td>2.5</td> +</tr> +<tr> +<td>org.apache.cxf</td> +<td>cxf-rt-frontend-jaxrs</td> +<td>2.7.5</td> +</tr> +<tr> +<td>org.slf4j</td> +<td>slf4j-log4j12</td> +<td>1.7.1</td> +</tr> +<tr> +<td>junit</td> +<td>junit</td> +<td>3.8.1</td> +</tr> +<tr> +<td>org.apache.olingo</td> +<td>olingo.odata2.api</td> +<td>1.0.0</td> +</tr> +<tr> +<td>org.apache.olingo</td> +<td>olingo.odata2.jpa.processor.api</td> +<td>1.0.0</td> +</tr> +<tr> +<td>org.apache.olingo</td> +<td>olingo.odata2.jpa.processor.core</td> +<td>1.0.0</td> +</tr> +<tr> +<td>org.apache.olingo</td> +<td>olingo.odata2.jpa.processor.ref</td> +<td>1.0.0</td> +</tr> +<tr> +<td>org.apache.olingo</td> +<td>olingo.odata2.core</td> +<td>1.0.0</td> +</tr> +<tr> +<td>org.eclipse.persistence</td> +<td>eclipselink</td> +<td>2.3.1</td> +</tr> +<tr> +<td>org.eclipse.persistence</td> +<td>javax.persistence</td> +<td>2.0.5</td> +</tr> +<tr> +<td>org.hsqldb</td> +<td>hsqldb</td> +<td>2.2.8</td> +</tr> +</tbody> +</table> +<p>Here is a <a href="https://cms.apache.org/olingo/wc/browse/deepa-udCb40/trunk/content/resources/SampleJPAModel";>Sample JPA Model</a> </p> +<h5 id="create-a-dynamic-web-application-project-from-scratch">Create a Dynamic Web Application Project from Scratch:</h5> +<ol> +<li> +<p>In the command prompt, enter the maven command given here (change the DgroupId and DartifactId as per your requirement)</p> +<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">archetype</span><span class="p">:</span><span class="n">generate</span> <span class="o">-</span><span class="n">DgroupId</span><span class="p">=</span><span class="n">com</span><span class="p">.</span><span class="n">sample</span><span class="p">.</span><span class="n">jpa</span> <span class="o">-</span><span class="n">DartifactId</span><span class="p">=</span><span class="n">salesorderprocessing</span><span class="p">.</span><span class="n">app</span> <span class="o">-</span><span class="n">DarchetypeArtifactId</span><span class="p">=</span><span class="n">maven</span><span class="o">-</span><span class="n">archetype</span><span class="o">-</span><span class="n">webapp</span> +</pre></div> + + +<p>Maven generates the file system structure for a web application project including a basic POM.xml. This step is completed by creating a Java source folder.</p> +</li> +<li> +<p>Create a folder by name 'java' in the path 'src/main/'.</p> +</li> +</ol> +<h5 id="tailor-pomxml">Tailor POM.xml</h5> +<p>POM.xml should be modified for adding dependencies like OData Library (Java) and OData JPA Processor Library. Add a dependency to the project that contains JPA models. Open POM.xml and replace the existing content with the following:</p> +<div class="codehilite"><pre> <span class="cp"><?xml version="1.0" ?></span> + <span class="nt"><project</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"</span> <span class="na">xmlns=</span><span class="s">"http://maven.apache.org/POM/4.0.0"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span><span class="nt">></span> + <span class="nt"><modelVersion></span>4.0.0<span class="nt"></modelVersion></span> + <span class="nt"><parent></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-parent<span class="nt"></artifactId></span> + <span class="nt"><version></span>1.0.0<span class="nt"></version></span> + <span class="nt"><relativePath></span>..<span class="nt"></relativePath></span> + <span class="nt"></parent></span> + <span class="nt"><artifactId></span>olingo.odata2.jpa.processor.ref.web<span class="nt"></artifactId></span> + <span class="nt"><packaging></span>war<span class="nt"></packaging></span> + <span class="nt"><name></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">groupId</span><span class="cp">}</span>-<span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">artifactId</span><span class="cp">}</span><span class="nt"></name></span> + <span class="nt"><dependencies></span> + <span class="nt"><dependency></span> + <span class="c"><!-- required because of auto detection of web facet 2.5 --></span> + <span class="nt"><groupId></span>javax.servlet<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>servlet-api<span class="nt"></artifactId></span> + <span class="nt"><version></span>2.5<span class="nt"></version></span> + <span class="nt"><scope></span>provided<span class="nt"></scope></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.cxf<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>cxf-rt-frontend-jaxrs<span class="nt"></artifactId></span> + <span class="nt"><version></span>2.7.5<span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-core<span class="nt"></artifactId></span> + <span class="nt"><version></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-api<span class="nt"></artifactId></span> + <span class="nt"><version></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-jpa-processor-api<span class="nt"></artifactId></span> + <span class="nt"><version></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-jpa-processor-core<span class="nt"></artifactId></span> + <span class="nt"><version></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>olingo-odata2-jpa-processor-ref<span class="nt"></artifactId></span> + <span class="nt"><version></span><span class="cp">${</span><span class="n">project</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.slf4j<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>slf4j-log4j12<span class="nt"></artifactId></span> + <span class="nt"><version></span>1.7.1<span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>junit<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>junit<span class="nt"></artifactId></span> + <span class="nt"><version></span>3.8.1<span class="nt"></version></span> + <span class="nt"><scope></span>test<span class="nt"></scope></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.eclipse.persistence<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>eclipselink<span class="nt"></artifactId></span> + <span class="nt"><version></span>2.3.1<span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.eclipse.persistence<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>javax.persistence<span class="nt"></artifactId></span> + <span class="nt"><version></span>2.0.5<span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"><dependency></span> + <span class="nt"><groupId></span>org.hsqldb<span class="nt"></groupId></span> + <span class="nt"><artifactId></span>hsqldb<span class="nt"></artifactId></span> + <span class="nt"><version></span>2.2.8<span class="nt"></version></span> + <span class="nt"></dependency></span> + <span class="nt"></dependencies></span> + <span class="nt"><build></span> + <span class="nt"><finalName></span>olingo.odata2.jpa.processor.ref.web<span class="nt"></finalName></span> + <span class="nt"></build></span> + <span class="nt"></project></span> +</pre></div> + + +<h5 id="implement-an-odata-service">Implement an OData Service</h5> +<p>The project is now ready to expose OData services. Service Factory provides a means for initializing Entity Data Model (EDM) Provider and OData JPA Processors. Following are the steps for implementing a Service Factory:</p> +<ol> +<li>Add a new Java class by extending ODataJPAServiceFactory.</li> +<li>Declare persistence unit name as class variable. For example, private static final String PUNIT_NAME = "persistenceUnitName"; + <em>Note</em>: The PUNIT_NAME refers to the persistence unit name maintained in the persistence.xml of JPA project.</li> +<li> +<p>Implement the abstract method <code>initializeODataJPAContext</code>. Here is the code snippet:</p> +<div class="codehilite"><pre><span class="n">ODataJPAContext</span> <span class="n">oDataJPAContext</span> <span class="p">=</span> <span class="n">getODataJPAContext</span><span class="p">();</span> +<span class="n">oDataJPAContext</span><span class="p">.</span><span class="n">setEntityManagerFactory</span><span class="p">(</span><span class="n">JPAEntityManagerFactory</span><span class="p">.</span><span class="n">getEntityManagerFactory</span><span class="p">(</span><span class="n">PUNIT_NAME</span><span class="p">));</span> +<span class="n">oDataJPAContext</span><span class="p">.</span><span class="n">setPersistenceUnitName</span><span class="p">(</span><span class="n">PUNIT_NAME</span><span class="p">);</span> +</pre></div> + + +</li> +</ol> +<h5 id="configure-the-web-application">Configure the Web Application</h5> +<ol> +<li>Configure the web application as shown below by adding the following servlet configuration to web.xml. The Service factory which was implemented is configured in the web.xml of the ODataApplication as one of the init parameters.</li> +<li> +<p>Replace in the following XML with the class name you created in the previous step:</p> +<div class="codehilite"><pre>- <span class="nt"><servlet></span> + <span class="nt"><servlet-name></span>JPARefScenarioServlet<span class="nt"></servlet-name></span> + <span class="nt"><servlet-class></span>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet<span class="nt"></servlet-class></span> + - <span class="nt"><init-param></span> + <span class="nt"><param-name></span>javax.ws.rs.Application<span class="nt"></param-name></span> + <span class="nt"><param-value></span>org.apache.olingo.odata2.core.rest.app.ODataApplication<span class="nt"></param-value></span> + <span class="nt"></init-param></span> + - <span class="nt"><init-param></span> + <span class="nt"><param-name></span>org.apache.olingo.odata2.service.factory<span class="nt"></param-name></span> + <span class="nt"><param-value></span>org.apache.olingo.odata2.jpa.processor.ref.web.JPAReferenceServiceFactory<span class="nt"></param-value></span> + <span class="nt"></init-param></span> + <span class="nt"><load-on-startup></span>1<span class="nt"></load-on-startup></span> + <span class="nt"></servlet></span> +- <span class="nt"><servlet-mapping></span> + <span class="nt"><servlet-name></span>JPARefScenarioServlet<span class="nt"></servlet-name></span> + <span class="nt"><url-pattern></span>/SalesOrderProcessing.svc/*<span class="nt"></url-pattern></span> + <span class="nt"></servlet-mapping></span> +</pre></div> + + +</li> +</ol> +<p>After the implementation, test the web application using http://localhost:8080/olingo.odata2.jpa.processor.ref.web/SalesOrderProcessing.svc</p><div align="center"> +<p>Copyright © 2013-2014, The Apache Software Foundation<br> + Apache Olingo, Olingo, Apache, the Apache feather, and + the Apache Olingo project logo are trademarks of the Apache Software + Foundation.</p> + <small><a href="/doc/odata2/privacy.html">Privacy</a></small> + </div> + </div><!-- /container --> + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="/js/jquery.js" type="text/javascript"> +</script> + <script src="/js/bootstrap.js" type="text/javascript"> + <script src="/js/offcanvas.js" type="text/javascript"> +</script> + <!-- Google Analytics: change UA-XXXXX-X to be your site's ID. --> + <script> + (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]= + function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date; + e=o.createElement(i);r=o.getElementsByTagName(i)[0]; + e.src='//www.google-analytics.com/analytics.js'; + r.parentNode.insertBefore(e,r)}(window,document,'script','ga')); + ga('create','UA-44963757-1');ga('send','pageview'); + </script> + </body> +</html>
Added: websites/staging/olingo/trunk/content/doc/odata2/tutorials/CustomODataJPAProcessor.html ============================================================================== --- websites/staging/olingo/trunk/content/doc/odata2/tutorials/CustomODataJPAProcessor.html (added) +++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/CustomODataJPAProcessor.html Tue Sep 16 12:34:18 2014 @@ -0,0 +1,147 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> +<html lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> + <meta name="author" content=""> + <link rel="icon" href="/favicon.ico"> + <title> + Apache Olingo + </title><!-- Bootstrap core CSS --> + <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link rel="stylesheet" href="/css/main.css"> + <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> +</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> + + <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> +</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="/js/html5shiv.min.js"></script> + <script src="/js/respond.min.js"></script> + <![endif]--> + </head> + + <body> + <div class="container"> + <!-- Static navbar --> + <div class="navbar navbar-default" role="navigation"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > + <a class="navbar-brand" href="#">Apache Olingoâ¢</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + + <li><a href="/">Home</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/";>ASF Home</a></li> + <li><a href="http://projects.apache.org/";>Projects</a></li> + <li><a href="http://people.apache.org/";>People</a></li> + <li><a href="http://www.apache.org/foundation/getinvolved.html";>Get Involved</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi";>Download</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Support Apache</a></li> + </ul> + </li> + + <li><a href="http://www.apache.org/licenses/";>License</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> + <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> + <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> + </ul> + </li> + <li><a href="/support.html">Support</a></li> + + </ul> + + <img class="navbar-right" height="50px" src="/img/asf-logo.gif"> + + </div><!--/.nav-collapse --> + </div><!--/.container-fluid --> + </div><!-- Main component for a primary marketing message or call to action --><h2 id="custom-odata-jpa-processor">Custom OData JPA Processor</h2> +<p>OData JPA Processor Library along with transforming an existing JPA model as EDM with no or minimalistic coding also processes the OData request and generates the OData response. However, at times it is required for an application using OData JPA Processor Library to perform some pre-processing of requests and post-processing of responses. To enable this in the application, following steps needs to be performed. </p> +<p>Custom OData JPA Processor is supported from Apache Olingo release 1.1.0 onwards.</p> +<p>a) Write a Custom OData JPA Processor by extending the class <code>org.apache.olingo.odata2.jpa.processor.api.ODataJPAProcessor</code>. In the code snippet below, pre-process and post-process are two private methods that can be written to process the request and response. The instance variable (part of ODataJPAProcessor) <code>jpaProcessor</code> can be used to process the OData request. The <code>jpaProcessor</code> returns the JPA entities after processing the OData request. The instance variable <code>responseBuilder</code> can be used for building the OData response from the processed JPA entities.</p> +<div class="codehilite"><pre> <span class="n">public</span> <span class="n">class</span> <span class="n">CustomODataJPAProcessor</span> <span class="n">extends</span> <span class="n">ODataJPAProcessor</span><span class="p">{</span> + + <span class="p">@</span><span class="n">Override</span> + <span class="n">public</span> <span class="n">ODataResponse</span> <span class="n">readEntitySet</span><span class="p">(</span><span class="n">final</span> <span class="n">GetEntitySetUriInfo</span> <span class="n">uriParserResultView</span><span class="p">,</span> <span class="n">final</span> <span class="n">String</span> <span class="n">contentType</span><span class="p">)</span> + <span class="n">throws</span> <span class="n">ODataException</span> <span class="p">{</span> + + <span class="o">/*</span> <span class="n">Pre</span> <span class="n">Process</span> <span class="n">Step</span> <span class="o">*/</span> + <span class="n">preprocess</span> <span class="p">(</span> <span class="p">);</span> + + <span class="n">List</span><span class="o"><</span><span class="n">Object</span><span class="o">></span> <span class="n">jpaEntities</span> <span class="p">=</span> <span class="n">jpaProcessor</span><span class="p">.</span><span class="n">process</span><span class="p">(</span><span class="n">uriParserResultView</span><span class="p">);</span> + + <span class="o">/*</span> <span class="n">Post</span> <span class="n">Process</span> <span class="n">Step</span> <span class="o">*/</span> + <span class="n">postProcess</span><span class="p">(</span> <span class="p">);</span> + + <span class="n">ODataResponse</span> <span class="n">oDataResponse</span> <span class="p">=</span> + <span class="n">responseBuilder</span><span class="p">.</span><span class="n">build</span><span class="p">(</span><span class="n">uriParserResultView</span><span class="p">,</span> <span class="n">jpaEntities</span><span class="p">,</span> <span class="n">contentType</span><span class="p">);</span> + + <span class="k">return</span> <span class="n">oDataResponse</span><span class="p">;</span> + <span class="p">}</span> + + <span class="p">}</span> +</pre></div> + + +<p>b) Write a Custom OData JPA Service Factory. Implement an OData JPA service factory to create an OData service with custom OData JPA Processor. The default service factory <code>org.apache.olingo.odata2.jpa.processor.api.ODataJPAServiceFactory</code> part of the library cannot be used. Hence, create a class by extending <code>org.apache.olingo.odata2.api.ODataServiceFactory</code>. Follow the steps below to hook an existing flow to a custom OData JPA Processor. Copy the entire code from <code>ODataJPAServiceFactory</code> and replace the code as shown below. </p> +<div class="codehilite"><pre> <span class="n">ODataSingleProcessor</span> <span class="n">odataJPAProcessor</span> <span class="p">=</span> <span class="n">accessFactory</span><span class="p">.</span><span class="n">createODataProcessor</span><span class="p">(</span><span class="n">oDataJPAContext</span><span class="p">);</span> + +<span class="n">with</span> + + <span class="n">ODataSingleProcessor</span> <span class="n">odataJPAProcessor</span> <span class="p">=</span> <span class="n">new</span> <span class="n">CustomODataJPAProcessor</span><span class="p">(</span><span class="n">oDataJPAContext</span><span class="p">);</span> +</pre></div><div align="center"> +<p>Copyright © 2013-2014, The Apache Software Foundation<br> + Apache Olingo, Olingo, Apache, the Apache feather, and + the Apache Olingo project logo are trademarks of the Apache Software + Foundation.</p> + <small><a href="/doc/odata2/privacy.html">Privacy</a></small> + </div> + </div><!-- /container --> + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="/js/jquery.js" type="text/javascript"> +</script> + <script src="/js/bootstrap.js" type="text/javascript"> + <script src="/js/offcanvas.js" type="text/javascript"> +</script> + <!-- Google Analytics: change UA-XXXXX-X to be your site's ID. --> + <script> + (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]= + function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date; + e=o.createElement(i);r=o.getElementsByTagName(i)[0]; + e.src='//www.google-analytics.com/analytics.js'; + r.parentNode.insertBefore(e,r)}(window,document,'script','ga')); + ga('create','UA-44963757-1');ga('send','pageview'); + </script> + </body> +</html> Added: websites/staging/olingo/trunk/content/doc/odata2/tutorials/DeltaQuerySupport.html ============================================================================== --- websites/staging/olingo/trunk/content/doc/odata2/tutorials/DeltaQuerySupport.html (added) +++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/DeltaQuerySupport.html Tue Sep 16 12:34:18 2014 @@ -0,0 +1,183 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> +<html lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> + <meta name="author" content=""> + <link rel="icon" href="/favicon.ico"> + <title> + Apache Olingo + </title><!-- Bootstrap core CSS --> + <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link rel="stylesheet" href="/css/main.css"> + <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> +</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> + + <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> +</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="/js/html5shiv.min.js"></script> + <script src="/js/respond.min.js"></script> + <![endif]--> + </head> + + <body> + <div class="container"> + <!-- Static navbar --> + <div class="navbar navbar-default" role="navigation"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > + <a class="navbar-brand" href="#">Apache Olingoâ¢</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + + <li><a href="/">Home</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/";>ASF Home</a></li> + <li><a href="http://projects.apache.org/";>Projects</a></li> + <li><a href="http://people.apache.org/";>People</a></li> + <li><a href="http://www.apache.org/foundation/getinvolved.html";>Get Involved</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi";>Download</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Support Apache</a></li> + </ul> + </li> + + <li><a href="http://www.apache.org/licenses/";>License</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> + <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> + <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> + </ul> + </li> + <li><a href="/support.html">Support</a></li> + + </ul> + + <img class="navbar-right" height="50px" src="/img/asf-logo.gif"> + + </div><!--/.nav-collapse --> + </div><!--/.container-fluid --> + </div><!-- Main component for a primary marketing message or call to action --><h2 id="delta-token-support">Delta Token Support</h2> +<p>Delta Query retrieves the changes done to a service. It is supported in OData JPA Processor Library from version 1.4.0. The data returned by the feed for the query would look exactly like any other dataset for an OData query but with delta link at the end. </p> +<p>There are two approaches you can follow to generate delta token.</p> +<h3 id="generating-delta-token">Generating Delta Token</h3> +<h5 id="first-approach">First Approach</h5> +<p>a. Create a Java class by extending <code>ODataJPATombstoneEntityListener.java</code>.</p> +<p>b. Implement the abstract method <code>getQuery</code>. In the method, implement the logic to generate a <code>javax.persistence.Query</code>. The Query object can be created as shown below in the code snippet. </p> +<div class="codehilite"><pre> <span class="k">if</span> <span class="p">(</span>!<span class="n">resultsView</span><span class="p">.</span><span class="n">getStartEntitySet</span><span class="p">().</span><span class="n">getName</span><span class="p">().</span><span class="n">equals</span><span class="p">(</span><span class="n">resultsView</span><span class="p">.</span><span class="n">getTargetEntitySet</span><span class="p">().</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span> + <span class="n">contextType</span> <span class="p">=</span> <span class="n">JPQLContextType</span><span class="p">.</span><span class="n">JOIN</span><span class="p">;</span> + <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> + <span class="n">contextType</span> <span class="p">=</span> <span class="n">JPQLContextType</span><span class="p">.</span><span class="n">SELECT</span><span class="p">;</span> + <span class="p">}</span> + + <span class="n">JPQLContext</span> <span class="n">jpqlContext</span> <span class="p">=</span> <span class="n">JPQLContext</span><span class="p">.</span><span class="n">createBuilder</span><span class="p">(</span><span class="n">contextType</span><span class="p">,</span> <span class="n">resultsView</span><span class="p">).</span><span class="n">build</span><span class="p">();</span> + <span class="n">JPQLStatement</span> <span class="n">jpqlStatement</span> <span class="p">=</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">createBuilder</span><span class="p">(</span><span class="n">jpqlContext</span><span class="p">).</span><span class="n">build</span><span class="p">();</span> + + <span class="n">Query</span> <span class="n">query</span> <span class="p">=</span> <span class="n">em</span><span class="p">.</span><span class="n">createQuery</span><span class="p">(</span><span class="n">jpqlStatement</span><span class="p">);</span> +</pre></div> + + +<p>The <code>JPQLStatement</code> is generated based on the OData request (resultsView). The generated <code>JPQLStatement</code> can be enhanced to introduce conditions that filters and fetches delta JPA Entities. To enhance the <code>JPQLStatement</code> and add a condition to the WHERE Clause, refer to the following code snippet.</p> +<p><em>Note</em>: It is up to the JPA application developers to come up with a logic suitable for their use case.</p> +<div class="codehilite"><pre> <span class="n">String</span> <span class="n">deltaToken</span> <span class="p">=</span> <span class="n">ODataJPATombstoneContext</span><span class="p">.</span><span class="n">getDeltaToken</span><span class="p">();</span> + + <span class="n">Query</span> <span class="n">query</span> <span class="p">=</span> <span class="n">null</span><span class="p">;</span> + <span class="k">if</span> <span class="p">(</span><span class="n">deltaToken</span> !<span class="p">=</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span> + <span class="n">String</span> <span class="n">statement</span> <span class="p">=</span> <span class="n">jpqlStatement</span><span class="p">.</span><span class="n">toString</span><span class="p">();</span> + <span class="n">String</span><span class="p">[]</span> <span class="n">statementParts</span> <span class="p">=</span> <span class="n">statement</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="n">JPQLStatement</span><span class="p">.</span><span class="n">KEYWORD</span><span class="p">.</span><span class="n">WHERE</span><span class="p">);</span> + <span class="n">String</span> <span class="n">deltaCondition</span> <span class="p">=</span> <span class="n">jpqlContext</span><span class="p">.</span><span class="n">getJPAEntityAlias</span><span class="p">()</span> <span class="o">+</span> "<span class="p">.</span><span class="n">creationDate</span> <span class="o">></span><span class="p">=</span> <span class="p">{</span><span class="n">ts</span> <span class="s">'" + deltaToken + "'</span><span class="p">}</span>"<span class="p">;</span> + <span class="k">if</span> <span class="p">(</span><span class="n">statementParts</span><span class="p">.</span><span class="nb">length</span> <span class="o">></span> 1<span class="p">)</span> + <span class="p">{</span> + <span class="n">statement</span> <span class="p">=</span> <span class="n">statementParts</span><span class="p">[</span>0<span class="p">]</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">DELIMITER</span><span class="p">.</span><span class="n">SPACE</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">KEYWORD</span><span class="p">.</span><span class="n">WHERE</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">DELIMITER</span><span class="p">.</span><span class="n">SPACE</span> <span class="o">+</span> <span class="n">deltaCondition</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">DELIMITER</span><span class="p">.</span><span class="n">SPACE</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">Oper ator</span><span class="p">.</span><span class="n">AND</span> <span class="o">+</span> <span class="n">statementParts</span><span class="p">[</span>1<span class="p">];</span> + <span class="p">}</span> + <span class="k">else</span> <span class="p">{</span> + <span class="n">statement</span> <span class="p">=</span> <span class="n">statementParts</span><span class="p">[</span>0<span class="p">]</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">DELIMITER</span><span class="p">.</span><span class="n">SPACE</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">KEYWORD</span><span class="p">.</span><span class="n">WHERE</span> <span class="o">+</span> <span class="n">JPQLStatement</span><span class="p">.</span><span class="n">DELIMITER</span><span class="p">.</span><span class="n">SPACE</span> <span class="o">+</span> <span class="n">deltaCondition</span><span class="p">;</span> + <span class="p">}</span> + + <span class="n">query</span> <span class="p">=</span> <span class="n">em</span><span class="p">.</span><span class="n">createQuery</span><span class="p">(</span><span class="n">statement</span><span class="p">);</span> + <span class="p">}</span> + <span class="k">else</span> + <span class="n">query</span> <span class="p">=</span> <span class="n">em</span><span class="p">.</span><span class="n">createQuery</span><span class="p">(</span><span class="n">jpqlStatement</span><span class="p">.</span><span class="n">toString</span><span class="p">());</span> +</pre></div> + + +<p>c. Implement the method <code>generateDeltaToken</code> to generate a string representation of the delta token. The delta token generated shall be used by the client applications to fetch delta in their subsequent OData requests.</p> +<div class="codehilite"><pre> <span class="n">SimpleDateFormat</span> <span class="n">dateFormat</span> <span class="p">=</span> <span class="n">new</span> <span class="n">SimpleDateFormat</span><span class="p">(</span>"<span class="n">yyyy</span><span class="o">-</span><span class="n">MM</span><span class="o">-</span><span class="n">dd</span> <span class="n">HH</span><span class="p">:</span><span class="n">mm</span><span class="p">:</span><span class="n">ss</span><span class="p">.</span>000"<span class="p">);;</span> + <span class="n">Date</span> <span class="n">date</span> <span class="p">=</span> <span class="n">new</span> <span class="n">Date</span><span class="p">(</span><span class="n">System</span><span class="p">.</span><span class="n">currentTimeMillis</span><span class="p">());</span> + <span class="n">dateFormat</span><span class="p">.</span><span class="n">format</span><span class="p">(</span><span class="n">date</span><span class="p">);</span> + <span class="k">return</span> <span class="n">dateFormat</span><span class="p">.</span><span class="n">format</span><span class="p">(</span><span class="n">date</span><span class="p">);</span> +</pre></div> + + +<p>d. Register the class (created above) as an Entity Listener in JPA Entity.</p> +<div class="codehilite"><pre> <span class="p">@</span><span class="n">Entity</span> + <span class="p">@</span><span class="n">Table</span><span class="p">(</span><span class="n">name</span> <span class="p">=</span> "<span class="n">T_SALESORDERHEADER</span>"<span class="p">)</span> + <span class="p">@</span><span class="n">EntityListeners</span><span class="p">(</span><span class="n">com</span><span class="p">.</span><span class="n">sap</span><span class="p">.</span><span class="n">core</span><span class="p">.</span><span class="n">odata</span><span class="p">.</span><span class="n">processor</span><span class="p">.</span><span class="n">ref</span><span class="p">.</span><span class="n">jpa</span><span class="p">.</span><span class="n">listners</span><span class="p">.</span><span class="n">SalesOrderTombstoneListner</span><span class="p">.</span><span class="n">class</span><span class="p">)</span> + <span class="n">public</span> <span class="n">class</span> <span class="n">SalesOrderHeader</span> <span class="p">{</span> +</pre></div> + + +<h5 id="second-approach">Second Approach</h5> +<p>The OData JPA Processor Library also provides support so that the JPA application developer can write a call back method in the Entity Listener class and annotate them with <code>javax.persistence.PostLoad</code>. Such call back methods are executed by JPA providers in a stateless manner for every record fetched from the database table. In the call back method, logic can be provided to decide whether a JPA entity fetched from the database table is a delta or not as shown below:</p> +<div class="codehilite"><pre> <span class="p">@</span><span class="n">PostLoad</span> + <span class="n">public</span> <span class="n">void</span> <span class="n">handleDelta</span><span class="p">(</span><span class="n">Object</span> <span class="n">entity</span><span class="p">)</span> <span class="p">{</span> + <span class="n">SalesOrderHeader</span> <span class="n">so</span> <span class="p">=</span> <span class="p">(</span><span class="n">SalesOrderHeader</span><span class="p">)</span> <span class="n">entity</span><span class="p">;</span> + <span class="k">if</span> <span class="p">(</span><span class="n">so</span><span class="p">.</span><span class="n">getCreationDate</span><span class="p">().</span><span class="n">getTime</span><span class="p">()</span> <span class="o"><</span> <span class="n">ODataJPATombstoneContext</span><span class="p">.</span><span class="n">getDeltaTokenUTCTimeStamp</span><span class="p">())</span> + <span class="k">return</span><span class="p">;</span> + <span class="k">else</span> + <span class="n">addToDelta</span><span class="p">(</span><span class="n">entity</span><span class="p">,</span><span class="n">ENTITY_NAME</span><span class="p">);</span> + <span class="p">}</span> +</pre></div><div align="center"> +<p>Copyright © 2013-2014, The Apache Software Foundation<br> + Apache Olingo, Olingo, Apache, the Apache feather, and + the Apache Olingo project logo are trademarks of the Apache Software + Foundation.</p> + <small><a href="/doc/odata2/privacy.html">Privacy</a></small> + </div> + </div><!-- /container --> + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="/js/jquery.js" type="text/javascript"> +</script> + <script src="/js/bootstrap.js" type="text/javascript"> + <script src="/js/offcanvas.js" type="text/javascript"> +</script> + <!-- Google Analytics: change UA-XXXXX-X to be your site's ID. --> + <script> + (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]= + function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date; + e=o.createElement(i);r=o.getElementsByTagName(i)[0]; + e.src='//www.google-analytics.com/analytics.js'; + r.parentNode.insertBefore(e,r)}(window,document,'script','ga')); + ga('create','UA-44963757-1');ga('send','pageview'); + </script> + </body> +</html> Added: websites/staging/olingo/trunk/content/doc/odata2/tutorials/ExtendingtheEDM.html ============================================================================== --- websites/staging/olingo/trunk/content/doc/odata2/tutorials/ExtendingtheEDM.html (added) +++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/ExtendingtheEDM.html Tue Sep 16 12:34:18 2014 @@ -0,0 +1,175 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> +<html lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> + <meta name="author" content=""> + <link rel="icon" href="/favicon.ico"> + <title> + Apache Olingo + </title><!-- Bootstrap core CSS --> + <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link rel="stylesheet" href="/css/main.css"> + <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> +</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> + + <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> +</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="/js/html5shiv.min.js"></script> + <script src="/js/respond.min.js"></script> + <![endif]--> + </head> + + <body> + <div class="container"> + <!-- Static navbar --> + <div class="navbar navbar-default" role="navigation"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > + <a class="navbar-brand" href="#">Apache Olingoâ¢</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + + <li><a href="/">Home</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/";>ASF Home</a></li> + <li><a href="http://projects.apache.org/";>Projects</a></li> + <li><a href="http://people.apache.org/";>People</a></li> + <li><a href="http://www.apache.org/foundation/getinvolved.html";>Get Involved</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi";>Download</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Support Apache</a></li> + </ul> + </li> + + <li><a href="http://www.apache.org/licenses/";>License</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> + <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> + <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> + </ul> + </li> + <li><a href="/support.html">Support</a></li> + + </ul> + + <img class="navbar-right" height="50px" src="/img/asf-logo.gif"> + + </div><!--/.nav-collapse --> + </div><!--/.container-fluid --> + </div><!-- Main component for a primary marketing message or call to action --><h1 id="extending-the-edm-generated-from-the-jpa-models">Extending the EDM Generated from the JPA Models</h1> +<p>The Entity Data Model (EDM) generated from the JPA models can be extended with new Entity Types, Complex Types and also the existing EDM elements can be modified by implementing the interface method <code>org.apache.olingo.odata2.jpa.processor.api.model.JPAEdmExtension.extendJPAEdmSchema</code>.</p> +<p>Link to the code - <a href="https://git-wip-us.apache.org/repos/asf?p=olingo-odata2.git;a=blob;f=odata2-jpa-processor/jpa-web/src/main/java/org/apache/olingo/odata2/jpa/processor/ref/extension/SalesOrderProcessingExtension.java;h=3dacd7e727528cb79cb3d4a878ac53d0a4b25277;hb=ecdc476";>Support EDM Extension</a></p> +<h4 id="how-to-add-a-complex-type-to-an-edm">How to Add a Complex Type to an EDM</h4> +<p>Consider a scenario where we have a Plain Old Java Object (POJO) in the OrderValue Java class and let us try to transform this POJO into a Complex Type in the EDM. </p> +<h6 id="pojo-in-ordervalue-java-class">POJO in OrderValue Java Class</h6> +<div class="codehilite"><pre> <span class="n">public</span> <span class="n">class</span> <span class="n">OrderValue</span> + <span class="p">{</span> + + <span class="n">private</span> <span class="n">double</span> <span class="n">amount</span><span class="p">;</span> + <span class="n">private</span> <span class="n">String</span> <span class="n">currency</span><span class="p">;</span> + + <span class="n">public</span> <span class="n">double</span> <span class="n">getAmount</span><span class="p">()</span> + + <span class="p">{</span> <span class="k">return</span> <span class="n">amount</span><span class="p">;</span> <span class="p">}</span> + <span class="n">public</span> <span class="n">void</span> <span class="n">setAmount</span><span class="p">(</span><span class="n">double</span> <span class="n">amount</span><span class="p">)</span> + + <span class="p">{</span> <span class="n">this</span><span class="p">.</span><span class="n">amount</span> <span class="p">=</span> <span class="n">amount</span><span class="p">;</span> <span class="p">}</span> + <span class="n">public</span> <span class="n">String</span> <span class="n">getCurrency</span><span class="p">()</span> + + <span class="p">{</span> <span class="k">return</span> <span class="n">currency</span><span class="p">;</span> <span class="p">}</span> + <span class="n">public</span> <span class="n">void</span> <span class="n">setCurrency</span><span class="p">(</span><span class="n">String</span> <span class="n">currency</span><span class="p">)</span> + + <span class="p">{</span> <span class="n">this</span><span class="p">.</span><span class="n">currency</span> <span class="p">=</span> <span class="n">currency</span><span class="p">;</span> <span class="p">}</span> + + <span class="p">}</span> +</pre></div> + + +<p>Here is an example where the <code>SalesOrderProcessingExtension</code> implements the <code>JPAEdmExtension</code>. </p> +<h5 id="sample-code">Sample Code</h5> +<div class="codehilite"><pre> <span class="p">@</span><span class="n">Override</span> + <span class="n">public</span> <span class="n">void</span> <span class="n">extendJPAEdmSchema</span><span class="p">(</span><span class="n">final</span> <span class="n">JPAEdmSchemaView</span> <span class="n">view</span><span class="p">)</span> <span class="p">{</span> + <span class="n">Schema</span> <span class="n">edmSchema</span> <span class="p">=</span> <span class="n">view</span><span class="p">.</span><span class="n">getEdmSchema</span><span class="p">();</span> + <span class="n">edmSchema</span><span class="p">.</span><span class="n">getComplexTypes</span><span class="p">().</span><span class="n">add</span><span class="p">(</span><span class="n">getComplexType</span><span class="p">());</span> + <span class="p">}</span> + + <span class="n">private</span> <span class="n">ComplexType</span> <span class="n">getComplexType</span><span class="p">()</span> <span class="p">{</span> + <span class="n">ComplexType</span> <span class="n">complexType</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ComplexType</span><span class="p">();</span> + + <span class="n">List</span><span class="o"><</span><span class="n">Property</span><span class="o">></span> <span class="k">properties</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Property</span><span class="o">></span><span class="p">();</span> + <span class="n">SimpleProperty</span> <span class="n">property</span> <span class="p">=</span> <span class="n">new</span> <span class="n">SimpleProperty</span><span class="p">();</span> + + <span class="n">property</span><span class="p">.</span><span class="n">setName</span><span class="p">(</span>"<span class="n">Amount</span>"<span class="p">);</span> + <span class="n">property</span><span class="p">.</span><span class="n">setType</span><span class="p">(</span><span class="n">EdmSimpleTypeKind</span><span class="p">.</span><span class="n">Double</span><span class="p">);</span> + <span class="k">properties</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">property</span><span class="p">);</span> + + <span class="n">property</span> <span class="p">=</span> <span class="n">new</span> <span class="n">SimpleProperty</span><span class="p">();</span> + <span class="n">property</span><span class="p">.</span><span class="n">setName</span><span class="p">(</span>"<span class="n">Currency</span>"<span class="p">);</span> + <span class="n">property</span><span class="p">.</span><span class="n">setType</span><span class="p">(</span><span class="n">EdmSimpleTypeKind</span><span class="p">.</span><span class="n">String</span><span class="p">);</span> + <span class="k">properties</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">property</span><span class="p">);</span> + + <span class="n">complexType</span><span class="p">.</span><span class="n">setName</span><span class="p">(</span>"<span class="n">OrderValue</span>"<span class="p">);</span> + <span class="n">complexType</span><span class="p">.</span><span class="n">setProperties</span><span class="p">(</span><span class="k">properties</span><span class="p">);</span> + + <span class="k">return</span> <span class="n">complexType</span><span class="p">;</span> + + <span class="p">}</span> +</pre></div> + + +<p>You need to set your <code>JPAEDMExtension</code> type in the <code>initializeODataJPAContext</code> of <code>JPAReferenceServiceFactory</code>.</p> +<p>The Complex Type added to the EDM can be used as Function Imports Return Type. See <a href="http://olingo.incubator.apache.org/doc/odata2/tutorials/jpafunctionimport.html";>Adding Function Imports to OData Services</a> for more information.</p><div align="center"> +<p>Copyright © 2013-2014, The Apache Software Foundation<br> + Apache Olingo, Olingo, Apache, the Apache feather, and + the Apache Olingo project logo are trademarks of the Apache Software + Foundation.</p> + <small><a href="/doc/odata2/privacy.html">Privacy</a></small> + </div> + </div><!-- /container --> + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="/js/jquery.js" type="text/javascript"> +</script> + <script src="/js/bootstrap.js" type="text/javascript"> + <script src="/js/offcanvas.js" type="text/javascript"> +</script> + <!-- Google Analytics: change UA-XXXXX-X to be your site's ID. --> + <script> + (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]= + function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date; + e=o.createElement(i);r=o.getElementsByTagName(i)[0]; + e.src='//www.google-analytics.com/analytics.js'; + r.parentNode.insertBefore(e,r)}(window,document,'script','ga')); + ga('create','UA-44963757-1');ga('send','pageview'); + </script> + </body> +</html> Added: websites/staging/olingo/trunk/content/doc/odata2/tutorials/HandlingClobAndBlob.html ============================================================================== --- websites/staging/olingo/trunk/content/doc/odata2/tutorials/HandlingClobAndBlob.html (added) +++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/HandlingClobAndBlob.html Tue Sep 16 12:34:18 2014 @@ -0,0 +1,191 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> +<html lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest."> + <meta name="author" content=""> + <link rel="icon" href="/favicon.ico"> + <title> + Apache Olingo + </title><!-- Bootstrap core CSS --> + <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! --> + <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template --> + <link rel="stylesheet" href="/css/main.css"> + <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]--> + + <script src="/js/ie-emulation-modes-warning.js" type="text/javascript"> +</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug --> + + <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript"> +</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="/js/html5shiv.min.js"></script> + <script src="/js/respond.min.js"></script> + <![endif]--> + </head> + + <body> + <div class="container"> + <!-- Static navbar --> + <div class="navbar navbar-default" role="navigation"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" > + <a class="navbar-brand" href="#">Apache Olingoâ¢</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + + <li><a href="/">Home</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/foundation/";>ASF Home</a></li> + <li><a href="http://projects.apache.org/";>Projects</a></li> + <li><a href="http://people.apache.org/";>People</a></li> + <li><a href="http://www.apache.org/foundation/getinvolved.html";>Get Involved</a></li> + <li><a href="http://www.apache.org/dyn/closer.cgi";>Download</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Support Apache</a></li> + </ul> + </li> + + <li><a href="http://www.apache.org/licenses/";>License</a></li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li> + <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li> + <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li> + </ul> + </li> + <li><a href="/support.html">Support</a></li> + + </ul> + + <img class="navbar-right" height="50px" src="/img/asf-logo.gif"> + + </div><!--/.nav-collapse --> + </div><!--/.container-fluid --> + </div><!-- Main component for a primary marketing message or call to action --><h2 id="handling-blob-and-clob-data-types">Handling BLOB and CLOB Data Types</h2> +<p>JPA entities can have properties that are of type <code>java.sql.Blob</code> or <code>java.sql.Clob</code>. Internally, JPA entities can instantiate a JPA provider (Eclipse Link or Hibernate or ...) specific implementation +of the above two interfaces and bind them to the properties. To enable write on such properties using OData JPA Processor Library, an additional access modifier is required to be added to the JPA +entities. Following is the proposal on how OData JPA Processor Library handles <code>java.sql.Blob</code> and <code>java.sql.Clob</code> during metadata generation and runtime processing. </p> +<h3 id="edm-generation">EDM Generation</h3> +<p>Based on the JPA entity property type, the pseudocode for generating the EDM is as below.</p> +<p><strong>For <code>java.sql.Blob</code></strong>:</p> +<ol> +<li>Check if JPA entity property is of type byte[] or of type java.sql.Blob and annotated with @Lob annotation. </li> +<li>If Step 1 is true, then generate an EDM property with type as Edm.Binary</li> +</ol> +<p><strong>For <code>java.sql.Clob</code></strong>:</p> +<ol> +<li>Check if JPA entity property is of type <code>java.sql.Clob</code> and annotated with @Lob annotation. </li> +<li>If Step 1 is true, then generate an EDM property with type as <code>Edm.String</code> (with no max length unless a max length is specified). </li> +</ol> +<h3 id="runtime-processing">Runtime Processing</h3> +<p><strong>Prerequisites:</strong></p> +<ol> +<li>It is mandatory to implement the callback interface <code>org.apache.olingo.odata2.jpa.processor.api.OnJPAWriteContent</code>.</li> +<li>The implemented interface needs to be registered with the service via the method <code>setOnJPAWriteContent</code> part of <code>ODataJPAServiceFactory</code>. </li> +</ol> +<p>Following is the pseudocode for handling the <code>java.sql.Blob</code> and <code>java.sql.Clob</code> during runtime.</p> +<div class="codehilite"><pre> <span class="o">/*</span> <span class="n">Callback</span> <span class="n">Implementation</span> <span class="o">*/</span> + + <span class="n">public</span> <span class="n">class</span> <span class="n">OnDBWriteContent</span> <span class="n">implements</span> <span class="n">OnJPAWriteContent</span> <span class="p">{</span> + + <span class="p">@</span><span class="n">Override</span> + <span class="n">public</span> <span class="n">Blob</span> <span class="n">getJPABlob</span><span class="p">(</span><span class="n">byte</span><span class="p">[]</span> <span class="n">binaryData</span><span class="p">)</span> <span class="n">throws</span> <span class="n">ODataJPARuntimeException</span> <span class="p">{</span> + <span class="k">try</span> <span class="p">{</span> + <span class="k">return</span> <span class="n">new</span> <span class="n">JDBCBlob</span><span class="p">(</span><span class="n">binaryData</span><span class="p">);</span> + <span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">SerialException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span> + <span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">throwException</span><span class="p">(</span><span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">INNER_EXCEPTION</span><span class="p">,</span> <span class="n">e</span><span class="p">);</span> + <span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">SQLException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span> + <span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">throwException</span><span class="p">(</span><span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">INNER_EXCEPTION</span><span class="p">,</span> <span class="n">e</span><span class="p">);</span> + <span class="p">}</span> + <span class="k">return</span> <span class="n">null</span><span class="p">;</span> + <span class="p">}</span> + + <span class="p">@</span><span class="n">Override</span> + <span class="n">public</span> <span class="n">Clob</span> <span class="n">getJPAClob</span><span class="p">(</span><span class="n">char</span><span class="p">[]</span> <span class="n">characterData</span><span class="p">)</span> <span class="n">throws</span> <span class="n">ODataJPARuntimeException</span> <span class="p">{</span> + <span class="k">try</span> <span class="p">{</span> + <span class="k">return</span> <span class="n">new</span> <span class="n">JDBCClob</span><span class="p">(</span><span class="n">new</span> <span class="n">String</span><span class="p">(</span><span class="n">characterData</span><span class="p">));</span> + <span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">SQLException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span> + <span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">throwException</span><span class="p">(</span><span class="n">ODataJPARuntimeException</span><span class="p">.</span><span class="n">INNER_EXCEPTION</span><span class="p">,</span> <span class="n">e</span><span class="p">);</span> + <span class="p">}</span> + <span class="k">return</span> <span class="n">null</span><span class="p">;</span> + <span class="p">}</span> + <span class="p">}</span> + + + <span class="o">/*</span> <span class="n">Call</span> <span class="n">Back</span> <span class="n">registration</span> <span class="n">in</span> <span class="n">Service</span> <span class="n">Factory</span> <span class="o">*/</span> + <span class="n">public</span> <span class="n">class</span> <span class="n">JPAReferenceServiceFactory</span> <span class="n">extends</span> <span class="n">ODataJPAServiceFactory</span> <span class="p">{</span> + + <span class="n">public</span> <span class="n">static</span> <span class="n">final</span> <span class="n">OnJPAWriteContent</span> <span class="n">onDBWriteContent</span> <span class="p">=</span> <span class="n">new</span> <span class="n">OnDBWriteContent</span><span class="p">();</span> + + <span class="p">@</span><span class="n">Override</span> + <span class="n">public</span> <span class="n">ODataJPAContext</span> <span class="n">initializeODataJPAContext</span><span class="p">()</span> + <span class="n">throws</span> <span class="n">ODataJPARuntimeException</span> <span class="p">{</span> + + <span class="p">....</span> + <span class="p">........</span> + <span class="p">..............</span> + + <span class="n">setOnWriteJPAContent</span><span class="p">(</span><span class="n">onDBWriteContent</span><span class="p">);</span> <span class="o">//</span><span class="n">Register</span> <span class="n">Call</span> <span class="n">Back</span> + + <span class="k">return</span> <span class="n">oDataJPAContext</span><span class="p">;</span> + <span class="p">}</span> + <span class="p">}</span> +</pre></div> + + +<p>OData JPA Processor Library internally does the following:</p> +<ol> +<li>Checks if the JPA entity property is of type <code>java.sql.Blob</code> or <code>java.sql.Clob</code>.</li> +<li>If Step 1 is true, then it invokes the registered callback method <code>getJPABlob</code> or <code>getJPAClob</code> respectively.</li> +<li>If callback method is not defined, it throws an exception. </li> +</ol> +<p><em>Note</em>: Step 3 is needed because the OData JPA Processor Library is not bound to any specific implementation of BLOB or CLOB interface. </p><div align="center"> +<p>Copyright © 2013-2014, The Apache Software Foundation<br> + Apache Olingo, Olingo, Apache, the Apache feather, and + the Apache Olingo project logo are trademarks of the Apache Software + Foundation.</p> + <small><a href="/doc/odata2/privacy.html">Privacy</a></small> + </div> + </div><!-- /container --> + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="/js/jquery.js" type="text/javascript"> +</script> + <script src="/js/bootstrap.js" type="text/javascript"> + <script src="/js/offcanvas.js" type="text/javascript"> +</script> + <!-- Google Analytics: change UA-XXXXX-X to be your site's ID. --> + <script> + (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]= + function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date; + e=o.createElement(i);r=o.getElementsByTagName(i)[0]; + e.src='//www.google-analytics.com/analytics.js'; + r.parentNode.insertBefore(e,r)}(window,document,'script','ga')); + ga('create','UA-44963757-1');ga('send','pageview'); + </script> + </body> +</html>
