Giter Club home page Giter Club logo

atomfeed's Introduction

Atomfeed

Build Status

AtomFeed is an implementation of the ATOM protocol in Java. It consists of the following modules

  • atomfeed-server - An ATOM server implementaion that broadcasts events
  • atomfeed-client - An ATOM client implementation that consumes events.
  • atomfeed-spring-server - A spring wrapper on atomfeed-server

Design

AtomFeed is designed to work in a clustered evnironment. Our only point of synchronisation is the database

We allow for two different pagination strategies. Time and Number based pagination.

  • Number based pagination works by creating chunks based on sequence ids.
  • Time based pagination works by creating chunks based on timestamps of created events.

By allowing support to these two pagination mechanisms, AtomFeed works with databases that support auto incrementing Ids and those that don't.

AtomFeed has the ability to support multiple changes to the pagination chunk size after the module has been installed and feeds have been generated. As expected, this change will only affect the feeds created after the change in pagination chunk size has been effected.

Please take a look at the documentation to see how this can be achieved.

Build

To build:

  • mvn compile
  • mvn test

To install:

  • Create a Postgres DB and update atomfeed-server/maven.properties with credentials.
  • mvn install -P IT -DskipTests

To start up:

  • Create the DB tables by running install (see above).
  • Update atomfeed-standalone/src/main/resources/atomfeed.properties with Postgres credentials.
  • cd atomfeed-standalone
  • mvn jetty:run -P IT

To integration test:

  • mvn integration-test -P IT

Usage

Atomfeed server, client and spring-server atrefacts have been been published to maven central.

To use atomfeed-server -

<dependency>
  <groupId>org.ict4h</groupId>
  <artifactId>atomfeed-server</artifactId>
  <version>0.9.1</version>
</dependency>

Please check maven central to get the latest version of the published artefacts.

Documentation

Please see the wiki for documentation on using Atomfeed.

License

atomfeed's People

Contributors

angshu avatar ctford avatar endeepak avatar hemantheverest avatar mihirk avatar mujir avatar mujir-tw avatar nutsiepully avatar petmongrels avatar shruthidipali avatar theghostwhoforks avatar vinkesh avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.