org.asteriskjava.pbx.agi.config

Class ServiceAgiScriptImpl

java.lang.Object

org.asteriskjava.fastagi.AgiOperations

org.asteriskjava.fastagi.BaseAgiScript

org.asteriskjava.pbx.agi.config.ServiceAgiScriptImpl

All Implemented Interfaces:

AgiChannel, AgiScript, ServiceAgiScript

Direct Known Subclasses:

ActivityAgi

public abstract class ServiceAgiScriptImpl
extends BaseAgiScript
implements ServiceAgiScript

Allows for auto configuration of the AGI script.

Provides a getParameter(..) method which verifies the existence of the parameter.

Requires an implementing agi to provide it's name and parameter list via getScriptName() and getParameters.

Author:

rsutton

Field Summary

Fields

Modifier and Type	Field and Description
protected AgiChannel	channel
protected AgiRequest	request

Constructor Summary

Constructors

Constructor and Description
ServiceAgiScriptImpl()

Method Summary

Modifier and Type	Method and Description
protected String	getParameter(String name)
abstract String[]	getParameters()
abstract String	getScriptName()
protected String	required(String name, String parameter)
abstract void	service() field variables request and channel will be set prior to calling service() AgiRequest request AgiChannel channel
void	service(AgiRequest request, AgiChannel channel) The service method is called by the AsteriskServer whenever this AgiScript should handle an incoming AgiRequest.

Methods inherited from class org.asteriskjava.fastagi.AgiOperations

answer, bridge, confbridge, continueAt, controlStreamFile, controlStreamFile, controlStreamFile, controlStreamFile, databaseDel, databaseDelTree, databaseDelTree, databaseGet, databasePut, dial, exec, exec, getAsteriskVersion, getChannel, getChannelStatus, getData, getData, getData, getFullVariable, getFullVariable, getLastReply, getName, getOption, getOption, getUniqueId, getVariable, gosub, gosub, hangup, meetme, playMusicOnHold, playMusicOnHold, queue, recordFile, recordFile, sayAlpha, sayAlpha, sayDateTime, sayDateTime, sayDateTime, sayDateTime, sayDigits, sayDigits, sayNumber, sayNumber, sayPhonetic, sayPhonetic, sayTime, sayTime, sendCommand, setAutoHangup, setCallerId, setContext, setExtension, setPriority, setVariable, speechActivateGrammar, speechCreate, speechCreate, speechDeactivateGrammar, speechDestroy, speechLoadGrammar, speechRecognize, speechRecognize, speechSet, speechUnloadGrammar, stopMusicOnHold, streamFile, streamFile, streamFile, verbose, waitForDigit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected AgiRequest request

channel

protected AgiChannel channel

Constructor Detail

ServiceAgiScriptImpl

public ServiceAgiScriptImpl()

Method Detail

service

public void service(AgiRequest request,
                    AgiChannel channel)
             throws AgiException

Description copied from interface: AgiScript

The service method is called by the AsteriskServer whenever this AgiScript should handle an incoming AgiRequest.

Specified by:

service in interface AgiScript

Parameters:

request - the initial data received from Asterisk when requesting this script.

channel - a handle to communicate with Asterisk such as sending commands to the channel sending the request.

Throws:

AgiException - any exception thrown by your script will be logged.

service

public abstract void service()
                      throws AgiException

field variables request and channel will be set prior to calling service() AgiRequest request AgiChannel channel

Throws:

AgiException

required

protected String required(String name,
                          String parameter)
                   throws AgiException

Throws:

AgiException

getParameter

protected String getParameter(String name)
                       throws AgiException

Throws:

AgiException

getScriptName

public abstract String getScriptName()

Specified by:

getScriptName in interface ServiceAgiScript

getParameters

public abstract String[] getParameters()

Specified by:

getParameters in interface ServiceAgiScript