shikoko / activiti-client-sdk

Alfresco Activiti Clients (Early Access)

Introduction

This project contains Java/Android libs to consume easily Activiti BPM Suite Public REST API.

They include a set of APIs that allows developers to quickly build Activiti-enabled Java & Android applications.

Those projects are currently used to build Activiti Android APP available on the Google Play Store

Important Notice

Alfresco Activiti Client is currently in Early Access mode. It evolves as you use them, as you give feedback, and as the developers update and add content. We like to think app development as services that grow and evolve with the involvement of the community.

##Overview

• Client Java: Contains Client API Project for Alfresco Activiti BPM Suite
  • Activiti Java Client set of APIs to interact with Alfresco Activiti (1.4+) Public API
  • Client API Commons utility used by all client APIs
• Client Android: Regroups SDK build on top of Client APIs to solve specific Android problematic (but also Java compatible...)
  • Activiti Android Client Simple wrapper on top of Java Client. It's used as foundation for Activiti Android APP
• Docs: contains informations about Activiti REST API

Status

| Projects | Status | Informations | |----------|:-------------:|------:|------:| |Activiti Java Client | Beta |Full API coverage, simple test | |Client API Commons | Beta | To evolve regarding other evolution | |Activiti Android Client | Beta |Currently replace the previous Activiti SDK layer in Activiti Android APP |

Technical Overview

Client API projects are based on 3 Java/Android librairies

• OkHttp
• Retrofit
• Gson

Retrofit is a type-safe REST client for Java/Android built by Square. The library provides a powerful framework for authenticating and interacting with APIs.

Retrofit send network requests with OkHttp an HTTP & HTTP/2 client for Android and Java applications also built by Square. This library makes downloading JSON or XML data from a web API fairly straightforward.

Once the data is downloaded then it is parsed into a Plain Old Java Object (POJO) which must be defined for each "resource" in the response. Retrofit supports many different parsers for processing network response data (Gson, Jackson, Moshi, Protobuf, Wire, Simple XML)

Advantages

• Easy to consume: API can be consumed synchronuously and/or asynchronuously and/or in a Reactive Approach (RxJava)
• Easy to setup: API declaration is simple and POJO model can be easily generated via Swagger Definition
• Simple architecture & Easy to customize: Each component can be modified and customized to match
• Large community and Open Source compatible

Build

2 maven profiles are available activiti-client-java (activated by default) and activiti-client-all

Build all Librairies

mvn clean install -DskipTests=true

##More informations

Retrofit

• Simple HTTP with Retrofit 2 (Droidcon NYC 2015)
• Consuming APIs with Retrofit
• Retrofit 2.0: The biggest update yet on the best HTTP Client Library for Android
• Retrofit Series

OkHttp

• A Few 'Ok' Libraries (Droidcon MTL 2015)

Gson

• Gson User Guide

RxJava & RxAndroid

• Grokking RxJava
• Retrofit and RxJava, Android multi-threaded REST requests

License

Alfresco Activiti Client Librairies

Copyright © 2016 Alfresco Software, Ltd. and others.

This product distribution is made available under the Apache 2.0 license.