You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by bu...@apache.org on 2014/02/04 13:30:02 UTC
svn commit: r896377 - in /websites/staging/olingo/trunk/content: ./
doc/tutorials/OlingoV2BasicClientSample.html
Author: buildbot
Date: Tue Feb 4 12:30:01 2014
New Revision: 896377
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/tutorials/OlingoV2BasicClientSample.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Feb 4 12:30:01 2014
@@ -1 +1 @@
-1564267
+1564272
Modified: websites/staging/olingo/trunk/content/doc/tutorials/OlingoV2BasicClientSample.html
==============================================================================
--- websites/staging/olingo/trunk/content/doc/tutorials/OlingoV2BasicClientSample.html (original)
+++ websites/staging/olingo/trunk/content/doc/tutorials/OlingoV2BasicClientSample.html Tue Feb 4 12:30:01 2014
@@ -76,26 +76,10 @@
<p>This Tutorial shows how to use the Apache Olingo Library for CRUD operations on an OData Service.
Therefore it contains the main sections:</p>
<ul>
-<li><em>Preparing</em>: Preparation which could be done before running the sample </li>
<li><em>Starting the sample</em>: The actual <em>How To</em> with explanation and sample code</li>
<li><em>Run the sample</em>: A explanation and sample how before build client can be used</li>
<li><em>Copy and Paste</em>: Contains the complete sample code as <em>copy/paste</em> template (to build a Maven Project)</li>
</ul>
-<h3 id="preparing">Preparing</h3>
-<p>The Client Sample use the OData Sample Service provided by Apache Olingo archetype with id: <code>olingo-odata2-sample-cars-annotation-archetype-incubating</code>. To create this sample project Maven must be called as shown below:</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">archetype</span><span class="p">:</span><span class="n">generate</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DinteractiveMode</span><span class="p">=</span><span class="n">false</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">Dversion</span><span class="p">=</span>1<span class="p">.</span>0<span class="p">.</span>0<span class="o">-</span><span class="n">SNAPSHOT</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DgroupId</span><span class="p">=</span><span class="n">com</span><span class="p">.</span><span class="n">sample</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DartifactId</span><span class="p">=</span><span class="n">my</span><span class="o">-</span><span class="n">car</span><span class="o">-</span><span class="n">service</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DarchetypeGroupId</span><span class="p">=</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">olingo</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DarchetypeArtifactId</span><span class="p">=</span><span class="n">olingo</span><span class="o">-</span><span class="n">odata2</span><span class="o">-</span><span class="n">sample</span><span class="o">-</span><span class="n">cars</span><span class="o">-</span><span class="n">annotation</span><span class="o">-</span><span class="n">archetype</span><span class="o">-</span><span class="n">incubating</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">DarchetypeVersion</span><span class="p">=</span>1<span class="p">.</span>1<span class="p">.</span>0
-</pre></div>
-
-
-<p>In the generated sample project you now can simply run Maven with the default goal (run <code>mvn</code> in the shell) which compiles the sources and starts an Jetty web server at <code>http://localhost:8080</code>.</p>
-<p>For more detailed documentation on how to use this archetype take a look into the documentation about Archetypes in Olingo in the <a href="/doc/sample-setup">sample setup</a> section.</p>
<h3 id="starting-the-sample">Starting the Sample</h3>
<p>In this Tutorial an overview is given on how to create, read, update and delete an entity at an existing OData Service with support of the Apache Olingo Library.</p>
<p>Each section explain how to do an operation and shows example code. For simplicity some additional not direct to Apache Olingo releated code is encapsulated in separate methods and is listed in the <em>Additional code</em> section at the end of this tutorial. After finishing this tutorial the listed code samples should compile and run against a local running Olingo Sample Service. Therefore all code samples must be <em>copy / pasted</em> into a single Java class.</p>
@@ -419,7 +403,25 @@ In the code sample the <code>InputStream
-->
<h3 id="run-the-sample">Run the sample</h3>
-<p>To show a sample on how to a sample client can look and be used the above code samples can be copied into an <code>OlingoSampleApp</code> class and for a use case the below <code>main</code> method call this <code>OlingoSampleApp</code> to <em>read</em> the <em>EDM</em>, <em>read</em> a <em>ODataFeed</em> and existing <em>ODataEntry</em>, <em>create</em> a new <em>ODataEntry</em>, <em>update</em> this <em>ODataEntry</em> and at last <em>delete</em> the <em>ODataEntry</em>. Between the interaction with the <code>OlingoSampleApp</code> the results are printend via the <code>print(...)</code> and <code>prettyPrint(...)</code>' methods.</p>
+<p>To show a sample how a client can look like and how it than can be used the code samples can be copied into an <code>OlingoSampleApp</code> class.
+And to show an use case the below <code>main</code> method can be added which calls this <code>OlingoSampleApp</code> to <em>read</em> the <em>EDM</em>, <em>read</em> a <em>ODataFeed</em> and existing <em>ODataEntry</em>, <em>create</em> a new <em>ODataEntry</em>, <em>update</em> this <em>ODataEntry</em> and at last <em>delete</em> the <em>ODataEntry</em>.
+Between the interaction with the <code>OlingoSampleApp</code> the results are printend via the <code>print(...)</code> and <code>prettyPrint(...)</code>' methods.</p>
+<p>That this sample <code>main</code> method work it is necessary that an OData Service with corresponding <em>Data Model (EDM)</em> is available at the <code>service url</code> defined in the <code>main</code> method (which is in the sample <code>http://localhost:8080/MyFormula.svc</code>).
+This can easily achieved if the Apache Olingo archetype (with id: <code>olingo-odata2-sample-cars-annotation-archetype-incubating</code>) is used.
+To use the archtype and create this sample project Maven must be called as shown below:</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">archetype</span><span class="p">:</span><span class="n">generate</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DinteractiveMode</span><span class="p">=</span><span class="n">false</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">Dversion</span><span class="p">=</span>1<span class="p">.</span>0<span class="p">.</span>0<span class="o">-</span><span class="n">SNAPSHOT</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DgroupId</span><span class="p">=</span><span class="n">com</span><span class="p">.</span><span class="n">sample</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DartifactId</span><span class="p">=</span><span class="n">my</span><span class="o">-</span><span class="n">car</span><span class="o">-</span><span class="n">service</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DarchetypeGroupId</span><span class="p">=</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">olingo</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DarchetypeArtifactId</span><span class="p">=</span><span class="n">olingo</span><span class="o">-</span><span class="n">odata2</span><span class="o">-</span><span class="n">sample</span><span class="o">-</span><span class="n">cars</span><span class="o">-</span><span class="n">annotation</span><span class="o">-</span><span class="n">archetype</span><span class="o">-</span><span class="n">incubating</span> <span class="o">\</span>
+ <span class="o">-</span><span class="n">DarchetypeVersion</span><span class="p">=</span>1<span class="p">.</span>1<span class="p">.</span>0
+</pre></div>
+
+
+<p>In the generated sample project you now can simply run Maven with the default goal (run <code>mvn</code> in the shell) which compiles the sources and starts an Jetty web server at <code>http://localhost:8080</code>.</p>
+<p>For more detailed documentation on how to use this archetype take a look into the documentation about Archetypes in Olingo in the <a href="/doc/sample-setup">sample setup</a> section.</p>
<p><strong>Main sample method</strong></p>
<div class="codehilite"><pre> <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">paras</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
<span class="n">OlingoSampleApp</span> <span class="n">app</span> <span class="o">=</span> <span class="k">new</span> <span class="n">OlingoSampleApp</span><span class="o">();</span>
@@ -573,13 +575,13 @@ If the corresponding OData Service based
<span class="nt"><properties></span>
<span class="c"><!-- Project dependency versions --></span>
- <span class="nt"><version</span><span class="err">.olingo</span><span class="nt">></span>1.2.0-SNAPSHOT<span class="nt"></version.olingo></span>
+ <span class="nt"><version.olingo></span>1.2.0-SNAPSHOT<span class="nt"></version.olingo></span>
<span class="c"><!-- Project plugin versions --></span>
- <span class="nt"><version</span><span class="err">.eclipse-plugin</span><span class="nt">></span>2.6<span class="nt"></version.eclipse-plugin></span>
- <span class="nt"><version</span><span class="err">.shade-plugin</span><span class="nt">></span>2.2<span class="nt"></version.shade-plugin></span>
+ <span class="nt"><version.eclipse-plugin></span>2.6<span class="nt"></version.eclipse-plugin></span>
+ <span class="nt"><version.shade-plugin></span>2.2<span class="nt"></version.shade-plugin></span>
<span class="c"><!-- Project build settings --></span>
- <span class="nt"><project</span><span class="err">.build.sourceEncoding</span><span class="nt">></span>UTF-8<span class="nt"></project.build.sourceEncoding></span>
- <span class="nt"><project</span><span class="err">.build.source</span><span class="nt">></span>1.6<span class="nt"></project.build.source></span>
+ <span class="nt"><project.build.sourceEncoding></span>UTF-8<span class="nt"></project.build.sourceEncoding></span>
+ <span class="nt"><project.build.source></span>1.6<span class="nt"></project.build.source></span>
<span class="nt"></properties></span>
<span class="nt"><build></span>
@@ -589,12 +591,12 @@ If the corresponding OData Service based
<span class="nt"><plugin></span>
<span class="nt"><groupId></span>org.apache.maven.plugins<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>maven-eclipse-plugin<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">eclipse</span><span class="o">-</span><span class="n">plugin</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.eclipse-plugin}<span class="nt"></version></span>
<span class="nt"></plugin></span>
<span class="nt"><plugin></span>
<span class="nt"><groupId></span>org.apache.maven.plugins<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>maven-shade-plugin<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">shade</span><span class="o">-</span><span class="n">plugin</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.shade-plugin}<span class="nt"></version></span>
<span class="nt"><executions></span>
<span class="nt"><execution></span>
<span class="nt"><phase></span>package<span class="nt"></phase></span>
@@ -611,12 +613,12 @@ If the corresponding OData Service based
<span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>olingo-odata2-api-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<span class="nt"></version></span>
<span class="nt"></dependency></span>
<span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.olingo<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>olingo-odata2-core-incubating<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="o">.</span><span class="n">olingo</span><span class="cp">}</span><span class="nt"></version></span>
+ <span class="nt"><version></span>${version.olingo}<span class="nt"></version></span>
<span class="nt"><exclusions></span>
<span class="nt"><exclusion></span>
<span class="nt"><groupId></span>javax.ws.rs<span class="nt"></groupId></span>