Author: buildbot
Date: Tue May 19 11:26:30 2015
New Revision: 951867
Log:
Staging update by buildbot for olingo
Modified:
websites/staging/olingo/trunk/content/ (props changed)
websites/staging/olingo/trunk/content/doc/odata4/tutorials/write/tutorial_write.html
Propchange: websites/staging/olingo/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue May 19 11:26:30 2015
@@ -1 +1 @@
-1680249
+1680253
Modified:
websites/staging/olingo/trunk/content/doc/odata4/tutorials/write/tutorial_write.html
==============================================================================
---
websites/staging/olingo/trunk/content/doc/odata4/tutorials/write/tutorial_write.html
(original)
+++
websites/staging/olingo/trunk/content/doc/odata4/tutorials/write/tutorial_write.html
Tue May 19 11:26:30 2015
@@ -92,11 +92,31 @@
<p>This tutorial guides you through the steps required to write an OData
Service based on the Olingo OData 4.0 Library for Java (based on current
<em>Olingo 4.0.0-beta-03</em> release which can be get via the <a
href="/doc/odata4/download.html">Download-Page</a>).</p>
<p>In the first two tutorials (<a
href="/doc/odata4/tutorials/read/tutorial_read.html">Read Collection</a> and <a
href="/doc/odata4/tutorials/readep/tutorial_readep.html">Read Entity</a>),
weâve learned how to build a simple OData service that supports read
operations for collection, single entity and property.</p>
<p>In the present tutorial, will cover the write operations, which means
creating an entity, modifying an existing entity and deleting an existing
entity.</p>
-<p>Note:<br />
+<p><strong>Note</strong><br />
The full implementation of the OData service as described in the present
tutorial can be found in the <a
href="/doc/odata4/tutorials/write/sample/DemoService_Tutorial_Write.zip">attached
zip file</a> (<a
href="/doc/odata4/tutorials/write/sample/DemoService_Tutorial_Write.zip.md5">md5</a>,
<a
href="/doc/odata4/tutorials/write/sample/DemoService_Tutorial_Write.zip.sha512">sha512</a>,
<a
href="/doc/odata4/tutorials/write/sample/DemoService_Tutorial_Write.zip.asc">pgp</a>)
that contains an Eclipse project that can be imported into your Eclipse
workspace.</p>
-<p>Disclaimer:
+<p><strong>Disclaimer</strong>
Again, in the present tutorial, will focus only on the relevant
implementation, in order to keep the code small and simple.
The sample code shouldn't be reused for advanced scenarios.</p>
+<p><strong>Table of Contents</strong></p>
+<ol>
+<li>Prerequisites</li>
+<li>Preparation</li>
+<li>Implementation of Read Single Entity<ol>
+<li>Implement the <code>createEntity(...)</code> method</li>
+<li>Implement the <code>updateEntity(...)</code> method</li>
+<li>Implement the <code>deleteEntity(...)</code> method</li>
+</ol>
+</li>
+<li>Run the implemented service<ol>
+<li>Example for <strong>CREATE</strong></li>
+<li>Example for <strong>UPDATE (PUT)</strong></li>
+<li>Example for <strong>UPDATE (PATCH)</strong></li>
+<li>Example for <strong>DELETE</strong></li>
+</ol>
+</li>
+<li>Summary</li>
+<li>Links</li>
+</ol>
<hr />
<h1 id="1-prerequisites">1. Prerequisites</h1>
<p>Same prerequisites as in <a
href="/doc/odata4/tutorials/read/tutorial_read.html">Tutorial Part 1: Read
Entity Collection</a> and <a
href="/doc/odata4/tutorials/readep/tutorial_readep.html">Tutorial Part 2: Read
Entity</a> as well as basic knowledge about the concepts presented in both
tutorials.</p>
@@ -337,15 +357,23 @@ The difference becomes relevant only in
</li>
</ul>
-<h2 id="34-run-the-service">3.4. Run the service</h2>
+<h1 id="4-run-the-service">4. Run the service</h1>
<p>After building and deploying the project, we can invoke our OData
service.</p>
-<p>In order to test the write operations of our OData service, we need a tool
that is able to execute the following required HTTP requests:
<strong>POST</strong>, <strong>PUT</strong>, <strong>PATCH</strong>,
<strong>DELETE</strong><br />
-This is usually done with any REST client tool that can be installed into the
browser of your choice. </p>
-<p>Examples:<br />
- - Firefox: âRESTClient, a debugger for RESTful web servicesâ<br />
- - Chrome: âAdvanced REST clientâ </p>
+<p>In order to test the write operations of our OData service, we need a tool
that is able to execute the following required HTTP requests:</p>
+<ul>
+<li><strong>POST</strong></li>
+<li><strong>PUT</strong></li>
+<li><strong>PATCH</strong></li>
+<li><strong>DELETE</strong> </li>
+</ul>
+<p>This is usually done with any REST client tool that can be installed into
the browser of your choice. </p>
+<p>Some <em>REST</em> clients which are available as browser extension for:</p>
+<ul>
+<li>Firefox: âRESTClient, a debugger for RESTful web servicesâ </li>
+<li>Chrome: âAdvanced REST clientâ </li>
+</ul>
<p>The following sections provide examples for executing the requests:</p>
-<h3 id="341-example-for-create">3.4.1. Example for
<strong>CREATE</strong>:</h3>
+<h3 id="41-example-for-create">4.1. Example for <strong>CREATE</strong>:</h3>
<ul>
<li>URL: <a
href="http://localhost:8080/DemoService/DemoService.svc/Products";>http://localhost:8080/DemoService/DemoService.svc/Products</a>
</li>
<li>HTTP verb: <strong>POST</strong></li>
@@ -360,11 +388,10 @@ This is usually done with any REST clien
</pre></div>
+<p><strong>Note:</strong> The value for the ID property is arbitrary, as it
will be generated by our OData service implementation</p>
</li>
</ul>
-<p>Note:
-The value for the ID property is arbitrary, as it will be generated by our
OData service implementation</p>
-<h3 id="342-example-for-update-put">3.4.2. Example for UPDATE (PUT):</h3>
+<h3 id="42-example-for-update-put">4.2. Example for UPDATE (PUT):</h3>
<ul>
<li>URL: <a
href="http://localhost:8080/DemoService/DemoService.svc/Products(3)">http://localhost:8080/DemoService/DemoService.svc/Products(3)</a>
</li>
<li>HTTP verb: <strong>PUT</strong></li>
@@ -381,7 +408,7 @@ The value for the ID property is arbitra
</li>
</ul>
-<h3 id="343-example-for-update-patch">3.4.3. Example for UPDATE (PATCH):</h3>
+<h3 id="43-example-for-update-patch">4.3. Example for UPDATE (PATCH):</h3>
<ul>
<li>URL: <a
href="http://localhost:8080/DemoService/DemoService.svc/Products(3)">http://localhost:8080/DemoService/DemoService.svc/Products(3)</a>
</li>
<li>HTTP verb: <strong>PATCH</strong> </li>
@@ -396,7 +423,7 @@ The value for the ID property is arbitra
</li>
</ul>
-<h3 id="344-example-for-delete">3.4.4. Example for DELETE:</h3>
+<h3 id="44-example-for-delete">4.4. Example for DELETE:</h3>
<ul>
<li>URL: <a
href="http://localhost:8080/DemoService/DemoService.svc/Products(3)">http://localhost:8080/DemoService/DemoService.svc/Products(3)</a>
</li>
<li>HTTP verb: <strong>DELETE</strong> </li>
@@ -404,16 +431,16 @@ The value for the ID property is arbitra
<li>Request body: <code><empty></code></li>
</ul>
<hr />
-<h1 id="4-summary">4. Summary</h1>
+<h1 id="5-summary">5. Summary</h1>
<p>In this tutorial we have learned how to implement the creation, update and
deletion of an entity.<br />
It has been based on a simple OData model, focusing on simple sample code and
sample data. </p>
<p>In the next tutorial (Part 4: Navigation) we will learn how to implement
navigation, i.e. the linking of resources.</p>
<hr />
-<h1 id="5-links">5. Links</h1>
+<h1 id="6-links">6. Links</h1>
<p>Tutorial OData V4 service part 1: <a
href="/doc/odata4/tutorials/read/tutorial_read.html">Read Entity Collection</a>
| <a
href="/doc/odata4/tutorials/read/sample/DemoService_Tutorial_Read.zip">sample
project zip</a><br />
Tutorial OData V4 service part 2: <a
href="/doc/odata4/tutorials/readep/tutorial_readep.html">Read Entity, Read
Property</a> | <a
href="/doc/odata4/tutorials/readep/sample/DemoService_Tutorial_Readep.zip">sample
project zip</a><br />
Tutorial OData V4 service part 3: <a
href="/doc/odata4/tutorials/write/tutorial_write.html">Write (Create, Update,
Delete Entity) - (this page)</a> | <a
href="/doc/odata4/tutorials/write/sample/DemoService_Tutorial_Write.zip">sample
project zip</a><br />
-Tutorial OData V4 service, part 4: <a href="...">Navigation - (To Be
Announced)</a></p>
+Tutorial OData V4 service part 4: <a href="...">Navigation - (To Be
Announced)</a></p>
<p>OData specification: <a href="http://odata.org/";>http://odata.org/</a><br />
Olingo Javadoc: <a
href="/javadoc/odata4/index.html">http://olingo.apache.org/javadoc/odata4/index.html</a></p><div
align="center">
<p>Copyright © 2013-2015, The Apache Software Foundation<br>
