You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by mi...@apache.org on 2013/09/26 07:59:08 UTC
svn commit: r1526388 -
/incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext
Author: mibo
Date: Thu Sep 26 05:59:08 2013
New Revision: 1526388
URL: http://svn.apache.org/r1526388
Log:
CMS commit to olingo by mibo
Modified:
incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext
Modified: incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext
URL: http://svn.apache.org/viewvc/incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext?rev=1526388&r1=1526387&r2=1526388&view=diff
==============================================================================
--- incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext (original)
+++ incubator/olingo/site/trunk/content/doc/tutorials/basicread.mdtext Thu Sep 26 05:59:08 2013
@@ -20,15 +20,13 @@ Notice: Licensed to the Apache Softwa
---
-### How To Guide for building a Sample OData service with the OData Library (Java)
+## How To Guide for building a Sample OData service with the OData Library (Java)
This How To Guide prerequisites a Project Setup (Git, Maven, etc.) and then shows how to develop an OData Service and make the same available.
It shows in addition how to implement the Model Provider to expose the Entity Data Model (EDM) and the Data Provider to expose the runtime data.
The implementation of the Data Provider (ODataSingleProcessor) illustrates how to expose a single entry, a feed and how to follow associations.
-
-
## Prerequisites
-[Project Setup](../project-setup.html) is successfully done.
+[Project Setup](../project-setup.html) is successfully done and the project is ready to start in your `$ODATA_PROJECT_HOME`.
## Implement your OData Service
### Shortcut
@@ -36,12 +34,10 @@ The implementation of the Data Provider
As a shortcut you can download the [Olingo Tutorial 'Basic-Read' Project](apache-olingo-tutorial-basic_read).
### Deployment Descriptor
-- The sample-web project contains a Deployment Descriptor. Create the web.xml file in the `olingo.odata2.sample.cars.web` project by generating a Deployment Descriptor Stub. Replace the xml in the stub with the following deployment descriptor xml.
+ - The sample-web project contains a Deployment Descriptor. Create the `web.xml` file in the `$ODATA_PROJECT_HOME\olingo.odata2.sample.cars.web` project by generating a Deployment Descriptor Stub. Replace the xml in the stub with the following deployment descriptor xml.
###### Sample Code
-
-
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -68,15 +64,15 @@ As a shortcut you can download the [Olin
</servlet-mapping>
</web-app>
-- Start the command line tool, goto folder *~git_repository~\org.apache.olingo.odata2.sample.cars* and enter
+ - Start the command line tool, go to folder *$ODATA_PROJECT_HOME\org.apache.olingo.odata2.sample.cars* and enter
`mvn clean install` to build your projects
-- The deployment Descriptor contains two `<init-param>` elements which define the OData Application `org.apache.olingo.odata2.core.rest.app.ODataApplication` and your Service Factory `org.apache.olingo.odata2.sample.service.MyServiceFactory`. The OData Application is implemented in the OData Library (Core) and registers a root locator and an exception mapper. The root locator looks up your registered Service Factory to get access to the Entity Data Model Provider and the OData Processor which provides the runtime data. In addition the root locator looks up a parameter `org.apache.olingo.odata2.path.split` (not present in the deployment descriptor above) which indicates how many path segments are reserved for the OData Service via an Integer value (default is 0, which means that the OData Service name corresponds to the defined `url-pattern`).
+ - The deployment Descriptor contains two `<init-param>` elements which define the OData Application `org.apache.olingo.odata2.core.rest.app.ODataApplication` and your Service Factory `org.apache.olingo.odata2.sample.service.MyServiceFactory`. The OData Application is implemented in the OData Library (Core) and registers a root locator and an exception mapper. The root locator looks up your registered Service Factory to get access to the Entity Data Model Provider and the OData Processor which provides the runtime data. In addition the root locator looks up a parameter `org.apache.olingo.odata2.path.split` (not present in the deployment descriptor above) which indicates how many path segments are reserved for the OData Service via an Integer value (default is 0, which means that the OData Service name corresponds to the defined `url-pattern`).
### Implement the OData Service Factory
-- Create a new source folder *src/main/java* in the eclipse project
-- Create a new package `org.apache.olingo.odata2.sample.service` in the source folder
-- Create a class `MyServiceFactory` which extends `org.apache.olingo.odata2.api.ODataServiceFactory` in the new package and contains the following implementation
+ - Create a new source folder *src/main/java* in the eclipse project
+ - Create a new package `org.apache.olingo.odata2.sample.service` in the source folder
+ - Create a class `MyServiceFactory` which extends `org.apache.olingo.odata2.api.ODataServiceFactory` in the new package and contains the following implementation
###### Sample Code