User guide (Proxy)

Introduction

The main purpose of ODataJClient's proxy layer is to allow high-level interaction with OData services: basically, users will work with Plain Old Java Objects (POJOs) and ODataJClient will take care of keeping such objects in sync with OData entities.

In order to do so, ODataJClient will transparently maintain an entity context which is also acting as L1 cache; changes in the context can be anytime sent to the OData service via flush() call.

Work model

1. generate properly annotated POJOs by parsing an OData 3.0 service's metadata via the odatajclient-maven-plugin
2. obtain an EntityContainerFactory for such OData 3.0 service
3. get an EntityContainer instance for one of entity containers available in service's metadata
4. start working with top-level entity sets, obtain entities, perform queries, invocations...
5. flush your local modifications back to the OData service

Example

• Working pom.xml for OData sample service at http://services.odata.org/
• Some common usage patterns.