Skip to content

Java client for Ably real-time messaging service

License

Notifications You must be signed in to change notification settings

iliyakostadinov/ably-java

 
 

Repository files navigation

Build Status

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

Please refer to the documentation.

Dependencies

JRE 6 or later is required. All dependencies are included as libraries in libs. Note that the Java Unlimited JCE extensions must be installed in the runtime environment.

Building

Build a jar file for ably-rest with ant:

ant clean && ant

Alternatively, Eclipse project and classpath files are included; import directly into Eclipse (Indigo or later).

Tests

Tests are based on JUnit, and a single JUnit suite (at io.ably.test.RestSuite) covers all tests.

Tests can be run from Eclipse, or from the command-line by:

java -classpath "./out/classes:./libs/*:./libs/test/*" io.ably.test.RestSuite

There is also an ant target to run the unit tests:

ant test

To run tests against a specific host, specify this as a property on the ant commandline:

ant test -Dably.host=custom.host.com

Tests will run against staging by default.

Also, to force the tests to run without TLS, do

ant test -Dably.tls=false

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.

About

Java client for Ably real-time messaging service

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%