This is an automated email from the ASF dual-hosted git repository. wave pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/olingo-site.git
commit 7cb5547d2ecb2f64bca9d9e27f08a1a52cc20800 Author: Dave Fisher <[email protected]> AuthorDate: Sat Jun 5 09:48:33 2021 -0700 use internal site links. --- content/doc/javascript/index.md | 6 +++--- content/doc/javascript/project-release.md | 4 ++-- content/doc/odata2/release.md | 4 ++-- content/doc/odata2/tutorials/jparedefinemetadata.md | 2 +- content/doc/odata4/index.md | 2 +- content/doc/odata4/overview.md | 2 +- content/doc/odata4/release.md | 4 ++-- .../doc/odata4/tutorials/deep_insert/tutorial_deep_insert.md | 8 ++++---- content/doc/odata4/tutorials/media/tutorial_media.md | 2 +- content/doc/odata4/tutorials/od4_basic_client_read.md | 10 ++++++---- content/doc/odata4/tutorials/prerequisites/prerequisites.md | 2 +- content/doc/odata4/tutorials/sqo_o/tutorial_sqo_o.md | 4 ++-- content/documentation.md | 6 +++--- 13 files changed, 29 insertions(+), 27 deletions(-) diff --git a/content/doc/javascript/index.md b/content/doc/javascript/index.md index b36a94c..c4001e1 100644 --- a/content/doc/javascript/index.md +++ b/content/doc/javascript/index.md @@ -13,7 +13,7 @@ The odatajs library can be included in any html page with the script tag (for ex ``` and its features can be used through the `odatajs` namespace (or `window.odatajs`). The odatajs library can be used together with the datajs library which uses the `window.OData` namespace. -For API documentation please see [ODatajs API documentation](http://olingo.apache.org/doc/javascript/apidoc/index.html) +For API documentation please see [ODatajs API documentation](/doc/javascript/apidoc/index.html) You may also use the documentation and the samples from the [datajs library](http://datajs.codeplex.com/documentation) because the features and API are similar. @@ -34,6 +34,6 @@ In order to make the build infrastructure of ODataJS cross-platform and easy acc * [New] Support running on browser-independent environments (e.g. Node.js) ## Contribute to Olingo OData Client for JavaScript -If you are interested to contribute to this library please have a look into [Project setup](http://olingo.apache.org/doc/javascript/project-setup.html) and [Build instructions](http://olingo.apache.org/doc/javascript/project-build.html) where you find a manual how you can download the source code and build the odatajs library. +If you are interested to contribute to this library please have a look into [Project setup](/doc/javascript/project-setup.html) and [Build instructions](/doc/javascript/project-build.html) where you find a manual how you can download the source code and build the odatajs library. -If you intend so please also join the [Olingo developers group](http://olingo.apache.org/support.html) for discussion. \ No newline at end of file +If you intend so please also join the [Olingo developers group](/support.html) for discussion. \ No newline at end of file diff --git a/content/doc/javascript/project-release.md b/content/doc/javascript/project-release.md index 817d04b..1b3e468 100644 --- a/content/doc/javascript/project-release.md +++ b/content/doc/javascript/project-release.md @@ -208,8 +208,8 @@ Results are shown here: - [Publishing Maven Artifacts][7] - [1]: http://olingo.apache.org/documentation.html - [3]: http://olingo.apache.org/doap_Olingo.rdf + [1]: /documentation.html + [3]: /doap_Olingo.rdf [4]: http://projects.apache.org/indexes/alpha.html#O [5]: http://www.apache.org/dev/release.html [6]: http://www.apache.org/dev/release-publishing.html diff --git a/content/doc/odata2/release.md b/content/doc/odata2/release.md index 2814e80..852feff 100644 --- a/content/doc/odata2/release.md +++ b/content/doc/odata2/release.md @@ -227,9 +227,9 @@ Results are shown here: - [Publishing Maven Artifacts][8] - [1]: http://olingo.apache.org/documentation.html + [1]: /documentation.html [2]: https://issues.apache.org/jira/browse/OLINGO/fixforversion/12324804 - [4]: http://olingo.apache.org/doap_Olingo.rdf + [4]: /doap_Olingo.rdf [5]: http://projects.apache.org/indexes/alpha.html#O [6]: http://www.apache.org/dev/release.html [7]: http://www.apache.org/dev/release-publishing.html diff --git a/content/doc/odata2/tutorials/jparedefinemetadata.md b/content/doc/odata2/tutorials/jparedefinemetadata.md index db9b4d8..9f5ec19 100644 --- a/content/doc/odata2/tutorials/jparedefinemetadata.md +++ b/content/doc/odata2/tutorials/jparedefinemetadata.md @@ -79,4 +79,4 @@ The OData JPA Processor Library applies certain naming rules to derive the names - [1]: http://olingo.apache.org/resources/RedefiningTheMetadataSchema \ No newline at end of file + [1]: /resources/RedefiningTheMetadataSchema \ No newline at end of file diff --git a/content/doc/odata4/index.md b/content/doc/odata4/index.md index 5243745..37b3a8f 100644 --- a/content/doc/odata4/index.md +++ b/content/doc/odata4/index.md @@ -21,7 +21,7 @@ Title: Documentation ### Olingo for Server usage * Basic Tutorial: Create an OData V4 Service with Olingo - * [Prerequisites for all tutorial parts](http://olingo.staging.apache.org/doc/odata4/tutorials/prerequisites/prerequisites.html) + * [Prerequisites for all tutorial parts](/doc/odata4/tutorials/prerequisites/prerequisites.html) * [Tutorial Part 1: Create a read service (with Eclipse)](/doc/odata4/tutorials/read/tutorial_read.html) * [Tutorial Appendix: Use Maven for running the created read service](/doc/odata4/tutorials/read/tutorial_read_mvn.html) * [Tutorial Part 2: Extend the read service (with Eclipse)](/doc/odata4/tutorials/readep/tutorial_readep.html) diff --git a/content/doc/odata4/overview.md b/content/doc/odata4/overview.md index 6659150..451ca88 100644 --- a/content/doc/odata4/overview.md +++ b/content/doc/odata4/overview.md @@ -16,7 +16,7 @@ exposed via the OData standard can be consumed in any environment offering HTTP-based connectivity. In addition, there are client SDKs available for various platforms such as .Net, Java, PHP, JavaScript, etc. -For the Java platform, the [Apache Olingo project](http://olingo.apache.org/) +For the Java platform, the [Apache Olingo project](/) offers a library useful for implementing an OData service. It provides services such as URL parsing, input validation, (de-)serialization of content, request dispatching, etc., according to the OData specification. diff --git a/content/doc/odata4/release.md b/content/doc/odata4/release.md index f34f2ec..e97b2b2 100644 --- a/content/doc/odata4/release.md +++ b/content/doc/odata4/release.md @@ -217,9 +217,9 @@ Results are shown here: - [Publishing Maven Artifacts][8] - [1]: http://olingo.apache.org/documentation.html + [1]: /documentation.html [2]: https://issues.apache.org/jira/browse/OLINGO/fixforversion/12324804 - [4]: http://olingo.apache.org/doap_Olingo.rdf + [4]: /doap_Olingo.rdf [5]: http://projects.apache.org/indexes/alpha.html#O [6]: http://www.apache.org/dev/release.html [7]: http://www.apache.org/dev/release-publishing.html diff --git a/content/doc/odata4/tutorials/deep_insert/tutorial_deep_insert.md b/content/doc/odata4/tutorials/deep_insert/tutorial_deep_insert.md index fcad96e..85af708 100644 --- a/content/doc/odata4/tutorials/deep_insert/tutorial_deep_insert.md +++ b/content/doc/odata4/tutorials/deep_insert/tutorial_deep_insert.md @@ -67,10 +67,10 @@ Afterwards do a Deploy and run: it should be working. At this state you can perf # 2. Implementation -Before we start with the implementation, please have a look at the class `myservice.mynamespace.data.Storage`. In difference to the [navigation tutorial](http://olingo.apache.org/doc/odata4/tutorials/navigation/tutorial_navigation.html) the relations between two entities can not be hard coded because we would like to create and change relations between entities dynamically. In the constructor of the data storage the creation of the sample data is called. After that the method `linkProduc [...] +Before we start with the implementation, please have a look at the class `myservice.mynamespace.data.Storage`. In difference to the [navigation tutorial](/doc/odata4/tutorials/navigation/tutorial_navigation.html) the relations between two entities can not be hard coded because we would like to create and change relations between entities dynamically. In the constructor of the data storage the creation of the sample data is called. After that the method `linkProductsAndCategories`is calle [...] -To express the relation between two entities, Olingo uses the class [Link](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/commons/api/data/Link.html). This class is used for related entites (directly connected via Java references) and bindings (which are actually strings) to other entities. To get the related entites for a particual navigation property, you can ask an entity with the method [`getNavigationLink(String name)`](http://olingo.apache.org/javadoc/odata4/org/apache/o [...] -The same can be done for bindings via the method [`getNavigationBinding(String name)`](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/commons/api/data/Linked.html#getNavigationBinding(java.lang.String)). The values of the Binding can be gotten by the methods [`getBindingLink()`](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/commons/api/data/Link.html#getBindingLink()) and [`getBindingLinks()`](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/commons/api/da [...] +To express the relation between two entities, Olingo uses the class [Link](/javadoc/odata4/org/apache/olingo/commons/api/data/Link.html). This class is used for related entites (directly connected via Java references) and bindings (which are actually strings) to other entities. To get the related entites for a particual navigation property, you can ask an entity with the method [`getNavigationLink(String name)`](/javadoc/odata4/org/apache/olingo/commons/api/data/Linked.html#getNavigation [...] +The same can be done for bindings via the method [`getNavigationBinding(String name)`](/javadoc/odata4/org/apache/olingo/commons/api/data/Linked.html#getNavigationBinding(java.lang.String)). The values of the Binding can be gotten by the methods [`getBindingLink()`](/javadoc/odata4/org/apache/olingo/commons/api/data/Link.html#getBindingLink()) and [`getBindingLinks()`](/javadoc/odata4/org/apache/olingo/commons/api/data/Link.html#getBindingLinks()). The point is that the Entity deserializer uses the same concept to represent the payload as Java objects. Please have a look at the figure below. The deserializer returns an entity with two aggregated Link Objects which belons to the same navigation property "Product". The upper Link object stores the related entites, which have to be created. The lower Link contains the entity-ids to the already existing entities. @@ -125,7 +125,7 @@ The implementation is split in two steps: To handle entity bindings we need two helper methods. -The first method takes an entity-Id and returns the addressed entity. The OData objects provides a helper object to parse entity-ids. (See [UriHelper](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/server/api/uri/UriHelper.html)). After parsing the id we have to check if the addressed entity set fits to the entity set the navigation property points to. After that the data is read by calling `readEntityData`. +The first method takes an entity-Id and returns the addressed entity. The OData objects provides a helper object to parse entity-ids. (See [UriHelper](/javadoc/odata4/org/apache/olingo/server/api/uri/UriHelper.html)). After parsing the id we have to check if the addressed entity set fits to the entity set the navigation property points to. After that the data is read by calling `readEntityData`. ```java private Entity readEntityByBindingLink(final String entityId, final EdmEntitySet edmEntitySet, diff --git a/content/doc/odata4/tutorials/media/tutorial_media.md b/content/doc/odata4/tutorials/media/tutorial_media.md index 9aaca71..6892794 100644 --- a/content/doc/odata4/tutorials/media/tutorial_media.md +++ b/content/doc/odata4/tutorials/media/tutorial_media.md @@ -278,7 +278,7 @@ Enable the regular entity set for CRUD opertations: ### Implement the interface `MediaEntityProcessor` -As you can see the [`MediaEntityProcessor`(Javadoc)](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/server/api/processor/MediaEntityProcessor.html) extends [`EntityProcessor`](http://olingo.apache.org/javadoc/odata4/org/apache/olingo/server/api/processor/EntityProcessor.html), therefore we will implement `MediaEntityProcessor` in class `DemoEntityProcessor`. +As you can see the [`MediaEntityProcessor`(Javadoc)](/javadoc/odata4/org/apache/olingo/server/api/processor/MediaEntityProcessor.html) extends [`EntityProcessor`](/javadoc/odata4/org/apache/olingo/server/api/processor/EntityProcessor.html), therefore we will implement `MediaEntityProcessor` in class `DemoEntityProcessor`. The easiest part is to delete an media entity. The method `deleteMediaEntity` is delegated to the method `deleteEntity(...)`. diff --git a/content/doc/odata4/tutorials/od4_basic_client_read.md b/content/doc/odata4/tutorials/od4_basic_client_read.md index aeb5e62..9962684 100644 --- a/content/doc/odata4/tutorials/od4_basic_client_read.md +++ b/content/doc/odata4/tutorials/od4_basic_client_read.md @@ -9,7 +9,8 @@ Title: Client Scenario This Tutorial shows how to use the Apache Olingo Library for CRUD operations on an existing OData Service. Therefore it contains the Explaining the Client section which explains how to implement the CRUD operations based on sample code. For creating a simple odata service refer the section Basic Tutorial: Create an OData V4 Service with Olingo in Olingo V4 tutorial -###Client Quickstart Guide + +### Client Quickstart Guide With this Quickstart guide the runnable sample client and an sample service is created within a few minutes. Therefore it just requires an installed Java 6 Runtime, Maven 3 and an internet connection. It also requires an odata service. This sample uses the Cars service which can be found under samples/server under olingo [git repository][1]. Build the project and deploy the war on a server. Follow the [Guide - To fetch the tutorial sources][2] to import the sample server project. @@ -33,7 +34,7 @@ It also requires an odata service. This sample uses the Cars service which can b ### Read EDM For an OData Service the Entity Data Model (EDM) defines all metadata information about the provided data of the service. This includes all entities with their type, properties and relations, which entities are provided as entity sets and additional functions and operations provided by the OData Service. The EDM also have to be provided by the OData Service via a unique URI (e.g. http://localhost:8080/cars.svc/$metadata) in the EDMX format. This fact is important because the Apache Olingo library requires the metadata for serialization and de-serialization of the data of an entity (e.g. the validation of the data is done against the EDM provided metadata). Hence the first step in this sample is to read the whole EDM of an OData Service. -###Code sample: Read EDM ($metadata) +### Code sample: Read EDM ($metadata) final Edm edm = getClient().getRetrieveRequestFactory().getMetadataRequest(serviceUrl).execute().getBody(); return edm; @@ -99,6 +100,7 @@ For read of a single ODataEntry the request URI is an Entity for which a key val To create an entity a HTTP POST on the corresponding entity set URI with the whole entity data as POST Body in a supported format (e.g. atom-xml, json) has to be done. With Apache Olingo the required POST Body can be created (serialized) with the methods available on ClientObjectFactory. This method creates a ClientEntity which contains the content (i.e. the required POST Body) which then can be send to the server. If the entry was created successfully an HTTP Status: 201 created will be [...] For simplicity in the code sample below the prepare and execute of the POST and the read of the response is separated (see Part 1: Post and Part 2: Read). + ### Code sample: Create single Entry ### Part 1: POST entry @@ -122,7 +124,7 @@ With the ODataClientFactory it is possible to create a new entity along with its final ClientEntity createdEntity = createResponse.getBody(); This executes the create request and the response will return the ClientEntity that was created. -###PUT entry +### PUT entry final URI uri = odataClient.newURIBuilder(serviceUrl) .appendEntitySetSegment(“Manufacturers”).appendKeySegment(1).build(); @@ -565,4 +567,4 @@ So the code for delete of an entry the DELETE request URI is an Entity for whic [1]: https://gitbox.apache.org/repos/asf?p=olingo-odata4.git - [2]: https://olingo.apache.org/doc/odata4/tutorials/prerequisites/prerequisites.html \ No newline at end of file + [2]: /doc/odata4/tutorials/prerequisites/prerequisites.html \ No newline at end of file diff --git a/content/doc/odata4/tutorials/prerequisites/prerequisites.md b/content/doc/odata4/tutorials/prerequisites/prerequisites.md index 0b77fa9..5be64c3 100644 --- a/content/doc/odata4/tutorials/prerequisites/prerequisites.md +++ b/content/doc/odata4/tutorials/prerequisites/prerequisites.md @@ -25,7 +25,7 @@ To get the source code of the tutorials, please perform the follwing steps: *\> git checkout tags/4.6.0* - Navigate to the tutorial project - You can find each tutorial in a separate subdirectory. e.g. [p1_read](http://olingo.staging.apache.org/doc/odata4/tutorials/read/tutorial_read.html) + You can find each tutorial in a separate subdirectory. e.g. [p1_read](/doc/odata4/tutorials/read/tutorial_read.html) *\> cd samples/tutorials* - Build the Project and Eclipse Project diff --git a/content/doc/odata4/tutorials/sqo_o/tutorial_sqo_o.md b/content/doc/odata4/tutorials/sqo_o/tutorial_sqo_o.md index d55a490..01fd27e 100644 --- a/content/doc/odata4/tutorials/sqo_o/tutorial_sqo_o.md +++ b/content/doc/odata4/tutorials/sqo_o/tutorial_sqo_o.md @@ -30,8 +30,8 @@ __ # 1. Prerequisites -Same prerequisites as in [Tutorial Part 1: Read Entity Collection](http://olingo.apache.org/doc/odata4/tutorials/read/tutorial_read.html) - and [Tutorial Part 2: Read Entity](http://olingo.apache.org/doc/odata4/tutorials/readep/tutorial_readep.html) as well as basic knowledge about the concepts presented in both tutorials. +Same prerequisites as in [Tutorial Part 1: Read Entity Collection](/doc/odata4/tutorials/read/tutorial_read.html) + and [Tutorial Part 2: Read Entity](/doc/odata4/tutorials/readep/tutorial_readep.html) as well as basic knowledge about the concepts presented in both tutorials. Furthermore, Tutorial Part 5.1 should have been read. diff --git a/content/documentation.md b/content/documentation.md index 7fb7ea2..148ba95 100644 --- a/content/documentation.md +++ b/content/documentation.md @@ -3,11 +3,11 @@ Title: Documentation # Documentation Overview for OData Libraries ### Documentation OData 2.0 Java Library -[Documentation OData 2.0 Java Library](http://olingo.apache.org/doc/odata2/index.html) +[Documentation OData 2.0 Java Library](/doc/odata2/index.html) ### Documentation OData 4.0 Java Library -[Documentation OData 4.0 Java Library](http://olingo.apache.org/doc/odata4/index.html) +[Documentation OData 4.0 Java Library](/doc/odata4/index.html) ### Olingo OData Client for JavaScript -[Olingo OData Client for JavaScript](http://olingo.apache.org/doc/javascript/index.html) +[Olingo OData Client for JavaScript](/doc/javascript/index.html)
