output/doc/odata4/tutorials/od4_quick_start_sample.html - olingo-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
 <html lang="en">
   <head>
     <meta http-equiv="content-type" content="text/html; charset=utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest.">
     <meta name="author" content="">
     <link rel="icon" href="/favicon.ico">
     <title>Apache Olingo Library</title>
     <!-- Bootstrap core CSS -->
     <link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template -->
     <link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! -->
     <link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template -->
     <link rel="stylesheet" href="/css/main.css">
     <!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]-->
     <style>
 .headerlink {
   visibility: hidden;
 }
 dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink {
   visibility: visible
 }    </style>
     <script src="/js/ie-emulation-modes-warning.js" type="text/javascript">
 </script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->

     <script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript">
 </script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
       <script src="/js/html5shiv.min.js"></script>
       <script src="/js/respond.min.js"></script>
     <![endif]-->
   </head>

   <body>
     <div class="container">
       <!-- Static navbar -->
       <div class="navbar navbar-default" role="navigation">
         <div class="container-fluid">
           <div class="navbar-header">
             <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
               <span class="sr-only">Toggle navigation</span>
              <span class="icon-bar"></span>
              <span class="icon-bar"></span>
              <span class="icon-bar"></span>
             </button>
               <img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" >
               <a class="navbar-brand" href="/">Apache Olingo™</a>
           </div>
           <div class="navbar-collapse collapse">
             <ul class="nav navbar-nav">
               <li class="dropdown">
                   <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
                   <ul class="dropdown-menu">
                       <li><a href="http://www.apache.org/foundation/">ASF Home</a></li>
                       <li><a href="http://projects.apache.org/">Projects</a></li>
                       <li><a href="http://people.apache.org/">People</a></li>
                       <li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a></li>
                       <li><a href="http://www.apache.org/dyn/closer.cgi">Download</a></li>
                       <li><a href="http://www.apache.org/security/">Security</a></li>
                       <li><a href="http://www.apache.org/foundation/sponsorship.html">Support Apache</a></li>
                   </ul>
               </li>

               <li><a href="http://www.apache.org/licenses/">License</a></li>

               <li class="dropdown">
                   <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a>
                   <ul class="dropdown-menu">
                       <li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li>
                       <li><a href="/doc/odata4/download.html">Download OData 4.0 Java</a></li>
                       <li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li>
                   </ul>
               </li>

               <li class="dropdown">
                   <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
                   <ul class="dropdown-menu">
                     <li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li>
                     <li><a href="/doc/odata4/index.html">Documentation OData 4.0 Java</a></li>
                     <li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li>
                   </ul>
               </li>
               <li><a href="/support.html">Support</a></li>
               <li><a href="/contribute.html">Contribute</a></li>

             </ul>

 			  <a class="navbar-right" href="http://www.apache.org/foundation/" target="_blank">
           <img class="navbar-right" height="50px" src="/img/asf_logo_url.svg" alt="Apache Software Foundation">
         </a>

 			</div><!--/.nav-collapse -->
         </div><!--/.container-fluid -->
       </div><!-- Main component for a primary marketing message or call to action -->
     <h1 id="a-quickstart-guide-with-our-odata-40-sample-service">A QuickStart Guide with our OData 4.0 Sample service<a class="headerlink" href="#a-quickstart-guide-with-our-odata-40-sample-service" title="Permalink">&para;</a></h1>
 <hr/>
 <h3 id="overview">Overview<a class="headerlink" href="#overview" title="Permalink">&para;</a></h3>
 <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.</p>
 <p>This sample can be deployed to any JEE compliant web application server (e.g. <a href="http://tomcat.apache.org">Tomcat</a>) and be used to get an overview on how to provide an OData V4 compliant webserver.</p>
 <h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink">&para;</a></h3>
 <p>To run this sample you will need to perfom the following steps:</p>
 <ul>
 <li>Get any JEE compliant web application server (e.g. <a href="http://tomcat.apache.org">Tomcat</a>)</li>
 <li>Get the Sample war file (See the next chapter of this tutorial)</li>
 <li>Deploy the war file to your server</li>
 </ul>
 <p>You can now explore the service.</p>
 <h3 id="get-the-war-file-via-the-maven-repository">Get the war file via the maven repository<a class="headerlink" href="#get-the-war-file-via-the-maven-repository" title="Permalink">&para;</a></h3>
 <p>To get the war file via the maven repository you can simple look <a href="https://repository.apache.org/index.html#nexus-search;gav%7Eorg.apache.olingo%7Eodata-server-sample%7E%7E%7E">here</a> and download the war file.</p>
 <h3 id="build-the-war-file-on-your-own">Build the war file on your own<a class="headerlink" href="#build-the-war-file-on-your-own" title="Permalink">&para;</a></h3>
 <p>You can also build the war file yourself using maven. To do this please set up your project by cloning our git repository. You can find a how to <a href="/doc/odata4/maven.html">here</a></p>
 <p>After you have executed the maven goals "clean install" you can find the war file in the target folder under "olingo-odata4/samples/server/target".</p>
 <p>If you would like to debug the service you can do so by integrating the whole project into eclipse by following this <a href="/doc/odata4/eclipse.html">tutorial</a>.</p>

       <div align="center">
 	<p>Copyright © 2013-2022, The Apache Software Foundation<br>
 				                Apache Olingo, Olingo, Apache, the Apache feather, and
 				the Apache Olingo project logo are trademarks of the Apache Software
 				Foundation.</p>
         <small><a href="/doc/odata2/privacy.html">Privacy</a></small>
       </div>
     </div><!-- /container -->
     <!-- Bootstrap core JavaScript
     ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="/js/jquery.js" type="text/javascript">
     </script>
     <script src="/js/bootstrap.js" type="text/javascript">
     </script>
     <script src="/js/offcanvas.js" type="text/javascript">
     </script>
     <link rel="stylesheet" href="/css/docco.css">
     <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script>
     <script>hljs.highlightAll();</script>
   </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html lang="en">
	<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta name="description" content="Apache Olingo provides libraries which enable developers to implement OData producers and OData consumers. The available OData Java library implements OData version 2.0. In future on goal is to provide an OData 4.0 compliant library once the OData standard is published at OASIS. The focus within the community is currently on the Java technology but it is up to the community to discuss if other environments find interest.">
	<meta name="author" content="">
	<link rel="icon" href="/favicon.ico">
	<title>Apache Olingo Library</title>
	<!-- Bootstrap core CSS -->
	<link href="/css/bootstrap.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template -->
	<link href="/css/navbar.css" rel="stylesheet" type="text/css"><!-- Just for debugging purposes. Don't actually copy these 2 lines! -->
	<link href="/css/offcanvas.css" rel="stylesheet" type="text/css"><!-- Custom styles for this template -->
	<link rel="stylesheet" href="/css/main.css">
	<!--[if lt IE 9]><script src="/js/ie8-responsive-file-warning.js"></script><![endif]-->
	<style>
	.headerlink {
	visibility: hidden;
	}
	dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink {
	visibility: visible
	} </style>
	<script src="/js/ie-emulation-modes-warning.js" type="text/javascript">
	</script><!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->

	<script src="/js/ie10-viewport-bug-workaround.js" type="text/javascript">
	</script><!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
	<!--[if lt IE 9]>
	<script src="/js/html5shiv.min.js"></script>
	<script src="/js/respond.min.js"></script>
	<![endif]-->
	</head>

	<body>
	<div class="container">
	<!-- Static navbar -->
	<div class="navbar navbar-default" role="navigation">
	<div class="container-fluid">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<img class="navbar-brand" src="/img/OlingoOrangeTM.png" style="width:62px;" >
	<a class="navbar-brand" href="/">Apache Olingo™</a>
	</div>
	<div class="navbar-collapse collapse">
	<ul class="nav navbar-nav">
	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="http://www.apache.org/foundation/">ASF Home</a></li>
	<li><a href="http://projects.apache.org/">Projects</a></li>
	<li><a href="http://people.apache.org/">People</a></li>
	<li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a></li>
	<li><a href="http://www.apache.org/dyn/closer.cgi">Download</a></li>
	<li><a href="http://www.apache.org/security/">Security</a></li>
	<li><a href="http://www.apache.org/foundation/sponsorship.html">Support Apache</a></li>
	</ul>
	</li>

	<li><a href="http://www.apache.org/licenses/">License</a></li>

	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/doc/odata2/download.html">Download OData 2.0 Java</a></li>
	<li><a href="/doc/odata4/download.html">Download OData 4.0 Java</a></li>
	<li><a href="/doc/javascript/download.html">Download OData 4.0 JavaScript</a></li>
	</ul>
	</li>

	<li class="dropdown">
	<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
	<ul class="dropdown-menu">
	<li><a href="/doc/odata2/index.html">Documentation OData 2.0 Java</a></li>
	<li><a href="/doc/odata4/index.html">Documentation OData 4.0 Java</a></li>
	<li><a href="/doc/javascript/index.html">Documentation OData 4.0 JavaScript</a></li>
	</ul>
	</li>
	<li><a href="/support.html">Support</a></li>
	<li><a href="/contribute.html">Contribute</a></li>

	</ul>

	<a class="navbar-right" href="http://www.apache.org/foundation/" target="_blank">
	<img class="navbar-right" height="50px" src="/img/asf_logo_url.svg" alt="Apache Software Foundation">
	</a>

	</div><!--/.nav-collapse -->
	</div><!--/.container-fluid -->
	</div><!-- Main component for a primary marketing message or call to action -->
	<h1 id="a-quickstart-guide-with-our-odata-40-sample-service">A QuickStart Guide with our OData 4.0 Sample service<a class="headerlink" href="#a-quickstart-guide-with-our-odata-40-sample-service" title="Permalink">¶</a></h1>
	<hr/>
	<h3 id="overview">Overview<a class="headerlink" href="#overview" title="Permalink">¶</a></h3>
	<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.</p>
	<p>This sample can be deployed to any JEE compliant web application server (e.g. <a href="http://tomcat.apache.org">Tomcat</a>) and be used to get an overview on how to provide an OData V4 compliant webserver.</p>
	<h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink">¶</a></h3>
	<p>To run this sample you will need to perfom the following steps:</p>
	<ul>
	<li>Get any JEE compliant web application server (e.g. <a href="http://tomcat.apache.org">Tomcat</a>)</li>
	<li>Get the Sample war file (See the next chapter of this tutorial)</li>
	<li>Deploy the war file to your server</li>
	</ul>
	<p>You can now explore the service.</p>
	<h3 id="get-the-war-file-via-the-maven-repository">Get the war file via the maven repository<a class="headerlink" href="#get-the-war-file-via-the-maven-repository" title="Permalink">¶</a></h3>
	<p>To get the war file via the maven repository you can simple look <a href="https://repository.apache.org/index.html#nexus-search;gav%7Eorg.apache.olingo%7Eodata-server-sample%7E%7E%7E">here</a> and download the war file.</p>
	<h3 id="build-the-war-file-on-your-own">Build the war file on your own<a class="headerlink" href="#build-the-war-file-on-your-own" title="Permalink">¶</a></h3>
	<p>You can also build the war file yourself using maven. To do this please set up your project by cloning our git repository. You can find a how to <a href="/doc/odata4/maven.html">here</a></p>
	<p>After you have executed the maven goals "clean install" you can find the war file in the target folder under "olingo-odata4/samples/server/target".</p>
	<p>If you would like to debug the service you can do so by integrating the whole project into eclipse by following this <a href="/doc/odata4/eclipse.html">tutorial</a>.</p>

	<div align="center">
	<p>Copyright © 2013-2022, The Apache Software Foundation<br>
	Apache Olingo, Olingo, Apache, the Apache feather, and
	the Apache Olingo project logo are trademarks of the Apache Software
	Foundation.</p>
	<small><a href="/doc/odata2/privacy.html">Privacy</a></small>
	</div>
	</div><!-- /container -->
	<!-- Bootstrap core JavaScript
	================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="/js/jquery.js" type="text/javascript">
	</script>
	<script src="/js/bootstrap.js" type="text/javascript">
	</script>
	<script src="/js/offcanvas.js" type="text/javascript">
	</script>
	<link rel="stylesheet" href="/css/docco.css">
	<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script>
	<script>hljs.highlightAll();</script>
	</body>
	</html>