Permalink
Browse files

Doc and Javadoc: Using HTTPS scheme for URIs.

  • Loading branch information...
Jean-Philippe Gariépy Jean-Philippe Gariépy
Jean-Philippe Gariépy authored and Jean-Philippe Gariépy committed Sep 25, 2018
1 parent 27055bd commit 153b5abe10f82bbdc7aff873dede8a098bc4dd28
Showing with 57 additions and 57 deletions.
  1. +2 −2 build-instructions.md
  2. +3 −3 build.gradle
  3. +14 −14 readme.md
  4. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/input/RecognitionInfo.java
  5. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/input/TransferStatus.java
  6. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/input/VoiceXmlEvent.java
  7. +2 −2 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/last/Disconnect.java
  8. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/last/Exit.java
  9. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/last/Goto.java
  10. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/last/Return.java
  11. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/last/Submit.java
  12. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/BlindTransfer.java
  13. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/BridgeTransfer.java
  14. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/ConsultationTransfer.java
  15. +3 −3 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/DtmfRecognition.java
  16. +3 −3 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/Message.java
  17. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/ObjectCall.java
  18. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/Recognition.java
  19. +2 −2 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/Recording.java
  20. +6 −6 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/SpeechRecognition.java
  21. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/SubdialogueCall.java
  22. +2 −2 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/Transfer.java
  23. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/audio/AudioItem.java
  24. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/audio/SpeechSynthesis.java
  25. +3 −3 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/grammar/GrammarItem.java
  26. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/grammar/GrammarReference.java
  27. +1 −1 rivr-voicexml/src/main/java/com/nuecho/rivr/voicexml/turn/output/grammar/InlineStringGrammar.java
@@ -1,6 +1,6 @@
## How to build Rivr

The build tool used in Rivr is [Gradle](http://www.gradle.org/). This distribution requires Gradle 4.5.1 (or more recent). To build, simply do
The build tool used in Rivr is [Gradle](https://www.gradle.org/). This distribution requires Gradle 4.5.1 (or more recent). To build, simply do

gradle build

@@ -41,7 +41,7 @@ If you don't have Gradle installed, you can simply use the _Gradle wrapper_ prov

The `gradlew` script will download Gradle in your user directory (i.e. your home) and use it from there. Of course, following invocations of `gradlew` will not trigger the download of Gradle.

NOTE: The gradle wrapper can be configured via the gradle-wrapper.properties file, under the gradle/wrapper folder. The most important property is the distributionUrl, which determines which version of Gradle is downloaded. The pattern for the URL is: `http://services.gradle.org/distributions/gradle-[versionNumber]-[versionStyle].zip`. The `versionStyle` can be either `bin` or `all`; `bin` only contains the runtime, where `all` also contains the documentation and source. By default, we are using `bin`.
NOTE: The gradle wrapper can be configured via the gradle-wrapper.properties file, under the gradle/wrapper folder. The most important property is the distributionUrl, which determines which version of Gradle is downloaded. The pattern for the URL is: `https://services.gradle.org/distributions/gradle-[versionNumber]-[versionStyle].zip`. The `versionStyle` can be either `bin` or `all`; `bin` only contains the runtime, where `all` also contains the documentation and source. By default, we are using `bin`.

## Eclipse integration

@@ -150,14 +150,14 @@ task globalJavadoc(type: Javadoc, dependsOn: prepareJavadoc ) {
linkSource true
windowTitle "Rivr API documentation"
docTitle "Rivr documentation ($project.version)"
bottom 'Copyright &copy; 2013 <a href="http://www.nuecho.com">Nu Echo Inc.</a>.'
bottom 'Copyright &copy; 2018 <a href="https://www.nuecho.com">Nu Echo Inc.</a>.'
use = true
noTimestamp = true
group("Rivr Core Packages", "com.nuecho.rivr.core*")
group("Rivr VoiceXML Packages", "com.nuecho.rivr.voicexml*")
footer "To report errors, inconsistencies and omissions in the Rivr API documentation, please <a href=\"https://github.com/nuecho/rivr/issues/new\" target=\"_blank\">open an issue</a>."
links "http://download.oracle.com/javase/6/docs/api/"
links "http://download.oracle.com/javaee/6/api/"
links "https://download.oracle.com/javase/6/docs/api/"
links "https://download.oracle.com/javaee/6/api/"
links "https://www.slf4j.org/api/"
links "https://json-processing-spec.java.net/nonav/releases/1.0/fcs/javadocs/"
overview = "${projectDir}/doc/javadoc-extra/overview.html"
@@ -1,5 +1,5 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Javadocs](http://www.javadoc.io/badge/com.nuecho/rivr-voicexml.svg)](https://nuecho.github.io/rivr/javadoc/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Javadocs](https://www.javadoc.io/badge/com.nuecho/rivr-voicexml.svg)](https://nuecho.github.io/rivr/javadoc/)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.nuecho/rivr-voicexml/badge.svg?cache=foo)](https://maven-badges.herokuapp.com/maven-central/com.nuecho/rivr-voicexml)

## Overview
@@ -8,12 +8,12 @@ Rivr is a lightweight open-source dialogue engine enabling Java developers to ea

Read our [Getting Started](https://github.com/nuecho/rivr/wiki/Getting-Started) to learn more.

The complete [Javadoc for Rivr](http://nuecho.github.io/rivr/javadoc/) is available online.
The complete [Javadoc for Rivr](https://nuecho.github.io/rivr/javadoc/) is available online.

You can also get started by trying some of the Rivr sample applications:

- [Hello World](https://github.com/nuecho/rivr-cookbook/wiki/Hello-World) - a very simple hello world application
- [Voicemail](http://github.com/nuecho/rivr-voicemail) - a prototype voicemail application
- [Voicemail](https://github.com/nuecho/rivr-voicemail) - a prototype voicemail application

You can continue to learn by example with the [Rivr cookbook](https://github.com/nuecho/rivr-cookbook/wiki).

@@ -27,15 +27,15 @@ Rivr is a Java-centric approach. All Java tools and practice can be applied to I

### What is VoiceXML?

VoiceXML is a W3C standard for interactive voice response, i.e. telephony system interacting with the caller by using speech recognition, DTMF input, recording, speech synthesis, etc.
VoiceXML is a W3C standard for interactive voice response, i.e. telephony system interacting with the caller by using speech recognition, DTMF input, recording, speech synthesis, etc.

VoiceXML is primarily targeted at contact center environments and over-the-phone self-service applications.

[VoiceXML 2.0](http://www.w3.org/TR/voicexml20/) is the specification major version while [VoiceXML 2.1](http://www.w3.org/TR/voicexml21/) only adds a few more features on top of the 2.0 version.
[VoiceXML 2.0](https://www.w3.org/TR/voicexml20/) is the specification major version while [VoiceXML 2.1](https://www.w3.org/TR/voicexml21/) only adds a few more features on top of the 2.0 version.

### What is required to _develop_ a VoiceXML application with Rivr?

You should have a Java development environment. Also, you should already be familiar with the Java language and Java Servlets. While not essential at the beginning, it can be very useful to understand some basic notions of VoiceXML such as prompt queuing, barge-in, properties, etc. Since the Rivr model is based on VoiceXML, it is sometimes necessary to understand the VoiceXML layer underneath.
You should have a Java development environment. Also, you should already be familiar with the Java language and Java Servlets. While not essential at the beginning, it can be very useful to understand some basic notions of VoiceXML such as prompt queuing, barge-in, properties, etc. Since the Rivr model is based on VoiceXML, it is sometimes necessary to understand the VoiceXML layer underneath.

### What is required to _run_ a VoiceXML application with Rivr?

@@ -46,15 +46,15 @@ You should have:
3. A Java web application (i.e. a WAR file) containing:
1. the Rivr jar files (rivr-core.jar, rivr-voicexml.jar)
2. the run-time dependencies
1. slf4j-api.jar, an SLF4J adapter jar for a given logging framework and the required logging framework jar files.
1. slf4j-api.jar, an SLF4J adapter jar for a given logging framework and the required logging framework jar files.
2. commons-fileupload.jar
3. javax.json-api.jar and an implementation (see GlassFish project for the reference implementation)
3. your Rivr application (minimally a Dialogue class)
4. the appropriate configuration in web.xml

### What benefits Rivr offers?

#### Rivr allows Java developers to write callflows as programs.
#### Rivr allows Java developers to write callflows as programs.

The callflow logic is expressed directly in the code. For example, if the call flow required a question to be asked no more than 3 times, this can be implemented with a simple `for` loop. No need to fiddle with the VoiceXML Form Interpretation Algorithm (FIA).

@@ -64,15 +64,15 @@ With Rivr, no dialogue logic resides on the VoiceXML side. Dialogue rules can b

#### Rivr allows unit and coverage testing.

Since Rivr dialogues are regular Java methods, they can be unit tested as any other regular Java code. It is simple to check with JUnit that a dialogue asks the expected questions and reacts correctly for any simulated user input. By combining the unit tests with a code coverage tool, we can rapidly setup an automated call flow coverage verification solution.
Since Rivr dialogues are regular Java methods, they can be unit tested as any other regular Java code. It is simple to check with JUnit that a dialogue asks the expected questions and reacts correctly for any simulated user input. By combining the unit tests with a code coverage tool, we can rapidly setup an automated call flow coverage verification solution.

#### Development of application can start early in the project, even before VoiceXML platform is ready.

Development can start as soon as the dialogue specification is available. Rivr offers a VoiceXML simulation tool, _the dialogue runner_, which allows developers to interactively test the dialogues they are developing. Unit testing can also starts as soon as we have a working dialogue (which can be within minutes).
Development can start as soon as the dialogue specification is available. Rivr offers a VoiceXML simulation tool, _the dialogue runner_, which allows developers to interactively test the dialogues they are developing. Unit testing can also starts as soon as we have a working dialogue (which can be within minutes).

#### Dialogue abstraction, modularity and reuse.

The fact that a dialogue is pure Java code, it's easy to make them abstract. For example, one can define a dialogue as a Java method taking input parameters which will condition the dialogue execution. Those dialogues can be placed into reusable Java packages and shared between applications.
The fact that a dialogue is pure Java code, it's easy to make them abstract. For example, one can define a dialogue as a Java method taking input parameters which will condition the dialogue execution. Those dialogues can be placed into reusable Java packages and shared between applications.

It's even possible to define meta-dialogues, i.e. high-order dialogue composing dialogues together. This level of abstraction is very hard to obtain when using VoiceXML directly but is easily achieved with Rivr.

@@ -82,7 +82,7 @@ Rivr only requires standard Java tools, no special software or other design-time

#### Flexibility

Rivr is designed not to get in your way. It can be integrated with any enterprise framework or other existing framework (like Spring). Many points of control has been defined in Rivr, you are never stuck. You can provide your own implementations for many concepts and you can override many classes to fit your custom context.
Rivr is designed not to get in your way. It can be integrated with any enterprise framework or other existing framework (like Spring). Many points of control has been defined in Rivr, you are never stuck. You can provide your own implementations for many concepts and you can override many classes to fit your custom context.

Rivr even works with VoiceXML proprietary extensions. You can customize generated VoiceXML as required by your VoiceXML platform and exploit vendor-specific features. There are a few ways to do that.

@@ -95,4 +95,4 @@ Also, to report a problem, you can [open an issue on GitHub](https://github.com/
### How to submit a patch?

Send us your pull request on GitHub. It will then be evaluated. Possibly, we will offer a work-around rather than modifying the code base. We will not modify the VoiceXML generation to fit a particular platform unless it can be done in compliance with the VoiceXML 2.1 spec.

@@ -19,7 +19,7 @@
* @see MarkInfo
* @see Mark
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.1.5">http://www.w3.org/TR/voicexml20/#dml5.1.5</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.1.5">https://www.w3.org/TR/voicexml20/#dml5.1.5</a>
*/
public final class RecognitionInfo implements JsonSerializable {

@@ -13,7 +13,7 @@
*
* @author NuEcho Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml2.3.7.2.2">http://www.w3.org/TR/voicexml20/#dml2.3.7.2.2</a>
* href="https://www.w3.org/TR/voicexml20/#dml2.3.7.2.2">https://www.w3.org/TR/voicexml20/#dml2.3.7.2.2</a>
*/
public class TransferStatus implements JsonSerializable {

@@ -16,7 +16,7 @@
*
* @author Nu Echo Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.2.6">http://www.w3.org/TR/voicexml20/#dml5.2.6</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.2.6">https://www.w3.org/TR/voicexml20/#dml5.2.6</a>
*/
public final class VoiceXmlEvent implements JsonSerializable {

@@ -25,9 +25,9 @@
* @see VoiceXmlDialogue
* @see LastTurn
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.3.11">http://www.w3.org/TR/voicexml20/#dml5.3.11</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.3.11">https://www.w3.org/TR/voicexml20/#dml5.3.11</a>
* @see <a
* href="http://www.w3.org/TR/voicexml21/#sec-disconnect">http://www.w3.org/TR/voicexml21/#sec-disconnect</a>
* href="https://www.w3.org/TR/voicexml21/#sec-disconnect">https://www.w3.org/TR/voicexml21/#sec-disconnect</a>
*/
public class Disconnect extends VoiceXmlLastTurn {

@@ -26,7 +26,7 @@
* @see VoiceXmlDialogue
* @see LastTurn
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.3.9">http://www.w3.org/TR/voicexml20/#dml5.3.9</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.3.9">https://www.w3.org/TR/voicexml20/#dml5.3.9</a>
*/
public class Exit extends VoiceXmlLastTurn {

@@ -25,7 +25,7 @@
* @see VoiceXmlDialogue
* @see LastTurn
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.3.7">http://www.w3.org/TR/voicexml20/#dml5.3.7</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.3.7">https://www.w3.org/TR/voicexml20/#dml5.3.7</a>
*/
public class Goto extends VoiceXmlLastTurn {

@@ -29,7 +29,7 @@
* @see LastTurn
* @see SubdialogueCall
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.3.10">http://www.w3.org/TR/voicexml20/#dml5.3.10</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.3.10">https://www.w3.org/TR/voicexml20/#dml5.3.10</a>
*/
public class Return extends VoiceXmlLastTurn {

@@ -28,7 +28,7 @@
* @see LastTurn
* @see SubmitMethod
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml5.3.8">http://www.w3.org/TR/voicexml20/#dml5.3.8</a>
* href="https://www.w3.org/TR/voicexml20/#dml5.3.8">https://www.w3.org/TR/voicexml20/#dml5.3.8</a>
*/
public class Submit extends VoiceXmlLastTurn {

@@ -12,7 +12,7 @@
*
* @author Nu Echo Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml2.3.7.1">http://www.w3.org/TR/voicexml20/#dml2.3.7.1</a>
* href="https://www.w3.org/TR/voicexml20/#dml2.3.7.1">https://www.w3.org/TR/voicexml20/#dml2.3.7.1</a>
*/
public class BlindTransfer extends Transfer {
private static final String BLIND_TRANSFER_TYPE = "blind";
@@ -19,7 +19,7 @@
*
* @author Nu Echo Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml2.3.7.2">http://www.w3.org/TR/voicexml20/#dml2.3.7.2</a>
* href="https://www.w3.org/TR/voicexml20/#dml2.3.7.2">https://www.w3.org/TR/voicexml20/#dml2.3.7.2</a>
*/
public class BridgeTransfer extends SupervisedTransfer {
private static final String BRIDGE_TRANSFER_TYPE = "bridge";
@@ -11,7 +11,7 @@
*
* @author Nu Echo Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml21/#sec-xfer-consultation">http://www.w3.org/TR/voicexml21/#sec-xfer-consultation</a>
* href="https://www.w3.org/TR/voicexml21/#sec-xfer-consultation">https://www.w3.org/TR/voicexml21/#sec-xfer-consultation</a>
*/
public class ConsultationTransfer extends SupervisedTransfer {
private static final String CONSULTATION_TRANSFER_TYPE = "consultation";
@@ -48,7 +48,7 @@ public DtmfRecognition(List<GrammarItem> grammarItems) {
* recognizing DTMF input. <code>null</code> to use the VoiceXML
* platform default.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml6.3.3">http://www.w3.org/TR/voicexml20/#dml6.3.3</a>
* href="https://www.w3.org/TR/voicexml20/#dml6.3.3">https://www.w3.org/TR/voicexml20/#dml6.3.3</a>
*/
public void setInterDigitTimeout(Duration interDigitTimeout) {
mInterDigitTimeout = interDigitTimeout;
@@ -58,7 +58,7 @@ public void setInterDigitTimeout(Duration interDigitTimeout) {
* @param termTimeout The terminating timeout to use when recognizing DTMF
* input. <code>null</code> to use the VoiceXML platform default
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml6.3.3">http://www.w3.org/TR/voicexml20/#dml6.3.3</a>
* href="https://www.w3.org/TR/voicexml20/#dml6.3.3">https://www.w3.org/TR/voicexml20/#dml6.3.3</a>
*/
public void setTermTimeout(Duration termTimeout) {
mTermTimeout = termTimeout;
@@ -69,7 +69,7 @@ public void setTermTimeout(Duration termTimeout) {
* recognition. Must be empty or a single character.
* <code>null</code> to use the VoiceXML platform default
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml6.3.3">http://www.w3.org/TR/voicexml20/#dml6.3.3</a>
* href="https://www.w3.org/TR/voicexml20/#dml6.3.3">https://www.w3.org/TR/voicexml20/#dml6.3.3</a>
*/
public void setTermChar(String termChar) {
if (termChar != null) {
@@ -22,11 +22,11 @@
/**
* A {@link Message} is a {@link VoiceXmlOutputTurn} that plays a sequence of
* {@link AudioItem}.
*
*
* @author Nu Echo Inc.
* @see AudioItem
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml4.1.8">http://www.w3.org/TR/voicexml20/#dml4.1.8</a>
* @see <a href=
* "https://www.w3.org/TR/voicexml20/#dml4.1.8">https://www.w3.org/TR/voicexml20/#dml4.1.8</a>
*/
public class Message extends VoiceXmlOutputTurn {
private static final String MESSAGE_TURN_TYPE = "message";
@@ -26,7 +26,7 @@
*
* @author Nu Echo Inc.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml2.3.5">http://www.w3.org/TR/voicexml20/#dml2.3.5</a>
* href="https://www.w3.org/TR/voicexml20/#dml2.3.5">https://www.w3.org/TR/voicexml20/#dml2.3.5</a>
*/
public class ObjectCall extends VoiceXmlOutputTurn {
public static final String OBJECT_RESULT_VARIABLE_NAME = "object";
@@ -49,7 +49,7 @@
* @param propertyName The name of the property. Not empty.
* @param propertyValue The value of the property. Not null.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml6.3">http://www.w3.org/TR/voicexml20/#dml6.3</a>
* href="https://www.w3.org/TR/voicexml20/#dml6.3">https://www.w3.org/TR/voicexml20/#dml6.3</a>
*/
public void addProperty(String propertyName, String propertyValue) {
Assert.notEmpty(propertyName, "propertyName");
@@ -21,7 +21,7 @@
* @author Nu Echo Inc.
* @see DtmfRecognition
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dml2.3.6">http://www.w3.org/TR/voicexml20/#dml2.3.6</a>
* href="https://www.w3.org/TR/voicexml20/#dml2.3.6">https://www.w3.org/TR/voicexml20/#dml2.3.6</a>
*/
public final class Recording implements JsonSerializable {
private static final String DTMF_TERM_PROPERTY = "dtmfTerm";
@@ -79,7 +79,7 @@ public void setFinalSilence(Duration finalSilence) {
* @param type The media format of the resulting recording.
* <code>null</code> to use the VoiceXML platform default.
* @see <a
* href="http://www.w3.org/TR/voicexml20/#dmlAAudioFormats">http://www.w3.org/TR/voicexml20/#dmlAAudioFormats</a>
* href="https://www.w3.org/TR/voicexml20/#dmlAAudioFormats">https://www.w3.org/TR/voicexml20/#dmlAAudioFormats</a>
*/
public void setType(String type) {
mType = type;
Oops, something went wrong.

0 comments on commit 153b5ab

Please sign in to comment.