moonttmm / fluvial

A library for dealing with workflow.

Fluvial

What's Fluvial for?

This is a framework for dealing with jobs. Assign available performer for specific job automatically. A very typical use case is to make robots process tasks. Job can be in a complex data structure, currently tree data structure, which means each job could have its own sub jobs.

What Fluvial has done for you?

1. Easy way to generate job instance with defined hierarchy.
2. Scheduler to handle each job.
3. Allocator to decide how to assign performer for the job.
4. Storage support to dealing with optimistic/pessimistic lock, transaction, so the database would always be sync between scheduler and user operation.
5. Communication support for tcp / websocket.
6. Implement the goal mechanism, so each job would continue execute until it meets all goals.
7. The way to control different performers during different jobs' states.

What you need to do if using Fluvial?

1. Install Fluvial and setup a spring boot project.
2. Extends Job to have your own specific jobs, and override function in jobs, like execute(), stop(), etc, so job know what to do at each case.
3. Extends JobStorage/PerformerStorage if you have extra info what to save in database.
4. Extends JobStorageAdapter/PerformerStorageAdapter if you what extra way to query your database.
5. Extends Performer to declare and implement what your performer can do.
6. Implement commands so you use to command your performer.
7. Write your own controllers response to specific requests.

You can take a glimpse on our sample.