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/01/15 10:58:46 UTC
svn commit: r894249 - in /websites/staging/olingo/trunk/content: ./
doc/tutorials/AnnotationProcessorExtension.html
Author: buildbot
Date: Wed Jan 15 09:58:45 2014
New Revision: 894249
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/tutorials/AnnotationProcessorExtension.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Jan 15 09:58:45 2014
@@ -1 +1 @@
-1558326
+1558330
Modified: websites/staging/olingo/trunk/content/doc/tutorials/AnnotationProcessorExtension.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/tutorials/AnnotationProcessorExtension.html (original)
+++ websites/staging/olingo/trunk/content/doc/tutorials/AnnotationProcessorExtension.html Wed Jan 15 09:58:45 2014
@@ -104,20 +104,20 @@ In addition we need the dependency to al
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>cars-annotations-sample<span class="nt"></artifactId></span>
<span class="nt"><version></span>1.0.0-SNAPSHOT<span class="nt"></version></span>
- <span class="nt"><name></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"><name></span>${project.artifactId}<span class="nt"></name></span>
<span class="nt"><packaging></span>war<span class="nt"></packaging></span>
<span class="nt"><properties></span>
<span class="c"><!-- Dependency Versions --></span>
- <span class="nt"><version</span><span class="err">.cxf</span><span class="nt">></span>2.7.6<span class="nt"></version.cxf></span>
- <span class="nt"><version</span><span class="err">.servlet-api</span><span class="nt">></span>2.5<span class="nt"></version.servlet-api></span>
- <span class="nt"><version</span><span class="err">.jaxrs-api</span><span class="nt">></span>2.0-m10<span class="nt"></version.jaxrs-api></span>
- <span class="nt"><version</span><span class="err">.olingo</span><span class="nt">></span>1.1.0<span class="nt"></version.olingo></span>
+ <span class="nt"><version.cxf></span>2.7.6<span class="nt"></version.cxf></span>
+ <span class="nt"><version.servlet-api></span>2.5<span class="nt"></version.servlet-api></span>
+ <span class="nt"><version.jaxrs-api></span>2.0-m10<span class="nt"></version.jaxrs-api></span>
+ <span class="nt"><version.olingo></span>1.1.0<span class="nt"></version.olingo></span>
<span class="nt"></properties></span>
<span class="nt"><build></span>
- <span class="nt"><finalName></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"></finalName></span>
+ <span class="nt"><finalName></span>${project.artifactId}<span class="nt"></finalName></span>
<span class="nt"><defaultGoal></span>clean package<span class="nt"></defaultGoal></span>
<span class="nt"></build></span>
@@ -126,46 +126,46 @@ In addition we need the dependency to al
<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-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<span class="nt"></version></span>
<span class="nt"></dependency></span>
<span class="nt"><dependency></span>
<span class="nt"><artifactId></span>olingo-odata2-api-annotation-incubating<span class="nt"></artifactId></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
<span class="nt"><type></span>jar<span class="nt"></type></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<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-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<span class="nt"></version></span>
<span class="nt"></dependency></span>
<span class="c"><!-- Apache Olingo Annotation Processor Extension dependencies --></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-annotation-processor-api-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<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-annotation-processor-core-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<span class="nt"></version></span>
<span class="nt"></dependency></span>
<span class="c"><!-- Servlet/REST dependencies --></span>
<span class="nt"><dependency></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><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">servlet</span><span class="o">-</span><span class="n">api</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.servlet-api}<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>javax.ws.rs<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>javax.ws.rs-api<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">jaxrs</span><span class="o">-</span><span class="n">api</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.jaxrs-api}<span class="nt"></version></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><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">cxf</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.cxf}<span class="nt"></version></span>
<span class="nt"></dependency></span>
<span class="nt"></dependencies></span>
<span class="nt"></project></span>
@@ -178,186 +178,213 @@ In addition we need the dependency to al
The <em>Car</em> consists of an <code>Id</code>, <code>Model</code>, <code>ProductionYear</code>, <code>Price</code> and a relation to its <code>Manufacturer</code>.</p>
<h4 id="create-java-beans-for-entities">Create Java Beans for Entities</h4>
<p>For each of both entities first a java bean (<em>POJO</em>) is created in the package <code>org.apache.olingo.sample.annotation.model</code> which looks like:</p>
-<div class="codehilite"><pre><span class="n">package</span> <span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">olingo</span><span class="p">.</span><span class="n">sample</span><span class="p">.</span><span class="n">annotation</span><span class="p">.</span><span class="n">model</span><span class="p">;</span>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">model</span><span class="o">;</span>
-<span class="o">/**</span> <span class="n">Imports</span><span class="o">*/</span>
-
-<span class="n">public</span> <span class="n">class</span> <span class="n">Manufacturer</span> <span class="p">{</span>
- <span class="n">private</span> <span class="n">String</span> <span class="n">id</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">String</span> <span class="n">name</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">Calendar</span> <span class="n">founded</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">List</span><span class="o"><</span><span class="n">Car</span><span class="o">></span> <span class="n">cars</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Car</span><span class="o">></span><span class="p">();</span>
-
- <span class="o">/**</span> <span class="n">getter</span> <span class="n">and</span> <span class="n">setter</span> <span class="o">*/</span>
+<span class="cm">/** Imports*/</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Manufacturer</span> <span class="o">{</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">id</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">name</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">Calendar</span> <span class="n">founded</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">List</span><span class="o"><</span><span class="n">Car</span><span class="o">></span> <span class="n">cars</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Car</span><span class="o">>();</span>
+ <span class="cm">/** getter and setter */</span>
+<span class="o">}</span>
+</pre></div>
-<span class="n">package</span> <span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">olingo</span><span class="p">.</span><span class="n">sample</span><span class="p">.</span><span class="n">annotation</span><span class="p">.</span><span class="n">model</span><span class="p">;</span>
+<p>and:</p>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">model</span><span class="o">;</span>
-<span class="o">/**</span> <span class="n">Imports</span><span class="o">*/</span>
+<span class="cm">/** Imports*/</span>
-<span class="n">public</span> <span class="n">class</span> <span class="n">Car</span> <span class="p">{</span>
- <span class="n">private</span> <span class="n">String</span> <span class="n">id</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">String</span> <span class="n">model</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">Double</span> <span class="n">price</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">Integer</span> <span class="n">productionYear</span><span class="p">;</span>
- <span class="n">private</span> <span class="n">Manufacturer</span> <span class="n">manufacturer</span><span class="p">;</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Car</span> <span class="o">{</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">id</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">Double</span> <span class="n">price</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">Integer</span> <span class="n">productionYear</span><span class="o">;</span>
+ <span class="kd">private</span> <span class="n">Manufacturer</span> <span class="n">manufacturer</span><span class="o">;</span>
- <span class="o">/**</span> <span class="n">getter</span> <span class="n">and</span> <span class="n">setter</span> <span class="o">*/</span>
+ <span class="cm">/** getter and setter */</span>
+<span class="o">}</span>
</pre></div>
<h4 id="annotated-created-java-beans">Annotated created Java Beans</h4>
<p>Now those beans have to be annotated with the annotations of the <em>Annotation Processor Extension</em>.</p>
<p>Both beans needs at first the <code>@EdmEntityType</code> and <code>@EdmEntitySet</code> annotation to define that they represent an OData Entity. These annotation must be added at the bean class which as example for the <em>Manufacturer</em> then look like:</p>
-<p><code>@EdmEntityType
-@EdmEntitySet
-public class Manufacturer { /** more code */ }</code></p>
+<div class="codehilite"><pre><span class="nd">@EdmEntityType</span>
+<span class="nd">@EdmEntitySet</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Manufacturer</span> <span class="o">{</span> <span class="cm">/** more code */</span> <span class="o">}</span>
+</pre></div>
+
+
<p>Then all simple properties of the Entity must be annotated with <code>@EdmProperty</code>, the <em>Key</em> for the Entity additional must be annotated with <code>@EdmKey</code> which is in this sample the <code>Id</code> field of the entities.</p>
<p>For the <em>Manufacturer</em> it then look like:</p>
-<p>```
-@EdmEntityType
-@EdmEntitySet
-public class Manufacturer {
- @EdmKey
- @EdmProperty
- private String id;
- @EdmProperty
- private String name;
- @EdmProperty
- private Calendar founded;</p>
-<p>/*<em> more code </em>/ }
-```</p>
+<div class="codehilite"><pre><span class="nd">@EdmEntityType</span>
+<span class="nd">@EdmEntitySet</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Manufacturer</span> <span class="o">{</span>
+ <span class="nd">@EdmKey</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">id</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">name</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">Calendar</span> <span class="n">founded</span><span class="o">;</span>
+
+ <span class="cm">/** more code */</span>
+<span class="o">}</span>
+</pre></div>
+
+
<p>A relation to another Entity must be annotated with <code>@EdmNavigationProperty</code>. In this sample this are the bi-directional relation between a <em>Manufacturer</em> and its <em>Cars</em>. </p>
<p>For the <em>Manufacturer</em> the added annotation look like:</p>
-<p>```
-@EdmEntityType
-@EdmEntitySet
-public class Manufacturer {
- /*<em> more code </em>/ </p>
-<p>@EdmNavigationProperty
- private List<Car> cars = new ArrayList<Car>();</p>
-<p>/*<em> more code </em>/
-}
-```</p>
+<div class="codehilite"><pre><span class="nd">@EdmEntityType</span>
+<span class="nd">@EdmEntitySet</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Manufacturer</span> <span class="o">{</span>
+ <span class="cm">/** more code */</span>
+
+ <span class="nd">@EdmNavigationProperty</span>
+ <span class="kd">private</span> <span class="n">List</span><span class="o"><</span><span class="n">Car</span><span class="o">></span> <span class="n">cars</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Car</span><span class="o">>();</span>
+
+ <span class="cm">/** more code */</span>
+<span class="o">}</span>
+</pre></div>
+
+
<p>The complete resulting Entities (POJOs) then look like:</p>
-<p>```
-package org.apache.olingo.sample.annotation.model;</p>
-<p>/*<em> Imports</em>/</p>
-<p>@EdmEntityType
-@EdmEntitySet
-public class Manufacturer {
- @EdmKey
- @EdmProperty
- private String id;
- @EdmProperty
- private String name;
- @EdmProperty
- private Calendar founded;
- @EdmNavigationProperty
- private List<Car> cars = new ArrayList<Car>();</p>
-<p>/*<em> getter and setter </em>/
-```</p>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">model</span><span class="o">;</span>
+
+<span class="cm">/** Imports*/</span>
+
+<span class="nd">@EdmEntityType</span>
+<span class="nd">@EdmEntitySet</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Manufacturer</span> <span class="o">{</span>
+ <span class="nd">@EdmKey</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">id</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">name</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">Calendar</span> <span class="n">founded</span><span class="o">;</span>
+ <span class="nd">@EdmNavigationProperty</span>
+ <span class="kd">private</span> <span class="n">List</span><span class="o"><</span><span class="n">Car</span><span class="o">></span> <span class="n">cars</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Car</span><span class="o">>();</span>
+
+ <span class="cm">/** getter and setter */</span>
+<span class="o">}</span>
+</pre></div>
+
+
<p>and</p>
-<p>```
-package org.apache.olingo.sample.annotation.model;</p>
-<p>/*<em> Imports </em>/</p>
-<p>@EdmEntityType
-@EdmEntitySet
-public class Car {
- @EdmKey
- @EdmProperty
- private String id;
- @EdmProperty
- private String model;
- @EdmProperty
- private Double price;
- @EdmProperty
- private Integer productionYear;
- @EdmNavigationProperty
- private Manufacturer manufacturer;</p>
-<p>/*<em> getter and setter </em>/
-```</p>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">model</span><span class="o">;</span>
+
+<span class="cm">/** Imports*/</span>
+
+<span class="nd">@EdmEntityType</span>
+<span class="nd">@EdmEntitySet</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Car</span> <span class="o">{</span>
+ <span class="nd">@EdmKey</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">id</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">Double</span> <span class="n">price</span><span class="o">;</span>
+ <span class="nd">@EdmProperty</span>
+ <span class="kd">private</span> <span class="n">Integer</span> <span class="n">productionYear</span><span class="o">;</span>
+ <span class="nd">@EdmNavigationProperty</span>
+ <span class="kd">private</span> <span class="n">Manufacturer</span> <span class="n">manufacturer</span><span class="o">;</span>
+
+ <span class="cm">/** getter and setter */</span>
+<span class="o">}</span>
+</pre></div>
+
+
<p>The next step is to create the <code>ODataService</code>.</p>
<h3 id="create-odataservice">Create ODataService</h3>
<p>The <code>ODataService</code> is created via an <code>ODataServiceFactory</code> implementation.
For the sample a <code>AnnotationSampleServiceFactory</code> in the package <code>org.apache.olingo.sample.annotation.processor</code> is created which extends the <code>ODataServiceFactory</code>. The resulting code look like:</p>
-<p>```
-package org.apache.olingo.sample.annotation.processor;</p>
-<p>/*<em> Imports </em>/</p>
-<p>public class AnnotationSampleServiceFactory extends ODataServiceFactory {
- @Override
- public ODataService createService(final ODataContext context) throws ODataException {
- return null;
- }
-}
-<code>``
-In the</code>createService(...)<code>method now the</code>ODataService<code>needs to be created.
-The _Annotation Processor Extension_ provides therefore the method</code>createAnnotationService(...)<code>within the</code>AnnotationServiceFactory` which can be used. This method require as parameter the <em>Package</em> which contains the <em>Model</em> in form of annotated POJOs (as created in the section <em>Create the Model</em>). </p>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">processor</span><span class="o">;</span>
+
+<span class="cm">/** Imports */</span>
+
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">AnnotationSampleServiceFactory</span> <span class="kd">extends</span> <span class="n">ODataServiceFactory</span> <span class="o">{</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">ODataService</span> <span class="nf">createService</span><span class="o">(</span><span class="kd">final</span> <span class="n">ODataContext</span> <span class="n">context</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">ODataException</span> <span class="o">{</span>
+ <span class="k">return</span> <span class="kc">null</span><span class="o">;</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</pre></div>
+
+
+<p>In the <code>createService(...)</code> method now the <code>ODataService</code> needs to be created.
+The <em>Annotation Processor Extension</em> provides therefore the method <code>createAnnotationService(...)</code> within the <code>AnnotationServiceFactory</code> which can be used. This method require as parameter the <em>Package</em> which contains the <em>Model</em> in form of annotated POJOs (as created in the section <em>Create the Model</em>). </p>
<p>For a persistence between several request it is necessary to hold the created <code>ODataService</code> in an static instance. In the sample the <a href="http://en.wikipedia.org/wiki/Initialization-on-demand_holder_idiom">Initialization on demand holder idiom</a> is used.</p>
<p>As result the implementation look like:</p>
-<p>```
-public class AnnotationSampleServiceFactory extends ODataServiceFactory {</p>
-<p>/*<em>
- * Instance holder for all annotation relevant instances which should be used as singleton
- * instances within the ODataApplication (ODataService)
- </em>/
- private static class AnnotationInstances {
- final static String MODEL_PACKAGE = "org.apache.olingo.sample.annotation.model";
- final static ODataService ANNOTATION_ODATA_SERVICE;</p>
-<div class="codehilite"><pre><span class="n">static</span> <span class="p">{</span>
- <span class="k">try</span> <span class="p">{</span>
- <span class="n">ANNOTATION_ODATA_SERVICE</span> <span class="p">=</span> <span class="n">AnnotationServiceFactory</span><span class="p">.</span><span class="n">createAnnotationService</span><span class="p">(</span><span class="n">MODEL_PACKAGE</span><span class="p">);</span>
- <span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">ODataApplicationException</span> <span class="n">ex</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">throw</span> <span class="n">new</span> <span class="n">RuntimeException</span><span class="p">(</span>"<span class="n">Exception</span> <span class="n">during</span> <span class="n">sample</span> <span class="n">data</span> <span class="n">generation</span><span class="p">.</span>"<span class="p">,</span> <span class="n">ex</span><span class="p">);</span>
- <span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">ODataException</span> <span class="n">ex</span><span class="p">)</span> <span class="p">{</span>
- <span class="n">throw</span> <span class="n">new</span> <span class="n">RuntimeException</span><span class="p">(</span>"<span class="n">Exception</span> <span class="n">during</span> <span class="n">data</span> <span class="n">source</span> <span class="n">initialization</span> <span class="n">generation</span><span class="p">.</span>"<span class="p">,</span> <span class="n">ex</span><span class="p">);</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="codehilite"><pre><span class="kn">package</span> <span class="n">org</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">olingo</span><span class="o">.</span><span class="na">sample</span><span class="o">.</span><span class="na">annotation</span><span class="o">.</span><span class="na">processor</span><span class="o">;</span>
+
+<span class="cm">/** Imports */</span>
+
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">AnnotationSampleServiceFactory</span> <span class="kd">extends</span> <span class="n">ODataServiceFactory</span> <span class="o">{</span>
+
+ <span class="cm">/**</span>
+<span class="cm"> * Instance holder for all annotation relevant instances which should be used as singleton</span>
+<span class="cm"> * instances within the ODataApplication (ODataService)</span>
+<span class="cm"> */</span>
+ <span class="kd">private</span> <span class="kd">static</span> <span class="kd">class</span> <span class="nc">AnnotationInstances</span> <span class="o">{</span>
+ <span class="kd">final</span> <span class="kd">static</span> <span class="n">String</span> <span class="n">MODEL_PACKAGE</span> <span class="o">=</span> <span class="s">"org.apache.olingo.sample.annotation.model"</span><span class="o">;</span>
+ <span class="kd">final</span> <span class="kd">static</span> <span class="n">ODataService</span> <span class="n">ANNOTATION_ODATA_SERVICE</span><span class="o">;</span>
+
+ <span class="kd">static</span> <span class="o">{</span>
+ <span class="k">try</span> <span class="o">{</span>
+ <span class="n">ANNOTATION_ODATA_SERVICE</span> <span class="o">=</span> <span class="n">AnnotationServiceFactory</span><span class="o">.</span><span class="na">createAnnotationService</span><span class="o">(</span><span class="n">MODEL_PACKAGE</span><span class="o">);</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">ODataApplicationException</span> <span class="n">ex</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nf">RuntimeException</span><span class="o">(</span><span class="s">"Exception during sample data generation."</span><span class="o">,</span> <span class="n">ex</span><span class="o">);</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">ODataException</span> <span class="n">ex</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nf">RuntimeException</span><span class="o">(</span><span class="s">"Exception during data source initialization generation."</span><span class="o">,</span> <span class="n">ex</span><span class="o">);</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+
+ <span class="kd">public</span> <span class="n">ODataService</span> <span class="nf">createService</span><span class="o">(</span><span class="kd">final</span> <span class="n">ODataContext</span> <span class="n">context</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">ODataException</span> <span class="o">{</span>
+ <span class="k">return</span> <span class="n">AnnotationInstances</span><span class="o">.</span><span class="na">ANNOTATION_ODATA_SERVICE</span><span class="o">;</span>
+ <span class="o">}</span>
</pre></div>
-<p>}</p>
-<p>public ODataService createService(final ODataContext context) throws ODataException {
-AnnotationsValueAccess
- return AnnotationInstances.ANNOTATION_ODATA_SERVICE;
- }
-```</p>
<p>Now the model as well as the service creation is done.
The next step is to provide the necessary resources to run the application within an application server. </p>
<h3 id="create-web-application-resources">Create Web Application resources</h3>
<p>To deploy and run the application on an application server it is necessary to provide a <code>web.xml</code> which defines the <code>JAX-RS</code> entry point which then calls the sample application.</p>
<p>For this sample <code>Apache CXF</code> is used (see <code><servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class></code>) which need as parameter the <code>javax.ws.rs.Application</code> and the <code>org.apache.olingo.odata2.service.factory</code>.</p>
<p>Therefore the <code>web.xml</code> is created in the <code>src/main/webapp/WEB-INF</code> folder with following content:</p>
-<p>```
-<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
- xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
- id="WebApp_ID" version="2.5">
- <display-name>org.apache.olingo.sample.annotation</display-name>
- <servlet>
- <servlet-name>ServiceServlet</servlet-name>
- <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
- <init-param>
- <param-name>javax.ws.rs.Application</param-name>
- <param-value>org.apache.olingo.odata2.core.rest.app.ODataApplication</param-value>
- </init-param>
- <init-param>
- <param-name>org.apache.olingo.odata2.service.factory</param-name>
- <param-value>org.apache.olingo.sample.annotation.processor.AnnotationSampleServiceFactory</param-value>
- </init-param>
- <load-on-startup>1</load-on-startup>
- </servlet></p>
-<div class="codehilite"><pre><span class="nt"><servlet-mapping></span>
- <span class="nt"><servlet-name></span>ServiceServlet<span class="nt"></servlet-name></span>
- <span class="nt"><url-pattern></span>/AnnotationSample.svc/*<span class="nt"></url-pattern></span>
-<span class="nt"></servlet-mapping></span>
+<div class="codehilite"><pre><span class="nt"><web-app</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span>
+ <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/javaee"</span> <span class="na">xmlns:web=</span><span class="s">"http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</span>
+ <span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</span>
+ <span class="na">id=</span><span class="s">"WebApp_ID"</span> <span class="na">version=</span><span class="s">"2.5"</span><span class="nt">></span>
+ <span class="nt"><display-name></span>org.apache.olingo.sample.annotation<span class="nt"></display-name></span>
+ <span class="nt"><servlet></span>
+ <span class="nt"><servlet-name></span>ServiceServlet<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.sample.annotation.processor.AnnotationSampleServiceFactory<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>ServiceServlet<span class="nt"></servlet-name></span>
+ <span class="nt"><url-pattern></span>/AnnotationSample.svc/*<span class="nt"></url-pattern></span>
+ <span class="nt"></servlet-mapping></span>
+<span class="nt"></web-app></span>
</pre></div>
-<p></web-app>
-```</p>
<h3 id="deploy-and-run">Deploy and Run</h3>
<p>Build the project with maven via <code>mvm clean package</code> and copy the resulting <code>WAR-File</code> from the projects <code>target</code> folder in the <code>deploy</code> folder of the application server.</p>
<p>Now just navigate to the URL (e.g. <code>http://localhost:8080/cars-annotations-sample/AnnotationSample.svc</code>).</p>