org.asteriskjava.manager.event

Class AgiExecEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.AgiExecEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AgiExecEndEvent, AgiExecStartEvent

public class AgiExecEvent
extends ManagerEvent

AgiExecEvents are triggered when an AGI command is executed. For each command two events are triggered: one before excution ("Start") and one after execution ("End").
The following sub events are reported:

• Start: Execution of an AGI command has started.
• End: Execution of an AGI command has finished.

It is implemented in res/res_agi.c.
Available since Asterisk 1.6

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUB_EVENT_END Execution of an AGI command has finished.
static String	SUB_EVENT_START Execution of an AGI command has started.

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AgiExecEvent(Object source) Creates a new AgiExecEvent.

Method Summary

Modifier and Type	Method and Description
String	getAccountCode() Returns the account code set for CDR.
String	getChannel() Returns the name of the channel this event occurred on.
String	getCommand() Returns the AGI command.
String	getCommandId() Returns the command id.
String	getResult() Returns the result as a string.
Integer	getResultCode() Returns the result code.
String	getSubEvent() Returns the sub event type.
String	getUniqueId()
boolean	isEnd() Checks is this an end sub event.
boolean	isStart() Checks is this a start sub event.
void	setAccountCode(String accountCode) Sets the account code used for billing in the CDR.
void	setChannel(String channel) Sets the name of the channel this event occurred on.
void	setCommand(String command) Sets the AGI command.
void	setCommandId(String commandId) Sets the command id.
void	setResult(String result) Sets the string respresentation of the result.
void	setResultCode(Integer resultCode) Sets the result code.
void	setSubEvent(String subEvent) Sets the sub event type.
void	setUniqueId(String uniqueId)

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

SUB_EVENT_START

public static final String SUB_EVENT_START

Execution of an AGI command has started.

See Also:

Constant Field Values

SUB_EVENT_END

public static final String SUB_EVENT_END

Execution of an AGI command has finished.

See Also:

Constant Field Values

Constructor Detail

AgiExecEvent

public AgiExecEvent(Object source)

Creates a new AgiExecEvent.

Parameters:

source -

Method Detail

getUniqueId

public String getUniqueId()

setUniqueId

public void setUniqueId(String uniqueId)

getChannel

public String getChannel()

Returns the name of the channel this event occurred on.

Returns:

the name of the channel this event occurred on.

setChannel

public void setChannel(String channel)

Sets the name of the channel this event occurred on.

Parameters:

channel - the name of the channel this event occurred on.

getSubEvent

public String getSubEvent()

Returns the sub event type. This is either "Start" or "End".

Returns:

the sub event type.

See Also:

SUB_EVENT_START, SUB_EVENT_END

setSubEvent

public void setSubEvent(String subEvent)

Sets the sub event type.

Parameters:

subEvent - the sub event type.

getCommandId

public String getCommandId()

Returns the command id. The command is a random number generated by Asterisk that allows matching the "End" sub event with the corresponding "Start" sub event.

Returns:

the command id.

setCommandId

public void setCommandId(String commandId)

Sets the command id.

Parameters:

commandId - the command id.

getCommand

public String getCommand()

Returns the AGI command.

Returns:

the AGI command.

setCommand

public void setCommand(String command)

Sets the AGI command.

Parameters:

command - the AGI command.

getResultCode

public Integer getResultCode()

Returns the result code.

Returns:

the result code.

setResultCode

public void setResultCode(Integer resultCode)

Sets the result code.

Parameters:

resultCode - the result code.

getResult

public String getResult()

Returns the result as a string.

They correspond to the numeric values returned by getResultCode(). Usually you will want to stick with the numeric values.

Possible values are:

• Failure (corresponds to result code -1)
• Success (corresponds to result code 200)
• KeepAlive (corresponds to result code 210)
• Command not permitted on a dead channel (corresponds to result code 511)
• Usage (corresponds to result code 520)

Returns:

a string respresentation of the result.

setResult

public void setResult(String result)

Sets the string respresentation of the result.

Parameters:

result - a string respresentation of the result.

getAccountCode

public String getAccountCode()

Returns the account code set for CDR.

Returns:

string

setAccountCode

public void setAccountCode(String accountCode)

Sets the account code used for billing in the CDR.
This will be the filename asterisk stores the billing informations in, so it should only use lowercase letters, numbers, hyphen and underscore.

Parameters:

accountCode -

isStart

public boolean isStart()

Checks is this a start sub event.

Returns:

true if this is a "Start" sub event, false otherwise.

isEnd

public boolean isEnd()

Checks is this an end sub event.

Returns:

true if this is an "End" sub event, false otherwise.