Chapter 9. Asterisk Component
Available as of Camel version 2.18
The asterisk: component allows you to work easily with an Asterisk PBX Server http://www.asterisk.org/ using asterisk-java
This component help to interface with Asterisk Manager Interface
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-asterisk</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>9.1. URI format
asterisk:name[?options]
9.2. Options
The Asterisk component has no options.
The Asterisk endpoint is configured using URI syntax:
asterisk:name
with the following path and query parameters:
9.2.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| name | Required Logical name | String |
9.2.2. Query Parameters (8 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| hostname (common) | Required The hostname of the asterisk server | String | |
| password (common) | Required Login password | String | |
| username (common) | Required Login username | String | |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| exceptionHandler (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | |
| exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
| action (producer) | What action to perform such as getting queue status, sip peers or extension state. | AsteriskAction | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
9.3. Spring Boot Auto-Configuration
The component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.asterisk.enabled | Enable asterisk component | true | Boolean |
| camel.component.asterisk.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
9.4. Action
Supported actions are:
- QUEUE_STATUS, Queue Status
- SIP_PEERS, List SIP Peers
- EXTENSION_STATE, Check Extension Status
