RxJava extensions for the MobileFirst Platform (MFP) Android API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cafejava
gradle/wrapper
.gitignore
.travis.yml
LICENSE
README.md
build.gradle
checkstyle.xml
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

CafeJava

Build Status

Reactive API for invoking MobileFirst Platform (MFP) procedures from an Android client.

To connect to an MFP instance, simply call:

Observable<WLResponse> connect = CafeJava.connect(context);
connect.subscribe();

With MFP 7.0 came the introduction of Java adapters. We can create a JavaProcedureInvoker that will handle the request for a procedure invocation:

ProcedureInvoker invoker = new JavaProcedureInvoker.Builder("adapterName", "path/{path_param}")
        .pathParam("path_param", value)
        .queryParam("param_name", value)
        .httpMethod(HttpMethod.GET /* default is GET */)
        .build();

We can then pass our ProcedureInvoker instance to CafeJava to trigger an invocation:

Observable<WLResponse> invocation = CafeJava.invokeProcedure(invoker);
invocation.subscribe(); // invocation is performed per subscriber

If we have a JavaScript based adapter, we can use a JSProcedureInvoker object instead.

For any WLResponse containing a valid JSON payload, CafeJava provides a custom operator that can do the conversion for us:

Observable<Person> person = invocation.lift(new JsonConverter<>(Person.class));

If we're expecting back an array of objects, we can alternatively supply a TypeReference<T> to JsonConverter:

TypeReference<List<Person>> reference = new TypeReference<List<Person>>() {};
Observable<List<Person>> people = invocation.lift(new JsonConverter<>(reference));

Installation

In your app's build.gradle file:

compile 'com.ibm.mil:cafejava:2.1.0'

The wlclient.properties file generated with your MFP project needs to be added to your app's assets folder.

CafeJava requires a minimum SDK version of 9 or above.

License

Licensed Materials - Property of IBM
© Copyright IBM Corporation 2015. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.