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 2015/07/08 15:49:35 UTC
svn commit: r957524 [3/5] - in /websites/staging/olingo/trunk/content: ./
doc/javascript/ doc/odata2/ doc/odata2/tutorials/ doc/odata4/
doc/odata4/tutorials/ doc/odata4/tutorials/navigation/
doc/odata4/tutorials/read/ doc/odata4/tutorials/readep/ doc/o...
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/deltaClient.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/deltaClient.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/deltaClient.html Wed Jul 8 13:49:34 2015
@@ -86,17 +86,28 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="consuming-delta-responses">Consuming Delta Responses</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="consuming-delta-responses">Consuming Delta Responses<a class="headerlink" href="#consuming-delta-responses" title="Permanent link">¶</a></h1>
<p>Delta responses is a feature on top of OData 2.0 for requesting changes. The feature is defined in OData 4.0 and this is a preliminary and lightweight implementation close to the OData 4.0 specification <a href="http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/part1-protocol/odata-v4.0-errata02-os-part1-protocol-complete.html#_Toc406398316">(see here)</a>.</p>
<p>How delta responses can be produced by an OData service is documented here: <a href="/doc/odata2/tutorials/delta.html">server side delta responses</a>.</p>
-<h3 id="use-case">Use Case</h3>
+<h3 id="use-case">Use Case<a class="headerlink" href="#use-case" title="Permanent link">¶</a></h3>
<p>A client reads a feed and later wants to get only the update of changed and deleted entries. </p>
-<h3 id="principle">Principle</h3>
+<h3 id="principle">Principle<a class="headerlink" href="#principle" title="Permanent link">¶</a></h3>
<p>A client has to read a complete (paged) feed. With the last feed page the service has to provide a delta link instead of a next link. A delta link us usually the same feed url containing a delta token as proprietary query parameter. With the delta link the client can query the service again and gets back a delta feed containing entries which were changed or deleted since the complete feed was received.</p>
<p><img alt="Class Diagram Delta Feeds" src="/img/DeltaFeedClassDiagram.png" /></p>
-<h3 id="examples">Examples</h3>
+<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h3>
<p>Example for a delta link: <code>http://<host>:<port>/odata/Rooms?!deltatoken=123</code></p>
-<h5 id="delta-feed-handling">Delta Feed Handling</h5>
+<h5 id="delta-feed-handling">Delta Feed Handling<a class="headerlink" href="#delta-feed-handling" title="Permanent link">¶</a></h5>
<p>Depends on the general client sample <a href="...">here</a></p>
<div class="codehilite"><pre><span class="c1">// retrieve a feed</span>
<span class="n">ODataFeed</span> <span class="n">feed</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">readFeed</span><span class="p">(</span><span class="s">"Container1"</span><span class="p">,</span> <span class="s">"Rooms"</span><span class="p">,</span> <span class="n">contentType</span><span class="p">);</span>
@@ -118,7 +129,7 @@
</pre></div>
-<h5 id="response-deserialization">Response Deserialization</h5>
+<h5 id="response-deserialization">Response Deserialization<a class="headerlink" href="#response-deserialization" title="Permanent link">¶</a></h5>
<p>Precondition: Query the delta link using any HTTP client.</p>
<div class="codehilite"><pre><span class="n">InputStream</span> <span class="n">content</span> <span class="p">=</span> <span class="p">...;</span> <span class="o">//</span> <span class="n">retrieve</span> <span class="n">content</span>
@@ -129,7 +140,7 @@
</pre></div>
-<h3 id="links">Links</h3>
+<h3 id="links">Links<a class="headerlink" href="#links" title="Permanent link">¶</a></h3>
<ul>
<li>Delta Links (for Atom and Json)</li>
<li>Tombstones <a href="http://tools.ietf.org/html/rfc6721">RFC6721</a> for deleted entries in Atom format</li>
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/jpafunctionimport.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/jpafunctionimport.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/jpafunctionimport.html Wed Jul 8 13:49:34 2015
@@ -86,7 +86,18 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="adding-function-imports-to-odata-services-with-the-jpa-processor">Adding Function Imports to OData Services with the JPA Processor</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="adding-function-imports-to-odata-services-with-the-jpa-processor">Adding Function Imports to OData Services with the JPA Processor<a class="headerlink" href="#adding-function-imports-to-odata-services-with-the-jpa-processor" title="Permanent link">¶</a></h1>
<hr />
<p>Function imports are used to perform custom operations on a JPA entity in addition to CRUD operations. For example, consider a scenario where you would like to check the availability of an item to promise on the sales order line items. ATP check is a custom operation that can be exposed as a function import in the schema of OData service.</p>
<p>OData JPA Processor Library is enhanced to:</p>
@@ -98,7 +109,7 @@
<p>Add non JPA entity types as Complex Types to the EDM and use the same as Function Imports Return Type</p>
</li>
</ul>
-<h3 id="enabling-custom-operations-as-function-imports">Enabling Custom Operations as Function Imports</h3>
+<h3 id="enabling-custom-operations-as-function-imports">Enabling Custom Operations as Function Imports<a class="headerlink" href="#enabling-custom-operations-as-function-imports" title="Permanent link">¶</a></h3>
<ol>
<li>
<p>Create a dependency to EDM Annotation Project. This is required to use the annotations that are defined in the project.</p>
@@ -260,12 +271,12 @@
<p><em>Note</em>: You must register the class because the OData JPA Processor Library should be informed about the list of Java methods that it needs to process in a project. If we do not register, then OData JPA Processor Library should scan all the classes and the methods in the Java project looking for EDM annotations. In order to avoid such overload, it is mandatory to specify the list of Java methods that shall be transformed into function imports in a class.</p>
</li>
</ol>
-<h3 id="using-non-jpa-entities-added-to-the-edm-as-function-imports-return-type">Using Non JPA Entities added to the EDM as Function Imports Return Type</h3>
+<h3 id="using-non-jpa-entities-added-to-the-edm-as-function-imports-return-type">Using Non JPA Entities added to the EDM as Function Imports Return Type<a class="headerlink" href="#using-non-jpa-entities-added-to-the-edm-as-function-imports-return-type" title="Permanent link">¶</a></h3>
<p><strong>Prerequisite</strong></p>
<p>Add non JPA Entity Types as Complex Types to the EDM. See <a href="/doc/odata2/tutorials/ExtendingtheEDM.html">Extending the EDM Generated from the JPA Models</a> for more information.</p>
<p><em>Note</em>: The Simple Name of the Java class used as the return type in a Function Import and the name of the EDM Complex Type should be same.</p>
<p>Here is an example, you define the operations inside the <code>SalesOrderHeaderProcessor</code> class and then register this class inside <code>JPAEdmExtension</code> class <code>extendWithOperation</code>. </p>
-<h5 id="sample-code">Sample Code</h5>
+<h5 id="sample-code">Sample Code<a class="headerlink" href="#sample-code" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre> <span class="p">@</span><span class="n">EdmFunctionImport</span><span class="p">(</span><span class="n">returnType</span> <span class="p">=</span> <span class="p">@</span><span class="n">ReturnType</span><span class="p">(</span><span class="n">type</span> <span class="p">=</span> <span class="n">Type</span><span class="p">.</span><span class="n">COMPLEX</span><span class="p">))</span>
<span class="n">public</span> <span class="n">OrderValue</span> <span class="n">orderValue</span><span class="p">(</span>
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/jparedefinemetadata.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/jparedefinemetadata.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/jparedefinemetadata.html Wed Jul 8 13:49:34 2015
@@ -86,7 +86,18 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h3 id="redefining-metadata">Redefining Metadata</h3>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h3 id="redefining-metadata">Redefining Metadata<a class="headerlink" href="#redefining-metadata" title="Permanent link">¶</a></h3>
<p>The OData services created from JPA models using OData JPA Processor Library derives the names for its elements from Java Persistence Entity elements. These derived (default) names can be redefined using JPA EDM mapping models. JPA EDM Mapping model can be used to redefine:
<em> Schema Namespace Name
</em> Entity Type Names
@@ -104,7 +115,7 @@
<li>Complex Type Names are derived from Java Persistence Embeddable type names.</li>
</ol>
<p><em>Note</em>: The names generated by applying the above rules can be overridden using JPA EDM Mapping models. JPA EDM mapping model can be maintained as an XML document according to the schema.</p>
-<h4 id="steps-to-redefine-the-metadata">Steps to Redefine the Metadata</h4>
+<h4 id="steps-to-redefine-the-metadata">Steps to Redefine the Metadata<a class="headerlink" href="#steps-to-redefine-the-metadata" title="Permanent link">¶</a></h4>
<ol>
<li>Create a JPA EDM Mapping model XML according to the schema given below. In the XML, maintain the mapping only for those elements that needs to be redefined. For example, if JPA Entity Type A's name has to be redefined, then maintain an EDM name for the same.
Link to <a href="http://olingo.apache.org/resources/RedefiningTheMetadataSchema">Schema</a>.</li>
@@ -120,7 +131,7 @@
<p>Compile, deploy and run the web application in a web server. A sample JPA EDM Mapping Model is provided as an example below:</p>
</li>
</ol>
-<h5 id="sample-jpa-edm-mapping-model">Sample JPA EDM Mapping Model</h5>
+<h5 id="sample-jpa-edm-mapping-model">Sample JPA EDM Mapping Model<a class="headerlink" href="#sample-jpa-edm-mapping-model" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre> <span class="cp"><?xml version="1.0" encoding="UTF-8" ?></span>
- <span class="nt"><JPAEDMMappingModel</span> <span class="na">xmlns=</span><span class="s">"http://www.apache.org/olingo/odata2/jpa/processor/api/model/mapping"</span><span class="nt">></span>
- <span class="nt"><PersistenceUnit</span> <span class="na">name=</span><span class="s">"salesorderprocessing"</span><span class="nt">></span>
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/osgi.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/osgi.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/osgi.html Wed Jul 8 13:49:34 2015
@@ -86,12 +86,23 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="osgi-support">OSGi Support</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="osgi-support">OSGi Support<a class="headerlink" href="#osgi-support" title="Permanent link">¶</a></h1>
<p>All Apache Olingo artifacts are OSGi enabled and build as bundles. Apache Olingo is using the <a href="http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html">Apache Felix bundle plugin for Maven</a> to generate the manifest.mf file for each bundle.</p>
<p>The bundles expose the complete api (<code>org.apache.olingo.odata2.api.*</code>). From the implementation part (<code>org.apache.olingo.odata2.core.*</code>) only a minimum set of packages is exposed.</p>
<p>There is a difficulty in relation to class loading because of Apache Olingo core bundle has to load a specific custom service implementation without having a direct dependency to it.</p>
<p>In Apache Olingo OData2 Version 1.0.0 we solve this issue as follow: </p>
-<h3 id="servlet-filter-in-osgi">Servlet Filter in OSGi</h3>
+<h3 id="servlet-filter-in-osgi">Servlet Filter in OSGi<a class="headerlink" href="#servlet-filter-in-osgi" title="Permanent link">¶</a></h3>
<p>It is assumed that an OData service implementation is deployed as a native web application (war) or as web application bundle (OSGi Enterprise Expert Group on the RFC66 Web Container specification). In both cases the Apache Olingo core bundle is not aware of this application and its classloader cannot load applications service factory by default. </p>
<p>Adding this servlet filter to the service servlet configuration can solve this problem. The filter can bind the application classloader to the servlet request object, which is then used by the Apache Olingo core bundle to load applications factory class. </p>
<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">class</span> <span class="nc">ServiceFactoryFilter</span> <span class="kd">implements</span> <span class="n">Filter</span> <span class="o">{</span>
@@ -109,9 +120,9 @@
</pre></div>
-<h3 id="extended-osgi-support">Extended OSGi Support</h3>
+<h3 id="extended-osgi-support">Extended OSGi Support<a class="headerlink" href="#extended-osgi-support" title="Permanent link">¶</a></h3>
<p>The filter approach works fine for servlets but the Apache Olingo library can be used also for different, non-servlet based scenarios. </p>
-<h5 id="implement-own-odataapplication">Implement own ODataApplication</h5>
+<h5 id="implement-own-odataapplication">Implement own ODataApplication<a class="headerlink" href="#implement-own-odataapplication" title="Permanent link">¶</a></h5>
<p>A service has to implement an own <code>ODataApplication</code> and return the service factory class:</p>
<div class="codehilite"><pre><span class="kn">import</span> <span class="nn">org.apache.olingo.odata2.core.rest.app.AbstractODataApplication</span><span class="o">;</span>
@@ -125,7 +136,7 @@
</pre></div>
-<h5 id="register-application-in-servlet-context">Register Application in Servlet Context</h5>
+<h5 id="register-application-in-servlet-context">Register Application in Servlet Context<a class="headerlink" href="#register-application-in-servlet-context" title="Permanent link">¶</a></h5>
<p>Then register the application for any JAX-RS servlet implementation. Here it is the Apache CXF JAX-RS servlet.</p>
<div class="codehilite"><pre><span class="nt"><servlet></span>
<span class="nt"><servlet-name></span>CarServiceServlet<span class="nt"></servlet-name></span>
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_expand.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_expand.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_expand.html Wed Jul 8 13:49:34 2015
@@ -86,14 +86,25 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="read-scenario-read-with-expand">Read Scenario - Read with $expand</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="read-scenario-read-with-expand">Read Scenario - Read with $expand<a class="headerlink" href="#read-scenario-read-with-expand" title="Permanent link">¶</a></h1>
<hr />
-<h3 id="how-to-guide-extend-basic-read-scenario-with-support-for-expand">How To Guide - Extend basic read scenario with support for $expand</h3>
+<h3 id="how-to-guide-extend-basic-read-scenario-with-support-for-expand">How To Guide - Extend basic read scenario with support for $expand<a class="headerlink" href="#how-to-guide-extend-basic-read-scenario-with-support-for-expand" title="Permanent link">¶</a></h3>
<p>This How To Guide shows how to extend the basic read scenario with support for the $expand system query option.
It shows how to call the <code>EntityProvider.writeEntry(...)</code> and <code>EntityProvider.writeEntrySet(...)</code> methods with the necessary <code>EntityProviderWriteProperties</code> set and how to implement the necessary <code>OnWriteEntryContent OnWriteFeedContent</code> callbacks.</p>
-<h3 id="prerequisites">Prerequisites</h3>
+<h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h3>
<p>Setup of <a href="basicread">Basic Read Scenario</a></p>
-<h3 id="shortcut">Shortcut</h3>
+<h3 id="shortcut">Shortcut<a class="headerlink" href="#shortcut" title="Permanent link">¶</a></h3>
<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 <a href="apache-olingo-tutorial-adv_read_expand.zip">Olingo Tutorial 'Basic Read with $expand extension' Project</a> to your local drive which is your OData Tutorial project folder (referenced as <code>$ODATA_PROJECT_HOME</code> in the tutorial).</li>
@@ -108,14 +119,14 @@ It shows how to call the <code>EntityPro
</ul>
</li>
</ul>
-<h3 id="set-up-your-development-project">Set Up your development project</h3>
+<h3 id="set-up-your-development-project">Set Up your development project<a class="headerlink" href="#set-up-your-development-project" title="Permanent link">¶</a></h3>
<p>If <a href="basicread">Basic Read Scenario</a> is already set up there is nothing additional to do. Otherwise please refer to the Prerequisites section of the <a href="basicread">Basic Read Scenario</a>.</p>
-<h3 id="extend-basic-read-scenario">Extend Basic Read Scenario</h3>
+<h3 id="extend-basic-read-scenario">Extend Basic Read Scenario<a class="headerlink" href="#extend-basic-read-scenario" title="Permanent link">¶</a></h3>
<p>The steps to extend the basic read with $expand support for the Car and Manufacturer entities (not entity sets) are to provide the expanded data via ODataCallbacks and register these for the corresponding navigation properties. </p>
-<h3 id="implement-onwriteentrycontent-and-onwritefeedcontent-callbacks">Implement OnWriteEntryContent and OnWriteFeedContent callbacks</h3>
+<h3 id="implement-onwriteentrycontent-and-onwritefeedcontent-callbacks">Implement OnWriteEntryContent and OnWriteFeedContent callbacks<a class="headerlink" href="#implement-onwriteentrycontent-and-onwritefeedcontent-callbacks" title="Permanent link">¶</a></h3>
<p>To support <code>$expand</code> for a single entry the interface <code>org.apache.olingo.odata2.api.ep.callback.OnWriteEntryContent</code> must be implemented. This provides the method <code>WriteEntryCallbackResult retrieveEntryResult(WriteEntryCallbackContext context) throws ODataApplicationException;</code> which is called during processing from the <code>EntityProvider</code> to receive the necessary data which than is inlined in the response.</p>
<p>In our sample we create a class <code>MyCallback</code> which implements <code>org.apache.olingo.odata2.api.ep.callback.OnWriteEntryContent</code> in following way:</p>
-<h5 id="sample-code">Sample Code</h5>
+<h5 id="sample-code">Sample Code<a class="headerlink" href="#sample-code" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="nd">@Override</span>
<span class="kd">public</span> <span class="n">WriteEntryCallbackResult</span> <span class="nf">retrieveEntryResult</span><span class="o">(</span><span class="n">WriteEntryCallbackContext</span> <span class="n">context</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">ODataApplicationException</span> <span class="o">{</span>
<span class="n">WriteEntryCallbackResult</span> <span class="n">result</span> <span class="o">=</span> <span class="k">new</span> <span class="n">WriteEntryCallbackResult</span><span class="o">();</span>
@@ -145,10 +156,10 @@ It shows how to call the <code>EntityPro
<p>Within this method we first check if the source entity and navigation property are correct for our case (via the method <code>isNavigationFromTo(...):boolean)</code>, then we create the <code>EntityProviderWriteProperties</code> with the new (current) <code>ExpandSelectTreeNode</code>, receive the data from our <code>DataStore</code> and put all into the result which then will be further processed by the <code>EntityProvider</code>.</p>
-<h3 id="implementation-for-expand-for-an-entity-set">Implementation for $expand for an entity set</h3>
+<h3 id="implementation-for-expand-for-an-entity-set">Implementation for $expand for an entity set<a class="headerlink" href="#implementation-for-expand-for-an-entity-set" title="Permanent link">¶</a></h3>
<p>To support <code>$expand</code> for a feed of entries (entity set) the interface <code>org.apache.olingo.odata2.api.ep.callback.OnWriteFeedContent</code> must be implemented. These provides the method <code>WriteFeedCallbackResult retrieveFeedResult(WriteFeedCallbackContext context) throws ODataApplicationException;</code> which is called during processing from the <code>EntityProvider</code> to receive the necessary data which than is inlined in the response.</p>
<p>It is possible to create an additional callback class but for convenience we expand our already created callback (<code>MyCallback</code>) to implement <code>org.apache.olingo.odata2.api.ep.callback.OnWriteFeedContent</code> and provide the method implementation in following way:</p>
-<h5 id="sample-code_1">Sample Code</h5>
+<h5 id="sample-code_1">Sample Code<a class="headerlink" href="#sample-code_1" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="nd">@Override</span>
<span class="kd">public</span> <span class="n">WriteFeedCallbackResult</span> <span class="nf">retrieveFeedResult</span><span class="o">(</span><span class="n">WriteFeedCallbackContext</span> <span class="n">context</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">ODataApplicationException</span> <span class="o">{</span>
<span class="n">WriteFeedCallbackResult</span> <span class="n">result</span> <span class="o">=</span> <span class="k">new</span> <span class="n">WriteFeedCallbackResult</span><span class="o">();</span>
@@ -179,7 +190,7 @@ It shows how to call the <code>EntityPro
<p>Within this method we first check if the source entity and navigation property are correct for our case (via the method <code>isNavigationFromTo(...):boolean)</code>, then we create the <code>EntityProviderWriteProperties</code> with the new (current) <code>ExpandSelectTreeNode</code>, receive the data from our <code>DataStore</code> and put all into the result which then will be further processed by the <code>EntityProvider</code>.</p>
<p>This example shows that the basic callback logic between <code>OnWriteEntryConten</code>t and <code>OnWriteFeedContent</code> is very similar. Validation of current element (optional), preparing of <code>EntityProviderWriteProperties</code>, receive of data and putting all together into corresponding result object (<code>WriteEntryCallbackResult</code> or <code>WriteFeedCallbackResult</code>).</p>
<p>To improve code readability the <code>isNavigationFromTo(...):boolean</code> method was also added to the class. The method is used to check if the retrieved request is related to given entity set and navigation:</p>
-<h4 id="sample-code_2">Sample Code</h4>
+<h4 id="sample-code_2">Sample Code<a class="headerlink" href="#sample-code_2" title="Permanent link">¶</a></h4>
<div class="codehilite"><pre><span class="kd">private</span> <span class="kt">boolean</span> <span class="nf">isNavigationFromTo</span><span class="o">(</span><span class="n">WriteCallbackContext</span> <span class="n">context</span><span class="o">,</span> <span class="n">String</span> <span class="n">entitySetName</span><span class="o">,</span> <span class="n">String</span> <span class="n">navigationPropertyName</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">EdmException</span> <span class="o">{</span>
<span class="k">if</span><span class="o">(</span><span class="n">entitySetName</span> <span class="o">==</span> <span class="kc">null</span> <span class="o">||</span> <span class="n">navigationPropertyName</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="kc">false</span><span class="o">;</span>
@@ -191,7 +202,7 @@ It shows how to call the <code>EntityPro
</pre></div>
-<h3 id="extend-odatasingleprocessorreadentity">Extend ODataSingleProcessor.readEntity(...)</h3>
+<h3 id="extend-odatasingleprocessorreadentity">Extend ODataSingleProcessor.readEntity(...)<a class="headerlink" href="#extend-odatasingleprocessorreadentity" title="Permanent link">¶</a></h3>
<p>The necessary callbacks (<code>MyCallback</code> class) now has to be registered during the corresponding <code>readEntity(...)</code> call. Therefore we first create a map with the property name as key and the according callback as value. Additional we need to create the <code>ExpandSelectTreeNode</code> based on current element position. Both then have to be set in the <code>EntityProviderWritePropertiesBuilder</code>. </p>
<p>The following code show the few lines we need for extending the read of a car with its expanded manufacturer.</p>
<div class="codehilite"><pre><span class="c1">// create and register callback</span>
@@ -272,7 +283,7 @@ It shows how to call the <code>EntityPro
<p>Now we can test out <code>$expand</code> extension in the web application.</p>
-<h3 id="deploy-run-and-test-expand">Deploy, run and test $expand</h3>
+<h3 id="deploy-run-and-test-expand">Deploy, run and test $expand<a class="headerlink" href="#deploy-run-and-test-expand" title="Permanent link">¶</a></h3>
<p>Like in the basic read scenario follow these steps:</p>
<ul>
<li>Build your project: <code>mvn clean install</code> </li>
@@ -292,7 +303,7 @@ It shows how to call the <code>EntityPro
</ul>
</li>
</ul>
-<h3 id="further-information">Further Information</h3>
+<h3 id="further-information">Further Information<a class="headerlink" href="#further-information" title="Permanent link">¶</a></h3>
<p>Next extension step for read scenario are read of <a href="read_media-resource">Media Resources</a>. </p><div align="center">
<p>Copyright © 2013-2015, The Apache Software Foundation<br>
Apache Olingo, Olingo, Apache, the Apache feather, and
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_media-resource.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_media-resource.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/read_media-resource.html Wed Jul 8 13:49:34 2015
@@ -86,15 +86,26 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="media-resources">Media Resources</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="media-resources">Media Resources<a class="headerlink" href="#media-resources" title="Permanent link">¶</a></h1>
<hr />
-<h3 id="how-to-guide-extend-read-scenario-with-support-for-media-resources">How To Guide - Extend read scenario with support for media resources</h3>
+<h3 id="how-to-guide-extend-read-scenario-with-support-for-media-resources">How To Guide - Extend read scenario with support for media resources<a class="headerlink" href="#how-to-guide-extend-read-scenario-with-support-for-media-resources" title="Permanent link">¶</a></h3>
<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>
-<h3 id="prerequisites">Prerequisites</h3>
+<h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h3>
<p>Setup of <a href="read_expand">Read Scenario with <code>$expand</code></a> extension
(which has as prerequisite Setup of <a href="basicread">Basic Read Scenario</a>)</p>
-<h3 id="shortcut">Shortcut</h3>
+<h3 id="shortcut">Shortcut<a class="headerlink" href="#shortcut" title="Permanent link">¶</a></h3>
<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.zip">Olingo Tutorial 'Basic Read with Media Resource extension' Project</a> to your local drive which is your OData Tutorial project folder (referenced as <code>$ODATA_PROJECT_HOME</code> in the turorial).</li>
@@ -112,15 +123,15 @@
</ul>
</li>
</ul>
-<h3 id="hints">Hints</h3>
+<h3 id="hints">Hints<a class="headerlink" href="#hints" title="Permanent link">¶</a></h3>
<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>
-<h3 id="extend-read-scenario">Extend Read Scenario</h3>
+<h3 id="extend-read-scenario">Extend Read Scenario<a class="headerlink" href="#extend-read-scenario" title="Permanent link">¶</a></h3>
<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>
-<h4 id="small-sample-code-prerequisites">Small sample code Prerequisites</h4>
+<h3 id="extend-myedmprovider-and-myodatasingleprocessor">Extend MyEdmProvider and MyODataSingleProcessor<a class="headerlink" href="#extend-myedmprovider-and-myodatasingleprocessor" title="Permanent link">¶</a></h3>
+<h4 id="small-sample-code-prerequisites">Small sample code Prerequisites<a class="headerlink" href="#small-sample-code-prerequisites" title="Permanent link">¶</a></h4>
<p>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>
@@ -139,7 +150,7 @@ If nothing is copied/created the sample
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>
-<h5 id="sample-code">Sample Code</h5>
+<h5 id="sample-code">Sample Code<a class="headerlink" href="#sample-code" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="err">â¦</span>
<span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="n">ENTITY_TYPE_1_3</span><span class="o">.</span><span class="na">getName</span><span class="o">().</span><span class="na">equals</span><span class="o">(</span><span class="n">edmFQName</span><span class="o">.</span><span class="na">getName</span><span class="o">()))</span> <span class="o">{</span>
<span class="n">List</span><span class="o"><</span><span class="n">Property</span><span class="o">></span> <span class="n">properties</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">Property</span><span class="o">>();</span>
@@ -451,7 +462,7 @@ Like in the basic read scenario follow t
</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>
+<h3 id="conclusion">Conclusion<a class="headerlink" href="#conclusion" title="Permanent link">¶</a></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 <a href="apache-olingo-tutorial-adv_read_mediaresource">Olingo Tutorial 'Basic Read with Media Resource extension' Project</a>.
For more details about how to use/setup the project in the zip see section <strong><em>Shortcut</em></strong>.</p><div align="center">
Modified: websites/staging/olingo/trunk/content/doc/odata2/tutorials/servlet.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata2/tutorials/servlet.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata2/tutorials/servlet.html Wed Jul 8 13:49:34 2015
@@ -86,7 +86,18 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="servlet-support">Servlet Support</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="servlet-support">Servlet Support<a class="headerlink" href="#servlet-support" title="Permanent link">¶</a></h1>
<p>Originally the Olingo OData 2.0 server library has been implemented
based on JAX-RS to take advantage of the REST based CXF features.</p>
<p>With the development of Olingo URI parser it was possible now also
@@ -98,7 +109,7 @@ which are out of the box are not availab
<p>For testing the feature it is recommended to start with the
<a href="http://olingo.incubator.apache.org/doc/odata2/sample-setup.html">sample setup</a> using the Olingo archetype and do the following
modifications.</p>
-<h3 id="maven-dependencies">Maven Dependencies</h3>
+<h3 id="maven-dependencies">Maven Dependencies<a class="headerlink" href="#maven-dependencies" title="Permanent link">¶</a></h3>
<p>For a plain servlet based approach it is possible to exclude JAX-RS
dependencies. A simple way is to exclude them with Maven:</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
@@ -117,7 +128,7 @@ dependencies. A simple way is to exclude
<p>A JAX-RS implementation dependency like Apache CXF is not required
for runtime.</p>
-<h3 id="adopt-webxml">Adopt web.xml</h3>
+<h3 id="adopt-webxml">Adopt web.xml<a class="headerlink" href="#adopt-webxml" title="Permanent link">¶</a></h3>
<p>For using the servlet based approach only a new Servlet must be
configured in web.xml file:</p>
<div class="codehilite"><pre><span class="nt"><servlet></span>
Modified: websites/staging/olingo/trunk/content/doc/odata4/dependencies.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/dependencies.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/dependencies.html Wed Jul 8 13:49:34 2015
@@ -86,9 +86,20 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="maven-dependencies">Maven Dependencies</h1>
-<h3 id="consuming-olingo-odata-40-library">Consuming Olingo OData 4.0 Library</h3>
-<h5 id="common-dependencies">Common Dependencies</h5>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="maven-dependencies">Maven Dependencies<a class="headerlink" href="#maven-dependencies" title="Permanent link">¶</a></h1>
+<h3 id="consuming-olingo-odata-40-library">Consuming Olingo OData 4.0 Library<a class="headerlink" href="#consuming-olingo-odata-40-library" title="Permanent link">¶</a></h3>
+<h5 id="common-dependencies">Common Dependencies<a class="headerlink" href="#common-dependencies" title="Permanent link">¶</a></h5>
<p>The following common dependencies needs to be added to the pom.xml of the consuming project:</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
@@ -103,7 +114,7 @@
</pre></div>
-<h5 id="odata-client-dependencies">OData Client Dependencies</h5>
+<h5 id="odata-client-dependencies">OData Client Dependencies<a class="headerlink" href="#odata-client-dependencies" title="Permanent link">¶</a></h5>
<p>For realization of <em>OData-Client</em> projects additional dependencies are necessary:</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
@@ -120,7 +131,7 @@
</pre></div>
-<h5 id="odata-client-dependencies_1">OData Client Dependencies</h5>
+<h5 id="odata-client-dependencies_1">OData Client Dependencies<a class="headerlink" href="#odata-client-dependencies_1" title="Permanent link">¶</a></h5>
<p>For realization of <em>OData-Server</em> projects additional dependencies are necessary:</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
Modified: websites/staging/olingo/trunk/content/doc/odata4/download.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/download.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/download.html Wed Jul 8 13:49:34 2015
@@ -86,14 +86,25 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="download-odata-40-java-library">Download OData 4.0 Java Library</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="download-odata-40-java-library">Download OData 4.0 Java Library<a class="headerlink" href="#download-odata-40-java-library" title="Permanent link">¶</a></h1>
<p>Apache Olingo OData4 is a collection of Java libraries for
implementing <a href="http://odata.org">OData V4</a> protocol clients or servers.</p>
-<h3 id="release-400-beta-03-2015-05-11">Release 4.0.0-beta-03 (2015-05-11)</h3>
+<h3 id="release-400-beta-03-2015-05-11">Release 4.0.0-beta-03 (2015-05-11)<a class="headerlink" href="#release-400-beta-03-2015-05-11" title="Permanent link">¶</a></h3>
<p><a href="https://dist.apache.org/repos/dist/release/olingo/odata4/4.0.0-beta-03/">Full download page</a>, <a href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12314520&version=12329347">release notes</a></p>
<p>The Apache <em>Olingo OData4 4.0.0-beta-03</em> release is the third and final beta release for the <em>OData V4</em> specifications.</p>
-<h3 id="commodity-packages">Commodity Packages</h3>
-<table>
+<h3 id="commodity-packages">Commodity Packages<a class="headerlink" href="#commodity-packages" title="Permanent link">¶</a></h3>
+<table class="table">
<thead>
<tr>
<th>Package</th>
@@ -129,13 +140,13 @@ implementing <a href="http://odata.org">
</tr>
</tbody>
</table>
-<h3 id="maven">Maven</h3>
+<h3 id="maven">Maven<a class="headerlink" href="#maven" title="Permanent link">¶</a></h3>
<p>All Apache Olingo OData4 artifacts are available at <a href="http://search.maven.org/#search|ga|1|org.apache.olingo">Maven Central</a>.
For POM dependencies see <a href="/doc/odata4/maven.html">here</a>.</p>
-<h3 id="older-releases">Older Releases</h3>
+<h3 id="older-releases">Older Releases<a class="headerlink" href="#older-releases" title="Permanent link">¶</a></h3>
<p>For older releases please refer to <a href="http://archive.apache.org/dist/olingo/">Archives</a>
or you can get them <a href="/doc/odata4/maven.html">using Maven</a>.</p>
-<h3 id="verify-authenticity-of-downloads-package">Verify Authenticity of Downloads package</h3>
+<h3 id="verify-authenticity-of-downloads-package">Verify Authenticity of Downloads package<a class="headerlink" href="#verify-authenticity-of-downloads-package" title="Permanent link">¶</a></h3>
<p>While downloading the packages, make yourself familiar
on how to verify their integrity, authenticity and provenience
according to the Apache Software Foundation best practices.
Modified: websites/staging/olingo/trunk/content/doc/odata4/eclipse.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/eclipse.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/eclipse.html Wed Jul 8 13:49:34 2015
@@ -86,7 +86,18 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="eclipse-ide-support">Eclipse IDE Support</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="eclipse-ide-support">Eclipse IDE Support<a class="headerlink" href="#eclipse-ide-support" title="Permanent link">¶</a></h1>
<hr />
<p><a href="http://eclipse.org">Eclipse</a> (in version <code>Juno</code> and <code>Kepler</code>) is supported by the project.</p>
<p>With the Maven project files can be generated with:</p>
Modified: websites/staging/olingo/trunk/content/doc/odata4/index.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/index.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/index.html Wed Jul 8 13:49:34 2015
@@ -86,14 +86,25 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="documentation-odata-40-java-library">Documentation OData 4.0 Java Library</h1>
-<h3 id="how-to-start">How to Start</h3>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="documentation-odata-40-java-library">Documentation OData 4.0 Java Library<a class="headerlink" href="#documentation-odata-40-java-library" title="Permanent link">¶</a></h1>
+<h3 id="how-to-start">How to Start<a class="headerlink" href="#how-to-start" title="Permanent link">¶</a></h3>
<ul>
<li><a href="/doc/odata4/dependencies.html">Maven Dependencies</a></li>
<li><a href="/doc/odata4/tutorials/od4_quick_start_sample.html">QuickStart with an existing sample service</a> </li>
</ul>
-<h3 id="tutorials-odata-40">Tutorials (OData 4.0)</h3>
-<h5 id="olingo-for-server-usage">Olingo for Server usage</h5>
+<h3 id="tutorials-odata-40">Tutorials (OData 4.0)<a class="headerlink" href="#tutorials-odata-40" title="Permanent link">¶</a></h3>
+<h5 id="olingo-for-server-usage">Olingo for Server usage<a class="headerlink" href="#olingo-for-server-usage" title="Permanent link">¶</a></h5>
<ul>
<li>Basic Tutorial: Create an OData V4 Service with Olingo<ul>
<li><a href="/doc/odata4/tutorials/read/tutorial_read.html">Tutorial Part 1: Create a read service (with Eclipse)</a><ul>
@@ -105,17 +116,17 @@
</ul>
</li>
</ul>
-<h3 id="javadoc">Javadoc</h3>
+<h3 id="javadoc">Javadoc<a class="headerlink" href="#javadoc" title="Permanent link">¶</a></h3>
<ul>
<li><a href="/javadoc/odata4/index.html">Javadoc for OData 4.0 Library</a></li>
</ul>
-<h3 id="olingo-project-setup-contributors">Olingo Project Setup (Contributors)</h3>
+<h3 id="olingo-project-setup-contributors">Olingo Project Setup (Contributors)<a class="headerlink" href="#olingo-project-setup-contributors" title="Permanent link">¶</a></h3>
<ul>
<li><a href="/doc/odata4/maven.html">Git and Maven Support</a></li>
<li><a href="/doc/odata4/eclipse.html">Eclipse IDE Support</a></li>
<li><a href="/doc/odata4/release.html">Release Documentation</a></li>
</ul>
-<h3 id="external-articles-blog-entries-and-tutorials">External Articles, Blog-Entries and Tutorials</h3>
+<h3 id="external-articles-blog-entries-and-tutorials">External Articles, Blog-Entries and Tutorials<a class="headerlink" href="#external-articles-blog-entries-and-tutorials" title="Permanent link">¶</a></h3>
<ul>
<li>Series of blog articles which show a tutorial on how to use Olingo as client library<ul>
<li><a href="http://templth.wordpress.com/2014/12/03/accessing-odata-v4-service-with-olingo/">Accessing data of OData v4 services with Olingo</a></li>
Modified: websites/staging/olingo/trunk/content/doc/odata4/maven.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/maven.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/maven.html Wed Jul 8 13:49:34 2015
@@ -86,17 +86,28 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="building-the-olingo-project">Building the Olingo Project</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="building-the-olingo-project">Building the Olingo Project<a class="headerlink" href="#building-the-olingo-project" title="Permanent link">¶</a></h1>
<hr />
<p>The project uses Git for source code management and version control and uses Maven for build.</p>
-<h3 id="clone-the-project">Clone the project</h3>
+<h3 id="clone-the-project">Clone the project<a class="headerlink" href="#clone-the-project" title="Permanent link">¶</a></h3>
<p>To get the code for just clone the project from:</p>
-<h5 id="odata-40-repository">OData 4.0 repository</h5>
+<h5 id="odata-40-repository">OData 4.0 repository<a class="headerlink" href="#odata-40-repository" title="Permanent link">¶</a></h5>
<div class="codehilite"><pre><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="o">-</span><span class="n">wip</span><span class="o">-</span><span class="n">us</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">asf</span><span class="o">/</span><span class="n">olingo</span><span class="o">-</span><span class="n">odata4</span>
</pre></div>
-<h3 id="building-the-project">Building the Project</h3>
+<h3 id="building-the-project">Building the Project<a class="headerlink" href="#building-the-project" title="Permanent link">¶</a></h3>
<p>The project builds with Maven. Simply call</p>
<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span>
</pre></div>
Modified: websites/staging/olingo/trunk/content/doc/odata4/project-setup.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/project-setup.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/project-setup.html Wed Jul 8 13:49:34 2015
@@ -86,17 +86,28 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="project-setup">Project Setup</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="project-setup">Project Setup<a class="headerlink" href="#project-setup" title="Permanent link">¶</a></h1>
<hr />
-<h3 id="build-environment">Build Environment</h3>
+<h3 id="build-environment">Build Environment<a class="headerlink" href="#build-environment" title="Permanent link">¶</a></h3>
<ul>
<li><a href="maven.html">Maven</a></li>
</ul>
-<h3 id="development-environment">Development Environment</h3>
+<h3 id="development-environment">Development Environment<a class="headerlink" href="#development-environment" title="Permanent link">¶</a></h3>
<ul>
<li><a href="eclipse.html">Eclipse IDE</a></li>
</ul>
-<h3 id="run-environment">Run Environment</h3>
+<h3 id="run-environment">Run Environment<a class="headerlink" href="#run-environment" title="Permanent link">¶</a></h3>
<ul>
<li><a href="tomcat.html">Run with Tomcat</a></li>
</ul><div align="center">
Modified: websites/staging/olingo/trunk/content/doc/odata4/release.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/release.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/release.html Wed Jul 8 13:49:34 2015
@@ -86,16 +86,27 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="apache-olingo-release-documentation">Apache Olingo Release Documentation</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="apache-olingo-release-documentation">Apache Olingo Release Documentation<a class="headerlink" href="#apache-olingo-release-documentation" title="Permanent link">¶</a></h1>
<hr />
-<h3 id="introduction">Introduction</h3>
+<h3 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h3>
<p>This document describes the release guidelines for Apache Olingo. It heavily refers
to <a href="http://maven.apache.org/developers/release/apache-release.html">standard Apache procedures to release</a>
Maven based projects at Apache.</p>
-<h3 id="build-environments">Build Environments</h3>
+<h3 id="build-environments">Build Environments<a class="headerlink" href="#build-environments" title="Permanent link">¶</a></h3>
<p>Apache Olingo is built and released with <a href="http://maven.apache.org">Maven3</a> and uses
the <a href="http://svn.apache.org/repos/asf/maven/pom/tags/apache-13/pom.xml">Apache POM version 13</a>.</p>
-<h3 id="release-artifacts">Release Artifacts</h3>
+<h3 id="release-artifacts">Release Artifacts<a class="headerlink" href="#release-artifacts" title="Permanent link">¶</a></h3>
<p>An Apache Olingo release consists of:</p>
<ul>
<li>All POMs/JARs/WARs built as part of the standard Maven build process. For
@@ -133,16 +144,16 @@ library and dependencies required to imp
and dependencies required to implement an OData V4 client for Android devices. <br/> <strong>Package formats</strong>: zip.</p>
</li>
</ul>
-<h3 id="documentation-and-javadoc">Documentation and JavaDoc</h3>
+<h3 id="documentation-and-javadoc">Documentation and JavaDoc<a class="headerlink" href="#documentation-and-javadoc" title="Permanent link">¶</a></h3>
<p>The documentation that will be part of the release must match the code.
All examples in the documentation must work. The Java package documentation must be
up-to-date. Release independend documentation is maintained on the <a href="http://olingo.apache.org/documentation.html">Apache Olingo Documentation</a> page.</p>
-<h3 id="preparation">Preparation</h3>
-<h5 id="release-manager">Release Manager</h5>
+<h3 id="preparation">Preparation<a class="headerlink" href="#preparation" title="Permanent link">¶</a></h3>
+<h5 id="release-manager">Release Manager<a class="headerlink" href="#release-manager" title="Permanent link">¶</a></h5>
<p>A release manager must be appointed for a release. He or she is in charge of the release process,
following the guidelines and eventually generating the release artifacts.
The release manager might tailor the process for a specific release.</p>
-<h5 id="version">Version</h5>
+<h5 id="version">Version<a class="headerlink" href="#version" title="Permanent link">¶</a></h5>
<p>The Olingo community decides if the release will be a major or a minor release and
agrees on a version number.</p>
<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">versions</span><span class="p">:</span><span class="n">set</span> <span class="o">-</span><span class="n">DnewVersion</span><span class="p">=</span>1<span class="p">.</span>0<span class="p">.</span>0<span class="o">-</span><span class="n">RC01</span>
@@ -160,10 +171,10 @@ agrees on a version number.</p>
</pre></div>
-<h5 id="open-issues">Open Issues</h5>
+<h5 id="open-issues">Open Issues<a class="headerlink" href="#open-issues" title="Permanent link">¶</a></h5>
<p>There must not be any open JIRA issues for this release. There might be open issues for
future releases. Check with: <a href="https://issues.apache.org/jira/browse/OLINGO/fixforversion/12324804">fix for version view</a></p>
-<h5 id="unit-tests-and-integration-tests">Unit Tests and Integration Tests</h5>
+<h5 id="unit-tests-and-integration-tests">Unit Tests and Integration Tests<a class="headerlink" href="#unit-tests-and-integration-tests" title="Permanent link">¶</a></h5>
<p>All unit tests and integration tests must succeed on a
clean machine (starting with an empty local Maven repository). The following Maven
execution will run all unit and integration tests:</p>
@@ -171,7 +182,7 @@ execution will run all unit and integrat
</pre></div>
-<h5 id="apache-license-and-code-style">Apache License and Code Style</h5>
+<h5 id="apache-license-and-code-style">Apache License and Code Style<a class="headerlink" href="#apache-license-and-code-style" title="Permanent link">¶</a></h5>
<p>Each source code file must have a current ASF license header. The source
code should follow the Apache Olingo code style. For verification run following
Maven execution</p>
@@ -179,7 +190,7 @@ Maven execution</p>
</pre></div>
-<h5 id="packaging">Packaging</h5>
+<h5 id="packaging">Packaging<a class="headerlink" href="#packaging" title="Permanent link">¶</a></h5>
<p>NOTICE, LICENSE and DISCLAIMER must be present in all bundles and must be up-to-date.</p>
<p>Remote resources are provided by the ASF and the Maven <code>remote-resources-plugin</code> is
configured in the parent pom of the project.</p>
@@ -190,22 +201,22 @@ configured in the parent pom of the proj
<p>The Maven module <code>odata-dist</code> (in project sub-folder <code>dist</code>) is responsible to package convenience distribution zip files
using the assembly plugin. The distributions are created with a release build <code>mvn clean install -Papache-release -Dgpg.passphrase="yourPassphraseHere"</code></p>
-<h5 id="md5-and-sha-for-distribution-packages">MD5 and SHA for distribution packages</h5>
+<h5 id="md5-and-sha-for-distribution-packages">MD5 and SHA for distribution packages<a class="headerlink" href="#md5-and-sha-for-distribution-packages" title="Permanent link">¶</a></h5>
<p>MD5 and SHA files are created manually for distribution packages:</p>
<div class="codehilite"><pre>openssl md5 <span class="nt">< </span><span class="cp">${</span><span class="n">filename</span><span class="cp">}</span><span class="nt">.zip</span> <span class="nt">></span> <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip.md5
gpg --print-md SHA512 <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip > <span class="cp">${</span><span class="n">filename</span><span class="cp">}</span>.zip.sha512
</pre></div>
-<h5 id="release-tag">Release Tag</h5>
+<h5 id="release-tag">Release Tag<a class="headerlink" href="#release-tag" title="Permanent link">¶</a></h5>
<p>A tag has to be created for every release candidate. The naming rule
for the tags is <code>${version}-RCxx</code>. This is created as
part of the Maven release process. The tag will be renamed to the
final version number upon vote approval.</p>
-<h5 id="release-branch">Release Branch</h5>
+<h5 id="release-branch">Release Branch<a class="headerlink" href="#release-branch" title="Permanent link">¶</a></h5>
<p>A branch has to be created for every release. The naming rule for this
branch is <code>${version}</code>. This has to be created manually upon release approval.</p>
-<h3 id="release-candidate">Release Candidate</h3>
+<h3 id="release-candidate">Release Candidate<a class="headerlink" href="#release-candidate" title="Permanent link">¶</a></h3>
<p>Once all preparations are done, a release candidate will be built.</p>
<p>All release candidates must be cryptographically signed. The string
"<code>-RCxx</code>" will be attached to the version number of the release candidate
@@ -223,7 +234,7 @@ http://people.apache.org/~[username]/oli
<p>If the vote fails, the raised issues will be fixed, a new release candidate will be
built and the VOTE process will be restarted.</p>
<p>If the release candidate gets approved, we can proceed to release publishing.</p>
-<h4 id="how-to-verify-a-release-candidate">How to verify a Release Candidate</h4>
+<h4 id="how-to-verify-a-release-candidate">How to verify a Release Candidate<a class="headerlink" href="#how-to-verify-a-release-candidate" title="Permanent link">¶</a></h4>
<p>This checklist helps verifying if a release candidate is valid:</p>
<ul>
<li>Are all files on "http://people.apache.org/~[username]/olingo2/[version]"?</li>
@@ -237,7 +248,7 @@ built and the VOTE process will be resta
</ul>
<p>After all questions of this checklist can be answered with yes it is OK to give a +1 on the mailing list.
Of course the Release Manager can also use this checklist to make sure all artifacts are correct before publishing the results on the mailing list.</p>
-<h3 id="publishing-the-release">Publishing the Release</h3>
+<h3 id="publishing-the-release">Publishing the Release<a class="headerlink" href="#publishing-the-release" title="Permanent link">¶</a></h3>
<p>If the release candidate gets approved, we can proceed to release publishing:</p>
<ul>
<li>Release candidate maven artifacts are promoted in the Apache Maven Repository and
@@ -255,11 +266,11 @@ signatures) to <a href="http://www.apach
<li>Release is closed in Jira.</li>
<li>Release is announced to dev@olingo.apache.org, announce@apache.org.</li>
</ul>
-<h3 id="maintain-version-section-in-doap-file">Maintain Version Section in DOAP File</h3>
+<h3 id="maintain-version-section-in-doap-file">Maintain Version Section in DOAP File<a class="headerlink" href="#maintain-version-section-in-doap-file" title="Permanent link">¶</a></h3>
<p><a href="http://olingo.apache.org/doap_Olingo.rdf">http://olingo.apache.org/doap_Olingo.rdf</a></p>
<p>Results are shown here:</p>
<p><a href="http://projects.apache.org/indexes/alpha.html#O">link text</a></p>
-<h3 id="additional-apache-release-information">Additional Apache Release Information</h3>
+<h3 id="additional-apache-release-information">Additional Apache Release Information<a class="headerlink" href="#additional-apache-release-information" title="Permanent link">¶</a></h3>
<ul>
<li><a href="http://www.apache.org/dev/release.html">Releases Policy</a></li>
<li><a href="http://www.apache.org/dev/release-publishing.html">Publishing Releases</a></li>
Modified: websites/staging/olingo/trunk/content/doc/odata4/sample-setup.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/sample-setup.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/sample-setup.html Wed Jul 8 13:49:34 2015
@@ -86,13 +86,24 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h1 id="sample-project-setup">Sample Project Setup</h1>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="sample-project-setup">Sample Project Setup<a class="headerlink" href="#sample-project-setup" title="Permanent link">¶</a></h1>
<p>Olingo has prepared a very simple sample car service that can work as a starting point for implementing a custom OData service.
This service consists of a very simple EDM with two entity sets that are cars and manufactures and a memory based data provider that is a simple hash map.
Therefore the project implements a very basic single OData processor supporting a minimal readonly scenario.
If build with Maven the build result is a web application (<code>war</code> file) which can be deployed to any JEE compliant web application server (e.g. <a href="http://tomcat.apache.org">Tomcat</a>).</p>
<hr />
-<h3 id="maven-archetype">Maven Archetype</h3>
+<h3 id="maven-archetype">Maven Archetype<a class="headerlink" href="#maven-archetype" title="Permanent link">¶</a></h3>
<p><strong>TBD</strong></p><div align="center">
<p>Copyright © 2013-2015, The Apache Software Foundation<br>
Apache Olingo, Olingo, Apache, the Apache feather, and
Modified: websites/staging/olingo/trunk/content/doc/odata4/tomcat.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/odata4/tomcat.html (original)
+++ websites/staging/olingo/trunk/content/doc/odata4/tomcat.html Wed Jul 8 13:49:34 2015
@@ -86,9 +86,20 @@
</div><!--/.nav-collapse -->
</div><!--/.container-fluid -->
- </div><!-- Main component for a primary marketing message or call to action --><h3 id="run-with-tomcat">Run with Tomcat</h3>
+ </div><!-- Main component for a primary marketing message or call to action --><style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h3 id="run-with-tomcat">Run with Tomcat<a class="headerlink" href="#run-with-tomcat" title="Permanent link">¶</a></h3>
<p>Necessary steps to get your project run with <a href="http://tomcat.apache.org/index.html">Tomcat</a> (tested with version <code>7.0.32</code>).</p>
-<h4 id="required-steps">Required steps</h4>
+<h4 id="required-steps">Required steps<a class="headerlink" href="#required-steps" title="Permanent link">¶</a></h4>
<ul>
<li>Download Tomcat 7.0.x from <a href="http://tomcat.apache.org/download-70.cgi">Tomcat Downloads</a></li>
<li>Install Tomcat as described in <a href="http://tomcat.apache.org/tomcat-7.0-doc/setup.html">Tomcat Documentation</a></li>