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/07/29 17:54:10 UTC

svn commit: r871732 - in /websites/staging/olingo/trunk/content: ./ index.html

Author: buildbot
Date: Mon Jul 29 15:54:09 2013
New Revision: 871732

Log:
Staging update by buildbot for olingo

Modified:
    websites/staging/olingo/trunk/content/   (props changed)
    websites/staging/olingo/trunk/content/index.html

Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Jul 29 15:54:09 2013
@@ -1 +1 @@
-1501711
+1508113

Modified: websites/staging/olingo/trunk/content/index.html
==============================================================================
--- websites/staging/olingo/trunk/content/index.html (original)
+++ websites/staging/olingo/trunk/content/index.html Mon Jul 29 15:54:09 2013
@@ -40,9 +40,74 @@
         </form>
       </div>
       <div class="clear"></div>
-      <div id="content" class="grid_16"><div class="section-content"><h1 id="welcome">Welcome</h1>
-<p>Welcome to the Apache Olingo (Incubating).</p>
-<p>Apache Olingo is a generic Java language implementation of the OData 2.0 specification which will serve as a code base for the upcoming OASIS OData specification.</p></div></div>
+      <div id="content" class="grid_16"><div class="section-content"><h1 id="apache-olingo-incubating-an-odata-library">Apache Olingo (Incubating) - an OData Library</h1>
+<h2 id="introduction">Introduction</h2>
+<p>The <a href="http://odata.org">Open Data Protocol</a> (OData) is a Web protocol for querying and updating data that provides a way to unlock your data and free it from silos that exist in applications today. OData does this by applying and building upon Web technologies such as HTTP, Atom Publishing Protocol (AtomPub) and JSON to provide access to information from a variety of applications, services, and stores.</p>
+<p>The OData Library (Java) is a library which enables developers to implement OData producers and OData consumers and adheres to the following principles:</p>
+<ul>
+<li>Provide an OData 2.0 specification compliant OData Library (Java)</li>
+<li>Enhancements shall be possible in a compatible manner</li>
+<li>Clear separation between Core and API</li>
+<li>Option to build extensions on top</li>
+</ul>
+<h3 id="some-more-background">Some more Background</h3>
+<p>The basic idea behind this project is to have a code base that can continue development to support future OData 4.0 standard. OData 4.0 is expected to be release by OAISI in 2013. For that the code is modular and has following components:</p>
+<ul>
+<li>URI parser: currently a OData 2.0 parser</li>
+<li>Dispatcher: is handling OData 2.0 URI types</li>
+<li>Processor interfaces: to support server side implementations</li>
+<li>EDM model API: OData 2.0 compliant, supports lazy and partial loading of metadata</li>
+<li>Entity provider: for JSON and Atom default formats and extendible to support future formats</li>
+</ul>
+<p>The support of OData 2.0 is just mandatory because of there is already a wide adoption of this standard version. It is also an option to extend the OData 2.0 library to support features of OData 3.0 if required. Contributions to this are welcome.</p>
+<p>For OData 4.0 development could happen in a new branch and we target that OData 2.0 (3.0) and OData 4.0 can exist in parallel. </p>
+<h2 id="development">Development</h2>
+<p>The project build with Maven. To consume sources execute</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">eclipse</span><span class="p">:</span><span class="n">eclipse</span>
+</pre></div>
+
+
+<p>and import generated projects into Eclipse. To consume libraries with Maven add following dependencies to your pom.xml:</p>
+<div class="codehilite"><pre><span class="nv">$olingo.version</span>=1.0.0-SNAPSHOT
+
+<span class="nt">&lt;dependency&gt;</span>
+  <span class="nt">&lt;groupId&gt;</span>org.apache.olingo<span class="nt">&lt;/groupId&gt;</span>
+  <span class="nt">&lt;artifactId&gt;</span>org.apache.olingo.api<span class="nt">&lt;/artifactId&gt;</span>
+  <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span class="n">olingo</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span> 
+  <span class="nt">&lt;scope&gt;</span>compile<span class="nt">&lt;/scope&gt;</span>
+<span class="nt">&lt;/dependency&gt;</span>
+<span class="nt">&lt;dependency&gt;</span>
+  <span class="nt">&lt;groupId&gt;</span>org.apache.olingo<span class="nt">&lt;/groupId&gt;</span>
+  <span class="nt">&lt;artifactId&gt;</span>org.apache.olingo.core<span class="nt">&lt;/artifactId&gt;</span>
+  <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span class="n">olingo</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
+  <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+<span class="nt">&lt;/dependency&gt;</span>
+</pre></div>
+
+
+<p>For advanced JPA processor usage these additional dependencies are required:</p>
+<div class="codehilite"><pre><span class="nt">&lt;dependency&gt;</span>
+  <span class="nt">&lt;groupId&gt;</span>org.apache.olingo<span class="nt">&lt;/groupId&gt;</span>
+  <span class="nt">&lt;artifactId&gt;</span>org.apache.olingo.processor.api<span class="nt">&lt;/artifactId&gt;</span>
+  <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span class="n">olingo</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span> 
+  <span class="nt">&lt;scope&gt;</span>compile<span class="nt">&lt;/scope&gt;</span>
+<span class="nt">&lt;/dependency&gt;</span>
+<span class="nt">&lt;dependency&gt;</span>
+  <span class="nt">&lt;groupId&gt;</span>org.apache.olingo<span class="nt">&lt;/groupId&gt;</span>
+  <span class="nt">&lt;artifactId&gt;</span>org.apache.olingo.api.annotation<span class="nt">&lt;/artifactId&gt;</span>
+  <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span class="n">olingo</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
+  <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+<span class="nt">&lt;/dependency&gt;</span>
+<span class="nt">&lt;dependency&gt;</span>
+  <span class="nt">&lt;groupId&gt;</span>org.apache.olingo<span class="nt">&lt;/groupId&gt;</span>
+  <span class="nt">&lt;artifactId&gt;</span>org.apache.olingo.processor.core<span class="nt">&lt;/artifactId&gt;</span>
+  <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span class="n">olingo</span><span class="o">.</span><span class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
+  <span class="nt">&lt;scope&gt;</span>runtime<span class="nt">&lt;/scope&gt;</span>
+<span class="nt">&lt;/dependency&gt;</span>
+</pre></div>
+
+
+<p>Build artifacts are already available at Maven Central.</p></div></div>
       <div class="clear"></div>
     </div>