org.asteriskjava.pbx

Interface AsteriskSettings

All Known Implementing Classes:

DefaultAsteriskSettings, ExamplesAsteriskSettings

public interface AsteriskSettings

Method Summary

Modifier and Type	Method and Description
String	getAgiExtension() Return an asterisk dialplan extension (within the Management Context) that will be used to inject the agi dialplan entry point used by Activites..
String	getAgiHost() The IP address of FQDN of the asterisk-java application.
String	getAsteriskIP() The IP address of FQND of the Asterisk PBX
String	getAutoAnswer() Return the SIP header to be used to force a handset to auto-answer when dialed.
boolean	getCanDetectHangup() Return true if the telephony tech you are dialing from can reliably detect hangups.
int	getDialTimeout() The time (in seconds) to wait for a dial attempt to be answered before giving up.
boolean	getDisableBridge() Return true if you Asterisk version doesn't support bridging channels.
String	getExtensionPark() Return an asterisk dialplan extension (within the above Management Context) that will be used to park calls.
String	getManagementContext() This is an asterisk dialplan context.
String	getManagerPassword() This password MUST match the password (secret=) in manager.conf
int	getManagerPortNo() The port no.
String	getManagerUsername() This MUST match the section header (e.g.
Integer	getMeetmeBaseAddress() Asterisk-Java uses conference rooms for a variety of purposes.

Method Detail

getManagerPortNo

int getManagerPortNo()

The port no. that the asterisk manager api listens on. This should be 5060 unless you have re-configured the manager api.

Returns:

the port no.

getManagerPassword

String getManagerPassword()

This password MUST match the password (secret=) in manager.conf

Returns:

getManagerUsername

String getManagerUsername()

This MUST match the section header (e.g. '[myconnection]') in manager.conf

Returns:

getAsteriskIP

String getAsteriskIP()

The IP address of FQND of the Asterisk PBX

Returns:

IP address or FQDN.

getMeetmeBaseAddress

Integer getMeetmeBaseAddress()

Asterisk-Java uses conference rooms for a variety of purposes. Just make certain that the base address doesn't overlap any conference rooms you are currently running on your pbx. You should probably allow 200 conference rooms here e.g. (3000-3200) Actions like transfers (and conference calls) use a conference room.

Returns:

meetme base address

getDisableBridge

boolean getDisableBridge()

Return true if you Asterisk version doesn't support bridging channels. All version after 1.8 support bridging so normally you should returm false;

Returns:

false if you asterisk version supports bridging channels.

getManagementContext

String getManagementContext()

This is an asterisk dialplan context. Simply pick a context which doesn't already exist and use AsteriskPBX.createAgiEntryPoint() to inject the necessary dialplan used by asterisk-java

Returns:

an unused asterisk dialplan context. e.g. "asteriskjava"

getExtensionPark

String getExtensionPark()

Return an asterisk dialplan extension (within the above Management Context) that will be used to park calls. Just ensure that its a unique asterisk dialplan extension name.

getDialTimeout

int getDialTimeout()

The time (in seconds) to wait for a dial attempt to be answered before giving up. Recommend a value of 30.

Returns:

getAutoAnswer

String getAutoAnswer()

Return the SIP header to be used to force a handset to auto-answer when dialed. e.g. For Yealink/Snom use return "Call-Info:\; answer-after=0";

Returns:

getAgiExtension

String getAgiExtension()

Return an asterisk dialplan extension (within the Management Context) that will be used to inject the agi dialplan entry point used by Activites.. Just ensure that its a unique asterisk dialplan extension name.

Returns:

"asterisk-java-agi"

getCanDetectHangup

boolean getCanDetectHangup()

Return true if the telephony tech you are dialing from can reliably detect hangups. (for SIP set to true, POTS set false).

Returns:

getAgiHost

String getAgiHost()

The IP address of FQDN of the asterisk-java application. Currenly only used if you are doing 'activities' but its safer to just set this.

Returns: