Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
CardSync API
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
This page describes the design of a new CardSync API for the Higgins service.
Contents
Version
This API is being developed as part of the Higgins 1.1 Plan
Used By
- This API will be first used by the Selector 1.1 GTK solution
- Specifically, this API is consumed by the synchronizing card store that is described here: Selector Architecture Harmonization.
Requirements
CardSync must:
- Support a RESTful interface (not SOAP)
- Only use protocols and technologies that are available royalty-free, are well documented
- Support selectors that support N>1 cardstores
- Allow a selector to work completely offline
- Support bi-directional synchronization of individual cards and individual metadata entries about these cards
- Support strong authentication from client to CardSync server
Open Issues
- Why don't we base our design on SyncML?
RESTful API
- CardSync JAX-RS API - RESTful API
- CardSync Authentication - RESTful API Authentication
- CardSync Exceptions - coming soon
Data Transfer Objects
JAX-WS API: Coming soon
Server component diagram
