FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

README.md: Various cleanups by seanbright · Pull Request #634 · asterisk-java/asterisk-java · GitHub

  1. asterisk-java
  2. asterisk-java

Repository navigation

README.md: Various cleanups #634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seanbright merged 1 commit into from
Aug 29, 2024
Conversation 0 Commits 1 Checks 0 Files changed
Merged

README.md: Various cleanups #634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .md  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
167 changes: 99 additions & 68 deletions README.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,31 +1,49 @@
README for Asterisk-Java
========================
# Asterisk-Java

INTRODUCTION
------------
## Introduction

The Asterisk-Java package consists of a set of Java classes that allow you to easily build Java applications that interact with an [Asterisk PBX Server](http://asterisk.org). Asterisk-Java supports both interfaces that Asterisk provides for this scenario: The [FastAGI](https://wiki.asterisk.org/wiki/display/AST/Application_AGI) protocol and the [Manager API](https://wiki.asterisk.org/wiki/display/AST/The+Asterisk+Manager+TCP+IP+API).
The Asterisk-Java package consists of a set of Java classes that allow you to
easily build Java applications that interact with
an [Asterisk PBX Server](https://www.asterisk.org/).
Asterisk-Java supports both interfaces that Asterisk provides for this
scenario:
The [FastAGI](https://docs.asterisk.org/Latest_API/API_Documentation/Dialplan_Applications/AGI/)
protocol and
the [Manager API](https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/The-Asterisk-Manager-TCP-IP-API).

You can find the Java docs for the lastest version here:
[JavaDoc](https://javadoc.io/doc/org.asteriskjava/asterisk-java/2.0.2)
You can find the Java docs for the latest version here:
[Javadoc](https://javadoc.io/doc/org.asteriskjava/asterisk-java/latest)

FastAGI
-------
FastAGI lets you create a service that manages a call in a similar way to what a webserver handles a http request. FastAGI can be (and should be) used to replace dialplan. FastAGI is thousands of times faster than dialplan, easier to debug and lets you do call control in a language that you are familiar with.
### FastAGI

The FastAGI implementation supports all commands currently available from Asterisk.
FastAGI lets you create a service that manages a call in a similar way to how
a webserver handles an HTTP request. FastAGI can be (and should be) used to
replace dialplan. FastAGI is thousands of times faster than dialplan, easier to
debug and lets you do call control in a language that you are familiar with.

Manager API
-----------
The Manager API implementation supports receiving events from the Asterisk server (e.g. call progess, registered peers, channel state) and sending actions to Asterisk (e.g. originate call, agent login/logoff, start/stop voice recording).
If you like, the Manager API allows you start and manipulate calls.
A complete list of the available events and actions is available in the javadocs.
The FastAGI implementation supports all commands currently available from
Asterisk.

Activities
----------
Activities are new to asterisk-java 2.0. The aim of Activities is to provide a high level interface to interactions with Asterisk. Whist Activities use both FastAGI and the Manager API you would normally consider Activities as a replacement for the Manager API.
### Manager API

Activities provide a simple and consistent method of interaction with Asterisk without having to worry about issues such as connection management and without having to understand the intricacies of Asterisk Manager Actions and Events.
The Manager API implementation supports receiving events from the Asterisk
server (e.g. call progress, registered peers, channel state) and sending actions
to Asterisk (e.g. originate call, agent login/logoff, start/stop voice
recording).
If you like, the Manager API allows you to start and manipulate calls. A
complete list of the available events and actions is available in the
[documentation](https://javadoc.io/doc/org.asteriskjava/asterisk-java/latest).

### Activities

Activities are new to asterisk-java 2.0. The aim of Activities is to provide a
high level interface to interactions with Asterisk. Whist Activities use both
FastAGI and the Manager API you would normally consider Activities as a
replacement for the Manager API.

Activities provide a simple and consistent method of interaction with Asterisk
without having to worry about issues such as connection management and without
having to understand the intricacies of Asterisk Manager Actions and Events.

[Getting Started](https://github.com/asterisk-java/asterisk-java/wiki/Getting-Started)

Expand All @@ -35,73 +53,86 @@ Activities provide a simple and consistent method of interaction with Asterisk w

[Examples](https://github.com/asterisk-java/asterisk-java/wiki/Examples)

---

## Getting Asterisk-Java

GETTING ASTERISK-JAVA
---------------------
Asterisk-Java is available
[on GitHub](https://github.com/asterisk-java/asterisk-java/releases).

Asterisk-Java is available from [here](https://github.com/asterisk-java/asterisk-java/releases)
### Maven

Maven Dependency
----------------
Asterisk-Java 3.x (Java 1.8 and Asterisk Version 10 thru 23) (master)

Asterisk-Java 3.x (Java 1.8 and Asterisk Version 10 thru 18) (master)
```xml

<dependency>
<groupId>org.asteriskjava</groupId>
<artifactId>asterisk-java</artifactId>
<version>3.39.0</version>
</dependency>
<dependency>
<groupId>org.asteriskjava</groupId>
<artifactId>asterisk-java</artifactId>
<version>3.39.0</version>
</dependency>
```

Gradle Dependency
----------------
### Gradle

implementation group: 'org.asteriskjava', name: 'asterisk-java', version: '3.39.0'
```text
implementation group: 'org.asteriskjava', name: 'asterisk-java', version: '3.39.0'
```

### Installation from source

INSTALLATION FROM SOURCE
------------------------
```text
git clone https://github.com/asterisk-java/asterisk-java.git
cd asterisk-java
mvn install
```

git clone https://github.com/asterisk-java/asterisk-java.git
cd asterisk-java
mvn install
After the build is complete, the jar will then be built as
`target/asterisk-java.jar` in the `asterisk-java` directory.

After the build is complete, the jar will then be built as target/asterisk-java.jar in the asterisk-java directory.
## Example

EXAMPLE
-------
The file `examples/ExampleCallIn.java` will answer the call and playback the
audio file 'tt-monkeys'.

The file 'examples/ExampleCallIn.java' will answer the call and playback the audio file 'tt-monkeys'.
```java
import org.asteriskjava.fastagi.AgiChannel;
import org.asteriskjava.fastagi.AgiException;
import org.asteriskjava.fastagi.AgiRequest;
import org.asteriskjava.fastagi.BaseAgiScript;

import org.asteriskjava.fastagi.AgiChannel;
import org.asteriskjava.fastagi.AgiException;
import org.asteriskjava.fastagi.AgiRequest;
import org.asteriskjava.fastagi.BaseAgiScript;
/* Example incoming call handler
Answer call, speak message */
public class ExampleCallIn extends BaseAgiScript {
public void service(AgiRequest request, AgiChannel channel) throws AgiException {
answer();
exec("Playback", "tt-monkeys");
hangup();
}
}
/* Example incoming call handler. Answer call, speak message */
public class ExampleCallIn extends BaseAgiScript {
public void service(AgiRequest request, AgiChannel channel) throws AgiException {
answer();
exec("Playback", "tt-monkeys");
hangup();
}
}
```

The file 'examples/fastagi.properties' maps your Asterisk diaplan context to the class you would like to invoke above.
The file `examples/fastagi.properties` maps your Asterisk dialplan context to
the class you would like to invoke above.

callin.agi = ExampleCallIn
```text
callin.agi = ExampleCallIn
```

To compile and run do:
To compile and run:

javac -cp asterisk-java.jar ExampleCallIn.java
java -cp asterisk-java.jar org.asteriskjava.fastagi.DefaultAgiServer
```text
javac -cp asterisk-java.jar ExampleCallIn.java
java -cp asterisk-java.jar org.asteriskjava.fastagi.DefaultAgiServer
```

SYSTEM REQUIREMENTS
-------------------
## System Requirements

Asterisk-Java needs a Java Virtual Machine of at least version 1.8 ([Java SE 8.0](http://www.oracle.com/technetwork/java/javase/downloads/index.html)). If you want to build the jar from source, you will
also need [Maven](http://maven.apache.org/).
Asterisk-Java needs a Java Virtual Machine of at least version
1.8 ([Java SE 8.0](https://docs.oracle.com/javase/8/)).
If you want to build the jar from source, you will also
need [Maven](https://maven.apache.org/).

LEGAL
-----
## Legal

Asterisk-Java is subject to the terms detailed in the license agreement accompanying it.
Asterisk-Java is subject to the terms detailed in the license agreement
accompanying it.
Back | FazBrowse Home | New Git URL