You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by bu...@apache.org on 2014/07/01 08:43:53 UTC
svn commit: r914542 - in /websites/staging/olingo/trunk/content: ./
doc/tutorials/CustomODataJPAProcessor.html
Author: buildbot
Date: Tue Jul 1 06:43:53 2014
New Revision: 914542
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/tutorials/CustomODataJPAProcessor.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jul 1 06:43:53 2014
@@ -1 +1 @@
-1606991
+1606992
Modified: websites/staging/olingo/trunk/content/doc/tutorials/CustomODataJPAProcessor.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/tutorials/CustomODataJPAProcessor.html (original)
+++ websites/staging/olingo/trunk/content/doc/tutorials/CustomODataJPAProcessor.html Tue Jul 1 06:43:53 2014
@@ -76,47 +76,39 @@
<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>
-<ol>
-<li>
-<p>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>
+<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="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="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="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="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="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="k">return</span> <span class="n">oDataResponse</span><span class="p">;</span>
+ <span class="p">}</span>
- <span class="p">}</span>
+ <span class="p">}</span>
</pre></div>
-<ol>
-<li>
-<p>Write a Custom OData JPA Service Factory
+<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>
-<p>ODataSingleProcessor odataJPAProcessor = accessFactory.createODataProcessor(oDataJPAContext);</p>
-</li>
-</ol>
-<p>with </p>
-<div class="codehilite"><pre> <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 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>
-</li>
-</ol>
+ <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>