Overview (Rivr API documentation)

Rivr Core Packages
Package	Description
com.nuecho.rivr.core
com.nuecho.rivr.core.channel	The dialogue channel and turns, some abstract concepts of Rivr.
com.nuecho.rivr.core.channel.synchronous	Implementation of the dialogue channel running the dialogue in a separated thread.
com.nuecho.rivr.core.channel.synchronous.step	Various steps used by the `SynchronousDialogueChannel`.
com.nuecho.rivr.core.dialogue	The `Dialogue` concept and its related interfaces: `DialogueContext` and `DialogueFactory`.
com.nuecho.rivr.core.servlet	HTTP servlet controller classes.
com.nuecho.rivr.core.servlet.session	Session-related class used by HTTP servlet controller.
com.nuecho.rivr.core.test	Dialogue channel for test controller.
com.nuecho.rivr.core.util	Utility classes.
com.nuecho.rivr.core.util.logging	Logging utilities.

Rivr VoiceXML Packages
Package	Description
com.nuecho.rivr.voicexml
com.nuecho.rivr.voicexml.dialogue	VoiceXML implementation dialogue-related classes.
com.nuecho.rivr.voicexml.rendering.json	JSON renderer classes (for use with Rivr dialogue runner).
com.nuecho.rivr.voicexml.rendering.voicexml	VoiceXML renderer classes.
com.nuecho.rivr.voicexml.rendering.voicexml.errorhandling	Classes generating VoiceXML constructs for handling fatal errors.
com.nuecho.rivr.voicexml.servlet	VoiceXML dialogue servlet and related classes.
com.nuecho.rivr.voicexml.test	VoiceXML dialogue channel for test controller.
com.nuecho.rivr.voicexml.turn	VoiceXML turns.
com.nuecho.rivr.voicexml.turn.first	VoiceXML first turn classes.
com.nuecho.rivr.voicexml.turn.input	VoiceXML input turn classes.
com.nuecho.rivr.voicexml.turn.last	VoiceXML last turn classes.
com.nuecho.rivr.voicexml.turn.output	VoiceXML output turn classes.
com.nuecho.rivr.voicexml.turn.output.audio	Audio items.
com.nuecho.rivr.voicexml.turn.output.fetch	Fetch configuration.
com.nuecho.rivr.voicexml.turn.output.grammar	Grammar Items.
com.nuecho.rivr.voicexml.util	Utility classes.
com.nuecho.rivr.voicexml.util.json	JSON-related classes.

Rivr VoiceXML Packages

Package

Description

VoiceXML implementation dialogue-related classes.

JSON renderer classes (for use with Rivr dialogue runner).

VoiceXML renderer classes.

Classes generating VoiceXML constructs for handling fatal errors.

VoiceXML dialogue servlet and related classes.

VoiceXML dialogue channel for test controller.

VoiceXML turns.

VoiceXML first turn classes.

VoiceXML input turn classes.

VoiceXML last turn classes.

VoiceXML output turn classes.

Audio items.

Fetch configuration.

Grammar Items.

Utility classes.

JSON-related classes.

Rivr is a lightweight open-source dialogue engine enabling Java developers to easily create enterprise-grade VoiceXML applications.

Additionnal ressources:

Rivr at Gihtub
Rivr cookbook - Learn by examples - A collection a various recipes explaining how to achieve various tasks with Rivr
Voice Extensible Markup Language (VoiceXML) W3C Recommendation – Version 2.0, Version 2.1

Rivr is split into two modules:

Core: Base engine allowing HTTP requests to interact with a dialogue.
VoiceXML: VoiceXML driver for generating W3C VoiceXML 2.1-compliant dialogues. This is the place you look when coding VoiceXML dialogues with Rivr.

Rivr 1.0.12 – API documentation