User guide

This page shows some basic concepts and examples to work with of ODataJClient, Open Source (Apache License 2.0) library that enables Java applications to deal with OData 3.0 services.

Preconditions

• Apache Maven >= 3.0.3
• JDK >= 1.6.0-23

Obtaining ODataJClient

1. Obtain source code by either
2. downloading source ZIP archive
3. or git clone git@github.com:MSOpenTech/ODataJClient.git
4. Build

$ cd ODataJClient
$ mvn clean install

At this point ODataJClient is installed into your local Maven repository and must be added as dependency to your own Maven project as

<dependency>
  <groupId>com.msopentech.odatajclient</groupId>
  <artifactId>odatajclient-engine</artifactId>
  <version><!-- version number installed above --></version>
</dependency>

Options available

ODataJClient allows interacting with OData 3.0 services in Java at different levels:

1. Engine
   Low-level communication layer taking care of actual REST communication and OData entity (de)serialization, exposing methods to hook into the OData protocol for manipulating entities and invoking actions and functions.
2. Proxy
   Inspired by JPA, This layer will convert any local change to POJOs and any local invocation of annotated interfaces' methods into actual calls to the Engine layer.