Ably

A Java Realtime and REST client library for Ably.io, the realtime messaging service.

Documentation

Visit https://www.ably.io/documentation for a complete API reference and more examples.

Using the Realtime and REST API

The Realtime library for Java is downloadable as a JAR at our Github releases page. You can either download the full JAR which includes all dependencies, or just the library but it will be your responsibility to ensure alld dependencies are met.

Please refer to the documentation.

Dependencies

JRE 7 or later is required. Note that the Java Unlimited JCE extensions must be installed in the runtime environment.

Building

The library consists of a generic java library (in lib/) and a separate Android test project (in android-test/). The base library jar is built with:

gradle lib:jar

There is also a task to build a fat jar containing the dependencies:

gradle fullJar

Tests

Tests are based on JUnit, and there are separate suites for the REST and Realtime libraries, with gradle tasks:

gradle testRestSuite

gradle testRealtimeSuite

To run tests against a specific host, specify in the environment:

export ABLY_ENV=staging; gradle testRealtimeSuite

Tests will run against sandbox by default.

Release notes

This library uses semantic versioning. For each release, the following needs to be done:

• Replace all references of the current version number with the new version number (check pom.xml and build.gradle) and commit the changes
• Run github_changelog_generator to automate the update of the CHANGELOG. Once the CHANGELOG has completed, manually change the Unreleased heading and link with the current version number such as v0.8.1. Also ensure that the Full Changelog link points to the new version tag instead of the HEAD. Commit this change.
• Add a tag and push to origin such as git tag v0.8.1 && git push origin v0.8.1
• Run gradle lib:jar && gradle fullJar to build the JARs for this release
• Visit https://github.com/ably/ably-java/tags and Add release notes for the release, then attach the generated JARs in the folder lib/build/libs

Support, feedback and troubleshooting

Please visit http://support.ably.io/ for access to our knowledgebase and to ask for any assistance.

You can also view the community reported Github issues.

To see what has changed in recent versions of Bundler, see the CHANGELOG.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Ensure you have added suitable tests and the test suite is passing(ant test)
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request

License

Copyright (c) 2015 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to LICENSE for the license terms.