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 2013/09/26 06:18:36 UTC

svn commit: r879925 - in /websites/staging/olingo/trunk/content: ./ doc/tutorials/read_media-resource.html

Author: buildbot
Date: Thu Sep 26 04:18:36 2013
New Revision: 879925

Log:
Staging update by buildbot for olingo

Modified:
    websites/staging/olingo/trunk/content/   (props changed)
    websites/staging/olingo/trunk/content/doc/tutorials/read_media-resource.html

Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Sep 26 04:18:36 2013
@@ -1 +1 @@
-1526370
+1526373

Modified: websites/staging/olingo/trunk/content/doc/tutorials/read_media-resource.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/tutorials/read_media-resource.html (original)
+++ websites/staging/olingo/trunk/content/doc/tutorials/read_media-resource.html Thu Sep 26 04:18:36 2013
@@ -72,6 +72,370 @@
             <h1 id="media-resources">Media Resources</h1>
 <hr />
 <h2 id="how-to-guide-extend-read-scenario-with-support-for-media-resources">How To Guide - Extend read scenario with support for media resources</h2>
+<p>This How To Guide shows how to extend the read scenario (with <code>$expand</code> extension) with support for Media Link Entries and Media Resources.</p>
+<p>The tutorial introduces a new resource (Driver), shows how to extend the according <code>readEntitySet(...)</code> and <code>readEntity(...)</code> and introduces the new method <code>readEntityMedia(uriInfo:GetMediaResourceUriInfo, contentType:String):ODataResponse</code> within the <code>MyODataSingleProcessor</code>.</p>
+<h2 id="prerequisites">Prerequisites</h2>
+<p>Setup of <a href="read_expand">Read Scenario with <code>$expand</code></a> extension
+(which has as prerequisite Setup of <a href="read">Basic Read Scenario</a>)</p>
+<h2 id="shortcut">Shortcut</h2>
+<p>If you like to directly experiment with the results of the extented basic read scenario, you can use this shortcut: </p>
+<ul>
+<li>Download and unzip the <a href="apache-olingo-tutorial-adv_read_mediaresource">Olingo Tutorial 'Basic Read with Media Resource extension' Project</a> to your local drive </li>
+<li>Start the command line tool and run maven in the folder <em>read.scenario.media-resource-extension</em> to build the war file which then can be deployed. </li>
+<li>Deploy the resulting war to your favorite application server. For the LJS copy the war into the <em>$LJS_HOME/pickup</em> folder and start the server via <code>$LJS_HOME/go.sh</code>. </li>
+<li>Optional: To import the sample project into Eclipse run the following steps: <ul>
+<li>Start the command line tool and run mvn eclipse:eclipse clean install in the folder <em>read.scenario.media-resource-extension</em> to generate the Eclipse project settings and do an initial build. </li>
+<li>Go into Eclipse and import the project into your workspace by... </li>
+<li><strong>Menue "File" -&gt; "Import..."</strong> </li>
+<li><strong>"Existing projects into workspace" then choose the olingo.odata2.sample folder</strong> </li>
+<li><strong>Select both projects olingo.odata2.sample.service and olingo.odata2.sample.web and press "Finish"</strong> </li>
+</ul>
+</li>
+</ul>
+<p><strong><em>[link, list: tbd]</em></strong></p>
+<h2 id="hints">Hints</h2>
+<ul>
+<li>Sometimes a code extension needs one or more new/additional imports. These are not shown in the examples because it would blow up the source code examples and normally the IDE should support an auto fix of missing imports during typing of the code or after an insert of copied code. </li>
+</ul>
+<h2 id="extend-read-scenario">Extend Read Scenario</h2>
+<p>The steps to extend the read scenario (already with <code>$expand</code> support) with support for a Driver which is a media link entry with an associated media resource and therefore contains an image as media is to override and implement the <code>readEntityMedia(uriInfo:GetMediaResourceUriInfo, contentType:String):ODataResponse</code> method within the <code>MyODataSingleProcessor</code>.</p>
+<p>All $value requests - where $value is the next segment to an entity type instance identified by an EntitySet with key predicate or a navigation property (to one relation or key predicate for to many relation) - to the service are delegated to this method which then handles the creation of the according response. </p>
+<h3 id="extend-myedmprovider-and-myodatasingleprocessor">Extend MyEdmProvider and MyODataSingleProcessor</h3>
+<p>Small sample code Prerequisites
+Not directly related to the OData Library parts but necessary for the sample project is the extension of the DataStore with methods to access the new Driver and the binary data for the media resource of the Driver.
+Because this extension is more boilerplate code with no direct OData impact it is recommended to simply copy the DataStore.java into the project.
+As conclusion following methods are added which are accessed from the <code>MyODataSingleProcessor</code>:</p>
+<ul>
+<li><code>readDriverImage(entitySet:EdmEntitySet, id:int):byte[]</code> </li>
+<li><code>getDriverFor(carId:int):Map&lt;String, Object&gt;</code></li>
+<li><code>getCarFor(driverKey:int):Map&lt;String, Object&gt;</code> </li>
+<li><code>getDriver(id:int):Map&lt;String, Object&gt;</code></li>
+<li><code>getDrivers():List&lt;Map&lt;String, Object&gt;&gt;</code> </li>
+</ul>
+<p>Additional and in conclusion with the <code>DataStore</code> three images (png) are added to the sample project. These images are located in <em>/sample-service/src/main/resources/</em> and are named Driver_'x'.png were 'x' is replaced by a number.
+To really get an image for a media resource request it is necessary to copy these images (or create own PNG files which follows the naming schema).
+If nothing is copied/created the sample will still work but does not show an image for a media resource request (instead a HTTP Response 404 - Entity not found is shown). </p>
+<h3 id="extend-myedmprovider-with-driver-data-model">Extend MyEdmProvider with Driver data model</h3>
+<p>First the new Driver is added in the EDM. 
+The Driver gets a Key (Id) and some properties (Name, Surname, Nickname, Updates. For simplification currently we do not add any associations to another entities.</p>
+<p>To mark the Driver as a media link entry with an associated media resource extension it is mandatory to set the stream property to true via the <code>setHasStream(true)</code> method when creating the <code>EntityType</code>.</p>
+<p>As conclusion the <code>getEntityType(…)</code> method is extended as follows:</p>
+<h4 id="sample-code">Sample Code</h4>
+<div class="codehilite"><pre>…
+  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_TYPE_1_3</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">edmFQName</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="n">List</span><span class="o">&lt;</span><span class="n">Property</span><span class="o">&gt;</span> <span class="k">properties</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ArrayList</span><span class="o">&lt;</span><span class="n">Property</span><span class="o">&gt;</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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Id</span>&quot;<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">Int32</span><span class="p">).</span><span class="n">setFacets</span><span class="p">(</span><span class="n">new</span> <span class="n">Facets</span><span class="p">().</span><span class="n">setNullable</span><span class="p">(</span><span class="n">false</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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Name</span>&quot;<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="n">setFacets</span><span class="p">(</span><span class="n">new</span> <span class="n">Facets</span><span class="p">().</span><span class="n">setNullable</span><span class="p">(</span><span class="n">false</span><span class="p">).</span><span class="n">setMaxLength</span><span class="p">(</span>50<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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Surname</span>&quot;<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="n">setFacets</span><span class="p">(</span><span class="n">new</span> <span class="n">Facets</span><span class="p">().</span><span class="n">setNullable</span><span class="p">(</span><span class="n">false</span><span class="p">).</span><span class="n">setMaxLength</span><span class="p">(</span>80<span class="p">))</span>
+                    <span class="p">.</span><span class="n">setCustomizableFeedMappings</span><span class="p">(</span><span class="n">new</span> <span class="n">CustomizableFeedMappings</span><span class="p">().</span><span class="n">setFcTargetPath</span><span class="p">(</span><span class="n">EdmTargetPath</span><span class="p">.</span><span class="n">SYNDICATION_TITLE</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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Nickname</span>&quot;<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="n">setFacets</span><span class="p">(</span><span class="n">new</span> <span class="n">Facets</span><span class="p">().</span><span class="n">setNullable</span><span class="p">(</span><span class="n">true</span><span class="p">).</span><span class="n">setMaxLength</span><span class="p">(</span>50<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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Updated</span>&quot;<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">DateTime</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setFacets</span><span class="p">(</span><span class="n">new</span> <span class="n">Facets</span><span class="p">().</span><span class="n">setNullable</span><span class="p">(</span><span class="n">false</span><span class="p">).</span><span class="n">setConcurrencyMode</span><span class="p">(</span><span class="n">EdmConcurrencyMode</span><span class="p">.</span><span class="n">Fixed</span><span class="p">))</span>
+        <span class="p">.</span><span class="n">setCustomizableFeedMappings</span><span class="p">(</span><span class="n">new</span> <span class="n">CustomizableFeedMappings</span><span class="p">().</span><span class="n">setFcTargetPath</span><span class="p">(</span><span class="n">EdmTargetPath</span><span class="p">.</span><span class="n">SYNDICATION_UPDATED</span><span class="p">)));</span>
+
+    <span class="o">//</span> <span class="n">Navigation</span> <span class="k">properties</span>
+    <span class="n">List</span><span class="o">&lt;</span><span class="n">NavigationProperty</span><span class="o">&gt;</span> <span class="n">navigationProperties</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ArrayList</span><span class="o">&lt;</span><span class="n">NavigationProperty</span><span class="o">&gt;</span><span class="p">();</span>
+
+    <span class="o">//</span> <span class="n">Key</span>
+    <span class="n">List</span><span class="o">&lt;</span><span class="n">PropertyRef</span><span class="o">&gt;</span> <span class="n">keyProperties</span> <span class="p">=</span> <span class="n">new</span> <span class="n">ArrayList</span><span class="o">&lt;</span><span class="n">PropertyRef</span><span class="o">&gt;</span><span class="p">();</span>
+    <span class="n">keyProperties</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">new</span> <span class="n">PropertyRef</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Id</span>&quot;<span class="p">));</span>
+    <span class="n">Key</span> <span class="n">key</span> <span class="p">=</span> <span class="n">new</span> <span class="n">Key</span><span class="p">().</span><span class="n">setKeys</span><span class="p">(</span><span class="n">keyProperties</span><span class="p">);</span>
+
+    <span class="o">//</span> <span class="n">finish</span>
+    <span class="k">return</span> <span class="n">new</span> <span class="n">EntityType</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_3</span><span class="p">.</span><span class="n">getName</span><span class="p">())</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="p">.</span><span class="n">setHasStream</span><span class="p">(</span><span class="n">true</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setKey</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setNavigationProperties</span><span class="p">(</span><span class="n">navigationProperties</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setMapping</span><span class="p">(</span><span class="n">new</span> <span class="n">Mapping</span><span class="p">().</span><span class="n">setMimeType</span><span class="p">(</span>&quot;<span class="n">image</span><span class="o">/</span><span class="n">png</span>&quot;<span class="p">));</span>
+<span class="p">}</span>
+<span class="p">...</span>
+</pre></div>
+
+
+<p>In addition it is necessary to extend the <code>getSchemas(…)</code> method with the according <code>EntityType</code> and <code>EntitySet</code> of the new Driver.</p>
+<div class="codehilite"><pre><span class="n">entityTypes</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">getEntityType</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_3</span><span class="p">));</span>
+<span class="n">entitySets</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">getEntitySet</span><span class="p">(</span><span class="n">ENTITY_CONTAINER</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">));</span>
+</pre></div>
+
+
+<p>And at last following constants are added to the <code>MyEdmProvider</code> for cleaner code.</p>
+<div class="codehilite"><pre>  <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span> <span class="p">=</span> &quot;<span class="n">Drivers</span>&quot;<span class="p">;</span>
+  <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ENTITY_NAME_DRIVER</span> <span class="p">=</span> &quot;<span class="n">Driver</span>&quot;<span class="p">;</span>
+  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">FullQualifiedName</span> <span class="n">ENTITY_TYPE_1_3</span> <span class="p">=</span> <span class="n">new</span> <span class="n">FullQualifiedName</span><span class="p">(</span><span class="n">NAMESPACE</span><span class="p">,</span> <span class="n">ENTITY_NAME_DRIVER</span><span class="p">);</span>
+</pre></div>
+
+
+<h3 id="extend-myodatasingleprocessor-with-readentitymediauriinfogetmediaresourceuriinfo-contenttypestringodataresponse-method">Extend <code>MyODataSingleProcessor</code> with <code>readEntityMedia(uriInfo:GetMediaResourceUriInfo, contentType:String):ODataResponse</code> method</h3>
+<p>All requests for media resources are done via the specified $value property in the URL (e.g. <em>.../MyODataSample.svc/Drivers(1)/$value</em>). Such a request will be dispatched to an <code>EntityMediaProcessor</code> which is in our case the <code>MyODataSingleProcessor</code> (inherited from <code>ODataSingleProcessor</code>).
+To handle now such read requests for our media resources we override and implement the <code>readEntityMedia(uriInfo:GetMediaResourceUriInfo, contentType:String):ODataResponse</code> method.
+For our scenario we simply have to validate the correct requested target <code>EntitySet</code>, get the key for requesting the data from our <code>DataStore</code> (which contains the binary data of our media resource), use the <code>EntityProvider</code> to write the data and at last build the <code>ODataResponse</code>.
+Seems a lot but in code this are only these few lines:</p>
+<div class="codehilite"><pre><span class="p">@</span><span class="n">Override</span>
+<span class="n">public</span> <span class="n">ODataResponse</span> <span class="n">readEntityMedia</span><span class="p">(</span><span class="n">final</span> <span class="n">GetMediaResourceUriInfo</span> <span class="n">uriInfo</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="n">final</span> <span class="n">EdmEntitySet</span> <span class="n">entitySet</span> <span class="p">=</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getTargetEntitySet</span><span class="p">();</span>
+  <span class="k">if</span><span class="p">(</span><span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">id</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">byte</span><span class="p">[]</span> <span class="n">image</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">readDriverImage</span><span class="p">(</span><span class="n">entitySet</span><span class="p">,</span> <span class="n">id</span><span class="p">);</span>
+    <span class="k">if</span> <span class="p">(</span><span class="n">image</span> <span class="o">==</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">throw</span> <span class="n">new</span> <span class="n">ODataNotFoundException</span><span class="p">(</span><span class="n">ODataNotFoundException</span><span class="p">.</span><span class="n">ENTITY</span><span class="p">);</span>
+    <span class="p">}</span>
+
+    <span class="n">String</span> <span class="n">mimeType</span> <span class="p">=</span> &quot;<span class="n">image</span><span class="o">/</span><span class="n">png</span>&quot;<span class="p">;</span>
+    <span class="k">return</span> <span class="n">ODataResponse</span><span class="p">.</span><span class="n">fromResponse</span><span class="p">(</span><span class="n">EntityProvider</span><span class="p">.</span><span class="n">writeBinary</span><span class="p">(</span><span class="n">mimeType</span><span class="p">,</span> <span class="n">image</span><span class="p">)).</span><span class="n">build</span><span class="p">();</span>
+  <span class="p">}</span>
+
+  <span class="n">throw</span> <span class="n">new</span> <span class="n">ODataNotImplementedException</span><span class="p">();</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>With these extension it is possible to read the media resource, but for access to the Driver <code>EntitySet</code> and <code>Entity</code> the according read methods have to be extended.</p>
+<h3 id="extend-existing-readentityset-and-readentity-methods-in-myodatasingleprocessor-methods">Extend existing <code>readEntitySet(...)</code> and <code>readEntity(...)</code> methods in <code>MyODataSingleProcessor</code> methods</h3>
+<p>For access to the Driver as <code>Entity</code> and as <code>EntitySet</code> the according <code>readreadEntitySet(...)</code> and <code>readEntity(...)</code> methods have to be extended.</p>
+<p>But its quite the same procedure as in the basic read. Validate the requested Entity, get the key for requesting the <code>DataStore</code> and write the result data via the <code>EntityProvider</code>.</p>
+<p>The resulting extension for <code>readEntity(…)</code>:</p>
+<div class="codehilite"><pre>  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">id</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">data</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getDriver</span><span class="p">(</span><span class="n">id</span><span class="p">);</span>
+
+    <span class="k">if</span> <span class="p">(</span><span class="n">data</span> !<span class="p">=</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">URI</span> <span class="n">serviceRoot</span> <span class="p">=</span> <span class="n">getContext</span><span class="p">().</span><span class="n">getPathInfo</span><span class="p">().</span><span class="n">getServiceRoot</span><span class="p">();</span>
+      <span class="n">ODataEntityProviderPropertiesBuilder</span> <span class="n">propertiesBuilder</span> <span class="p">=</span> <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">serviceRoot</span><span class="p">);</span>
+
+      <span class="k">return</span> <span class="n">EntityProvider</span><span class="p">.</span><span class="n">writeEntry</span><span class="p">(</span><span class="n">contentType</span><span class="p">,</span> <span class="n">entitySet</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">propertiesBuilder</span><span class="p">.</span><span class="n">build</span><span class="p">());</span>
+    <span class="p">}</span>
+</pre></div>
+
+
+<p>and <code>readEntitySet(…)</code>:</p>
+<div class="codehilite"><pre>  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="k">return</span> <span class="n">EntityProvider</span><span class="p">.</span><span class="n">writeFeed</span><span class="p">(</span><span class="n">contentType</span><span class="p">,</span> <span class="n">entitySet</span><span class="p">,</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getDrivers</span><span class="p">(),</span>     <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">getContext</span><span class="p">().</span><span class="n">getPathInfo</span><span class="p">().</span><span class="n">getServiceRoot</span><span class="p">()).</span><span class="n">build</span><span class="p">());</span>
+</pre></div>
+
+
+<h3 id="conclusion-for-media-resource-extension">Conclusion for media resource extension</h3>
+<p>After finishing all steps above the project can be built and deployed containing a Driver type which is a media link entry with associated media resource. <em>Congratulations.</em></p>
+<p>For a more interesting sample and to update before learned knowledge about associations and <code>$expand</code> it is recommended to finish this HowTo with the creation of an association between a Driver and his Car with supported <code>$expand</code>.</p>
+<h3 id="extend-driver-with-association-to-car">Extend Driver with association to Car</h3>
+<p>For a more interesting sample we now create an association between a Driver and his Car.</p>
+<h3 id="extend-driver-and-car-in-myedmprovider-with-a-navigation-property">Extend Driver and Car in MyEdmProvider with a navigation property</h3>
+<p>At first we introduce the necessary constants:</p>
+<div class="codehilite"><pre>  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">FullQualifiedName</span> <span class="n">ASSOCIATION_DRIVER_CAR</span> <span class="p">=</span> <span class="n">new</span> <span class="n">FullQualifiedName</span><span class="p">(</span><span class="n">NAMESPACE</span><span class="p">,</span> &quot;<span class="n">Driver_Car</span><span class="o">-</span><span class="n">Car_Driver</span>&quot;<span class="p">);</span>
+
+  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ROLE_1_3</span> <span class="p">=</span> &quot;<span class="n">Car_Driver</span>&quot;<span class="p">;</span>
+  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ROLE_3_1</span> <span class="p">=</span> &quot;<span class="n">Driver_Car</span>&quot;<span class="p">;</span>
+
+  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ASSOCIATION_SET</span> <span class="p">=</span> &quot;<span class="n">Cars_Manufacturers</span>&quot;<span class="p">;</span>
+  <span class="n">private</span> <span class="n">static</span> <span class="n">final</span> <span class="n">String</span> <span class="n">ASSOCIATION_SET_CARS_DRIVERS</span> <span class="p">=</span> &quot;<span class="n">Cars_Drivers</span>&quot;<span class="p">;</span>
+</pre></div>
+
+
+<p>Then the <code>getSchemas()</code> in <code>MyEdmProvider</code> is extended with the new association:</p>
+<div class="codehilite"><pre><span class="n">associations</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">getAssociation</span><span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">));</span>
+<span class="p">...</span>
+<span class="n">associationSets</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">getAssociationSet</span><span class="p">(</span><span class="n">ENTITY_CONTAINER</span><span class="p">,</span> <span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">,</span> <span class="n">ROLE_3_1</span><span class="p">));</span>
+</pre></div>
+
+
+<p>Next step is the extension of the entity types in <code>getEntityType()</code> in <code>MyEdmProvider</code>.</p>
+<p>For the Car:</p>
+<div class="codehilite"><pre>  <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_TYPE_1_1</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">edmFQName</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+<span class="p">...</span>
+    <span class="n">navigationProperties</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">new</span> <span class="n">NavigationProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Driver</span>&quot;<span class="p">)</span>
+        <span class="p">.</span><span class="n">setRelationship</span><span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">).</span><span class="n">setFromRole</span><span class="p">(</span><span class="n">ROLE_1_3</span><span class="p">).</span><span class="n">setToRole</span><span class="p">(</span><span class="n">ROLE_3_1</span><span class="p">));</span>
+…
+<span class="p">}</span>
+</pre></div>
+
+
+<p>And the Driver:</p>
+<div class="codehilite"><pre>  <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_TYPE_1_3</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">edmFQName</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</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">new</span> <span class="n">SimpleProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">CarId</span>&quot;<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">Int32</span><span class="p">));</span>
+<span class="p">...</span>
+    <span class="n">navigationProperties</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">new</span> <span class="n">NavigationProperty</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span>&quot;<span class="n">Car</span>&quot;<span class="p">).</span><span class="n">setRelationship</span><span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">).</span><span class="n">setFromRole</span><span class="p">(</span><span class="n">ROLE_3_1</span><span class="p">).</span><span class="n">setToRole</span><span class="p">(</span><span class="n">ROLE_1_3</span><span class="p">));</span>
+<span class="p">...</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>At last the <code>getAssociation(…)</code> and <code>getAssociationSet(...)</code> has also to be extended and has to look like:</p>
+<div class="codehilite"><pre><span class="p">@</span><span class="n">Override</span>
+<span class="n">public</span> <span class="n">Association</span> <span class="n">getAssociation</span><span class="p">(</span><span class="n">FullQualifiedName</span> <span class="n">edmFQName</span><span class="p">)</span> <span class="n">throws</span> <span class="n">ODataException</span> <span class="p">{</span>
+  <span class="k">if</span> <span class="p">(</span><span class="n">NAMESPACE</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">edmFQName</span><span class="p">.</span><span class="n">getNamespace</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="n">ASSOCIATION_CAR_MANUFACTURER</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">edmFQName</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+      <span class="k">return</span> <span class="n">new</span> <span class="n">Association</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span><span class="n">ASSOCIATION_CAR_MANUFACTURER</span><span class="p">.</span><span class="n">getName</span><span class="p">())</span>
+        <span class="p">.</span><span class="n">setEnd1</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationEnd</span><span class="p">().</span><span class="n">setType</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_1</span><span class="p">).</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_1</span><span class="p">).</span><span class="n">setMultiplicity</span><span class="p">(</span><span class="n">EdmMultiplicity</span><span class="p">.</span><span class="n">MANY</span><span class="p">))</span>
+        <span class="p">.</span><span class="n">setEnd2</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationEnd</span><span class="p">().</span><span class="n">setType</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_2</span><span class="p">).</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_2</span><span class="p">).</span><span class="n">setMultiplicity</span><span class="p">(</span><span class="n">EdmMultiplicity</span><span class="p">.</span><span class="n">ONE</span><span class="p">));</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</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">edmFQName</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="k">return</span> <span class="n">new</span> <span class="n">Association</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">.</span><span class="n">getName</span><span class="p">())</span>
+        <span class="p">.</span><span class="n">setEnd1</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationEnd</span><span class="p">().</span><span class="n">setType</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_1</span><span class="p">).</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_3</span><span class="p">).</span><span class="n">setMultiplicity</span><span class="p">(</span><span class="n">EdmMultiplicity</span><span class="p">.</span><span class="n">ONE</span><span class="p">))</span>
+        <span class="p">.</span><span class="n">setEnd2</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationEnd</span><span class="p">().</span><span class="n">setType</span><span class="p">(</span><span class="n">ENTITY_TYPE_1_3</span><span class="p">).</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_3_1</span><span class="p">).</span><span class="n">setMultiplicity</span><span class="p">(</span><span class="n">EdmMultiplicity</span><span class="p">.</span><span class="n">ONE</span><span class="p">));</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">AssociationSet</span> <span class="n">getAssociationSet</span><span class="p">(</span><span class="n">String</span> <span class="n">entityContainer</span><span class="p">,</span> <span class="n">FullQualifiedName</span> <span class="n">association</span><span class="p">,</span> <span class="n">String</span> <span class="n">sourceEntitySetName</span><span class="p">,</span> <span class="n">String</span> <span class="n">sourceEntitySetRole</span><span class="p">)</span> <span class="n">throws</span> <span class="n">ODataException</span> <span class="p">{</span>
+  <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_CONTAINER</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entityContainer</span><span class="p">))</span> <span class="p">{</span>
+    <span class="k">if</span> <span class="p">(</span><span class="n">ASSOCIATION_CAR_MANUFACTURER</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">association</span><span class="p">))</span> <span class="p">{</span>
+      <span class="k">return</span> <span class="n">new</span> <span class="n">AssociationSet</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span><span class="n">ASSOCIATION_SET</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setAssociation</span><span class="p">(</span><span class="n">ASSOCIATION_CAR_MANUFACTURER</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setEnd1</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationSetEnd</span><span class="p">().</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_2</span><span class="p">).</span><span class="n">setEntitySet</span><span class="p">(</span><span class="n">ENTITY_SET_NAME_MANUFACTURERS</span><span class="p">))</span>
+        <span class="p">.</span><span class="n">setEnd2</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationSetEnd</span><span class="p">().</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_1</span><span class="p">).</span><span class="n">setEntitySet</span><span class="p">(</span><span class="n">ENTITY_SET_NAME_CARS</span><span class="p">));</span>
+    <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">association</span><span class="p">))</span> <span class="p">{</span>
+      <span class="k">return</span> <span class="n">new</span> <span class="n">AssociationSet</span><span class="p">().</span><span class="n">setName</span><span class="p">(</span><span class="n">ASSOCIATION_SET_CARS_DRIVERS</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setAssociation</span><span class="p">(</span><span class="n">ASSOCIATION_DRIVER_CAR</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">setEnd1</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationSetEnd</span><span class="p">().</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_3_1</span><span class="p">).</span><span class="n">setEntitySet</span><span class="p">(</span><span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">))</span>
+        <span class="p">.</span><span class="n">setEnd2</span><span class="p">(</span><span class="n">new</span> <span class="n">AssociationSetEnd</span><span class="p">().</span><span class="n">setRole</span><span class="p">(</span><span class="n">ROLE_1_3</span><span class="p">).</span><span class="n">setEntitySet</span><span class="p">(</span><span class="n">ENTITY_SET_NAME_CARS</span><span class="p">));</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>
+</pre></div>
+
+
+<h3 id="extend-existing-readreadentityset-and-readentity-methods-in-myodatasingleprocessor">Extend existing <code>readreadEntitySet(...)</code> and <code>readEntity(...)</code> methods in <code>MyODataSingleProcessor</code></h3>
+<p>For cleaner code we introduce at first following method in the <code>MyODataSingleProcessor</code> which validate if the uri contains the expected association.</p>
+<div class="codehilite"><pre><span class="n">private</span> <span class="n">boolean</span> <span class="n">isAssociation</span><span class="p">(</span><span class="n">GetEntityUriInfo</span> <span class="n">uriInfo</span><span class="p">,</span> <span class="n">String</span> <span class="n">startName</span><span class="p">,</span> <span class="n">String</span> <span class="n">targetName</span><span class="p">)</span> <span class="n">throws</span> <span class="n">EdmException</span> <span class="p">{</span>
+  <span class="k">if</span><span class="p">(</span><span class="n">startName</span> <span class="o">==</span> <span class="n">null</span> <span class="o">||</span> <span class="n">targetName</span> <span class="o">==</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span>
+  <span class="k">return</span> <span class="n">false</span><span class="p">;</span>
+  <span class="p">}</span>
+  <span class="n">EdmEntitySet</span> <span class="n">startEntitySet</span> <span class="p">=</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getStartEntitySet</span><span class="p">();</span>
+  <span class="n">EdmEntitySet</span> <span class="n">targetEntitySet</span> <span class="p">=</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getTargetEntitySet</span><span class="p">();</span>
+
+  <span class="k">return</span> <span class="n">startName</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">startEntitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">())</span> <span class="o">&amp;&amp;</span> <span class="n">targetName</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">targetEntitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">());</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>The procedure should be already familiar. At first it is checked for the correct association of the requested Entity, then the key for requesting the DataStore is get as well as the data and then result data is written via the <code>EntityProvider</code>.</p>
+<div class="codehilite"><pre><span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getNavigationSegments</span><span class="p">().</span><span class="nb">size</span><span class="p">()</span> <span class="o">==</span> 1<span class="p">)</span> <span class="p">{</span>
+  <span class="o">//</span><span class="n">navigation</span> <span class="n">first</span> <span class="n">level</span><span class="p">,</span> <span class="n">simplified</span> <span class="n">example</span> <span class="k">for</span> <span class="n">illustration</span> <span class="n">purposes</span> <span class="n">only</span>
+  <span class="n">EdmEntitySet</span> <span class="n">entitySet</span> <span class="p">=</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getTargetEntitySet</span><span class="p">();</span>
+
+  <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">data</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">ENTITY_SET_NAME_MANUFACTURERS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">carKey</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">data</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getManufacturerFor</span><span class="p">(</span><span class="n">carKey</span><span class="p">);</span>
+  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span><span class="p">(</span><span class="n">isAssociation</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_CARS</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">carKey</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">data</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getDriverFor</span><span class="p">(</span><span class="n">carKey</span><span class="p">);</span>
+  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span><span class="p">(</span><span class="n">isAssociation</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_CARS</span><span class="p">))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">driverKey</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">data</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getCarFor</span><span class="p">(</span><span class="n">driverKey</span><span class="p">);</span>
+  <span class="p">}</span>
+
+  <span class="k">if</span><span class="p">(</span><span class="n">data</span> !<span class="p">=</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span>
+    <span class="k">return</span> <span class="n">EntityProvider</span><span class="p">.</span><span class="n">writeEntry</span><span class="p">(</span><span class="n">contentType</span><span class="p">,</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getTargetEntitySet</span><span class="p">(),</span> 
+        <span class="n">data</span><span class="p">,</span> <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">getContext</span><span class="p">().</span><span class="n">getPathInfo</span><span class="p">().</span><span class="n">getServiceRoot</span><span class="p">()).</span><span class="n">build</span><span class="p">());</span>
+  <span class="p">}</span>
+
+  <span class="n">throw</span> <span class="n">new</span> <span class="n">ODataNotFoundException</span><span class="p">(</span><span class="n">ODataNotFoundException</span><span class="p">.</span><span class="n">ENTITY</span><span class="p">);</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<h3 id="add-expand-support-for-driver-tofrom-car-association">Add $expand support for Driver to/from Car association</h3>
+<p>The last missing step is to add the <code>$expand</code> support for the new Driver to/from Car association.</p>
+<h3 id="extend-mycallback-for-driver-and-car-association">Extend MyCallback for Driver and Car association</h3>
+<p>Add first the extension in the MyCallback for each entity is done in the <code>retrieveEntryResult()</code> method.
+The procedure is similar to the Cars - Manufacturers association. At first it is checked for the correct association of the requested Entity, then the key for requesting the DataStore is get as well as the data and then result data is attached to the <code>WriteEntryCallbackResult</code>.</p>
+<p>The resulting method extension is:</p>
+<div class="codehilite"><pre><span class="p">...</span>
+  <span class="k">if</span><span class="p">(</span><span class="n">isNavigationFromTo</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_CARS</span><span class="p">,</span> <span class="n">ENTITY_NAME_DRIVER</span><span class="p">))</span> <span class="p">{</span>
+    <span class="n">EntityProviderWriteProperties</span> <span class="n">inlineProperties</span> <span class="p">=</span> <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">serviceRoot</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">expandSelectTree</span><span class="p">(</span><span class="n">context</span><span class="p">.</span><span class="n">getCurrentExpandSelectTreeNode</span><span class="p">())</span>
+        <span class="p">.</span><span class="n">build</span><span class="p">();</span>
+
+    <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">keys</span> <span class="p">=</span> <span class="n">context</span><span class="p">.</span><span class="n">extractKeyFromEntryData</span><span class="p">();</span>
+    <span class="n">Integer</span> <span class="n">carId</span> <span class="p">=</span> <span class="p">(</span><span class="n">Integer</span><span class="p">)</span> <span class="n">keys</span><span class="p">.</span><span class="n">get</span><span class="p">(</span>&quot;<span class="n">Id</span>&quot;<span class="p">);</span>
+    <span class="n">result</span><span class="p">.</span><span class="n">setEntryData</span><span class="p">(</span><span class="n">dataStore</span><span class="p">.</span><span class="n">getDriverFor</span><span class="p">(</span><span class="n">carId</span><span class="p">));</span>
+    <span class="n">result</span><span class="p">.</span><span class="n">setInlineProperties</span><span class="p">(</span><span class="n">inlineProperties</span><span class="p">);</span>
+
+  <span class="p">}</span> <span class="k">else</span> <span class="k">if</span><span class="p">(</span><span class="n">isNavigationFromTo</span><span class="p">(</span><span class="n">context</span><span class="p">,</span> <span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">,</span> <span class="n">ENTITY_NAME_CAR</span><span class="p">))</span> <span class="p">{</span>
+    <span class="n">EntityProviderWriteProperties</span> <span class="n">inlineProperties</span> <span class="p">=</span> <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">serviceRoot</span><span class="p">)</span>
+        <span class="p">.</span><span class="n">expandSelectTree</span><span class="p">(</span><span class="n">context</span><span class="p">.</span><span class="n">getCurrentExpandSelectTreeNode</span><span class="p">())</span>
+        <span class="p">.</span><span class="n">build</span><span class="p">();</span>
+
+    <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">keys</span> <span class="p">=</span> <span class="n">context</span><span class="p">.</span><span class="n">extractKeyFromEntryData</span><span class="p">();</span>
+    <span class="n">Integer</span> <span class="n">driverId</span> <span class="p">=</span> <span class="p">(</span><span class="n">Integer</span><span class="p">)</span> <span class="n">keys</span><span class="p">.</span><span class="n">get</span><span class="p">(</span>&quot;<span class="n">Id</span>&quot;<span class="p">);</span>
+    <span class="n">result</span><span class="p">.</span><span class="n">setEntryData</span><span class="p">(</span><span class="n">dataStore</span><span class="p">.</span><span class="n">getCarFor</span><span class="p">(</span><span class="n">driverId</span><span class="p">));</span>
+    <span class="n">result</span><span class="p">.</span><span class="n">setInlineProperties</span><span class="p">(</span><span class="n">inlineProperties</span><span class="p">);</span>        
+  <span class="p">}</span>
+<span class="p">...</span>
+</pre></div>
+
+
+<h3 id="add-registration-of-mycallback-for-driver-and-car-association">Add registration of MyCallback for Driver and Car association</h3>
+<p>After extension of <code>MyCallback</code> it is necessary to register a callback within the <code>readEntity()</code> in the <code>MyODataSingleProcessor</code>.</p>
+<p>For the Driver we add the complete callback registration (code between the comments) which results in final code for the complete Driver Entity handling:</p>
+<div class="codehilite"><pre><span class="p">...</span>
+   <span class="p">}</span> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_SET_NAME_DRIVERS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+    <span class="n">int</span> <span class="n">id</span> <span class="p">=</span> <span class="n">getKeyValue</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getKeyPredicates</span><span class="p">().</span><span class="n">get</span><span class="p">(</span>0<span class="p">));</span>
+    <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">Object</span><span class="o">&gt;</span> <span class="n">data</span> <span class="p">=</span> <span class="n">dataStore</span><span class="p">.</span><span class="n">getDriver</span><span class="p">(</span><span class="n">id</span><span class="p">);</span>
+
+    <span class="k">if</span> <span class="p">(</span><span class="n">data</span> !<span class="p">=</span> <span class="n">null</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">URI</span> <span class="n">serviceRoot</span> <span class="p">=</span> <span class="n">getContext</span><span class="p">().</span><span class="n">getPathInfo</span><span class="p">().</span><span class="n">getServiceRoot</span><span class="p">();</span>
+      <span class="n">ODataEntityProviderPropertiesBuilder</span> <span class="n">propertiesBuilder</span> <span class="p">=</span> <span class="n">EntityProviderWriteProperties</span><span class="p">.</span><span class="n">serviceRoot</span><span class="p">(</span><span class="n">serviceRoot</span><span class="p">);</span>
+
+      <span class="o">//</span> <span class="n">create</span> <span class="n">and</span> <span class="n">register</span> <span class="n">callback</span>
+      <span class="n">Map</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">ODataCallback</span><span class="o">&gt;</span> <span class="n">callbacks</span> <span class="p">=</span> <span class="n">new</span> <span class="n">HashMap</span><span class="o">&lt;</span><span class="n">String</span><span class="p">,</span> <span class="n">ODataCallback</span><span class="o">&gt;</span><span class="p">();</span>
+      <span class="n">callbacks</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="n">ENTITY_NAME_CAR</span><span class="p">,</span> <span class="n">new</span> <span class="n">MyCallback</span><span class="p">(</span><span class="n">dataStore</span><span class="p">,</span> <span class="n">serviceRoot</span><span class="p">));</span>
+      <span class="n">ExpandSelectTreeNode</span> <span class="n">expandSelectTreeNode</span> <span class="p">=</span> <span class="n">UriParser</span><span class="p">.</span><span class="n">createExpandSelectTree</span><span class="p">(</span><span class="n">uriInfo</span><span class="p">.</span><span class="n">getSelect</span><span class="p">(),</span> <span class="n">uriInfo</span><span class="p">.</span><span class="n">getExpand</span><span class="p">());</span>
+      <span class="n">propertiesBuilder</span><span class="p">.</span><span class="n">expandSelectTree</span><span class="p">(</span><span class="n">expandSelectTreeNode</span><span class="p">).</span><span class="n">callbacks</span><span class="p">(</span><span class="n">callbacks</span><span class="p">);</span>
+      <span class="o">//</span> <span class="k">end</span> <span class="n">callback</span> <span class="n">handling</span>
+
+      <span class="k">return</span> <span class="n">EntityProvider</span><span class="p">.</span><span class="n">writeEntry</span><span class="p">(</span><span class="n">contentType</span><span class="p">,</span> <span class="n">entitySet</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">propertiesBuilder</span><span class="p">.</span><span class="n">build</span><span class="p">());</span>
+    <span class="p">}</span>
+  <span class="p">}</span>
+<span class="p">...</span>
+</pre></div>
+
+
+<p>For the Car it is only necessary to add the single code line below to register the additional callback and enable the <code>$expand</code>:</p>
+<div class="codehilite"><pre>  <span class="k">if</span> <span class="p">(</span><span class="n">ENTITY_SET_NAME_CARS</span><span class="p">.</span><span class="n">equals</span><span class="p">(</span><span class="n">entitySet</span><span class="p">.</span><span class="n">getName</span><span class="p">()))</span> <span class="p">{</span>
+<span class="p">...</span>
+      <span class="n">callbacks</span><span class="p">.</span><span class="n">put</span><span class="p">(</span><span class="n">ENTITY_NAME_DRIVER</span><span class="p">,</span> <span class="n">new</span> <span class="n">MyCallback</span><span class="p">(</span><span class="n">dataStore</span><span class="p">,</span> <span class="n">serviceRoot</span><span class="p">));</span>
+<span class="p">...</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Deploy, run and test
+Like in the basic read scenario follow these steps:</p>
+<ul>
+<li>Build your project mvn clean install </li>
+<li>Deploy in Web Application server. When using within Eclipse simply run the Web Application via Run As -&gt; Run on Server </li>
+<li>After successful server start and deployment the following uris from the read scenario work as before: <ul>
+<li>Show the Manufacturers: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers</a> </li>
+<li>Show one Manufacturer: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)</a> </li>
+<li>Show the Cars: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars</a> </li>
+<li>Show one Car: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)</a> </li>
+<li>Show the related Manufacturer of a Car: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)/Manufacturer">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)/Manufacturer</a> </li>
+<li>Show the related Cars of a Manufacturer: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)/Cars">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)/Cars </a></li>
+<li>Show Car with its Manufacturer: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)?$expand=Manufacturer">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Cars(2)?$expand=Manufacturer </a></li>
+<li>Show Manufacturer with its Cars: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)?$expand=Cars">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Manufacturers(1)?$expand=Cars </a></li>
+</ul>
+</li>
+<li>And in addition we now can access the drivers with their media resource ($value) and the association to their car. <ul>
+<li>Show one Driver: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)</a> </li>
+<li>Show Media Resource of Driver: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)/$value">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)/$value</a> </li>
+<li>Show Car of the Driver: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)/Car">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)/Car</a> </li>
+</ul>
+</li>
+<li>Show Driver with expanded Car: <a href="http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)?$expand=Car">http://localhost:8080/olingo.odata2.sample.cars.web/MyODataSample.svc/Drivers(3)?$expand=Car </a></li>
+</ul>
+<h3 id="conclusion">Conclusion</h3>
+<p>After finishing all steps of this tutorial your project contains three different entities with relations between them and one of them with media link entry and media resource support.</p>
+<p>If something does not compile or run it is recommended to compare to the complete sample project source code in the [Olingo Tutorial 'Basic Read with Media Resource extension' Project](apache-olingo-tutorial-adv_read_mediaresource. 
+For more details about how to use/setup the project in the zip see section <strong><em>Shortcut</em></strong>.</p>