org.asteriskjava.manager.event

Class AsyncAgiEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.ResponseEvent

org.asteriskjava.manager.event.AsyncAgiEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AsyncAgiEndEvent, AsyncAgiExecEvent, AsyncAgiStartEvent

public class AsyncAgiEvent
extends ResponseEvent

The following sub events are reported:

• Start: A channel has started the AGI("agi:async") application and is awaiting Async AGI commands.
• Exec: Execution of an AGI command initiated through AgiAction has finished.
• End: A channel has left the AGI("agi:async") application.

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

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

AgiAction, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUB_EVENT_END
static String	SUB_EVENT_EXEC
static String	SUB_EVENT_START

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

actionId

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
AsyncAgiEvent(Object source) Creates a new AsyncAgiEvent.

Method Summary

Modifier and Type	Method and Description
List<String>	decodeEnv() Decodes the AGI environment and returns a list of lines.
List<String>	decodeResult() Decodes the result.
String	getChannel() Returns the name of the channel this event occurred on.
String	getCommandId() Returns the command id of the corresponding AgiAction.
String	getEnv() Returns the raw AGI environment similar to the AGI request for FastAGI.
String	getResult() Returns the raw result of a command execution in response to the corresponding AgiAction.
String	getSubEvent() Returns the sub event type.
String	getUniqueId()
boolean	isEnd() Checks is this an end sub event.
boolean	isExec() Checks is this an exec sub event.
boolean	isStart() Checks is this a start sub event.
protected boolean	isSubEvent(String subEvent)
void	setChannel(String channel) Sets the name of the channel this event occurred on.
void	setCommandId(String commandId) Sets the command id.
void	setEnv(String env) Sets the AGI environment.
void	setResult(String result) Sets the raw result.
void	setSubEvent(String subEvent) Sets the sub event type.
void	setUniqueId(String uniqueId)

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

getActionId, getInternalActionId, setActionId, setInternalActionId

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

See Also:

Constant Field Values

SUB_EVENT_EXEC

public static final String SUB_EVENT_EXEC

See Also:

Constant Field Values

SUB_EVENT_END

public static final String SUB_EVENT_END

See Also:

Constant Field Values

Constructor Detail

AsyncAgiEvent

public AsyncAgiEvent(Object source)

Creates a new AsyncAgiEvent.

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", "Exec" or "End".

Returns:

the sub event type.

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 of the corresponding AgiAction.

This property is only available for the "Exec" sub event.

Returns:

the command id.

See Also:

AgiAction.setCommandId(String)

setCommandId

public void setCommandId(String commandId)

Sets the command id.

Parameters:

commandId - the command id.

getResult

public String getResult()

Returns the raw result of a command execution in response to the corresponding AgiAction.

This property is only available for the "Exec" sub event.

The result is URL encoded and ends with a newline ("\n").

Example:

 200%20result%3d0
 

Returns:

the URL encoded result.

decodeResult

public List<String> decodeResult()

Decodes the result.

Returns:

the decoded result.

setResult

public void setResult(String result)

Sets the raw result.

Parameters:

result - the URL encoded result.

getEnv

public String getEnv()

Returns the raw AGI environment similar to the AGI request for FastAGI.

This property is only available for the "Start" sub event.

The environment is passed in multiple lines (separated by "\n"). Each line is URL encoded and contains a key and a value. The environment ends with two newline characters ("\n\n").

Example:

 ...
 agi_channel%3a%20IAX2%2fpbx0-1
 agi_language%3a%20de
 agi_type%3a%20IAX2
 agi_uniqueid%3a%201201838738.19
 agi_version%3a%201.6.0-beta1
 ...
 

Returns:

the URL encoded AGI environment.

decodeEnv

public List<String> decodeEnv()

Decodes the AGI environment and returns a list of lines.

Returns:

The decoded AGI environment or an empty list if the environment is not available (that is if getEnv() returns null).

See Also:

getEnv()

setEnv

public void setEnv(String env)

Sets the AGI environment.

Parameters:

env - the URL encoded AGI environment.

isStart

public boolean isStart()

Checks is this a start sub event.

Returns:

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

isExec

public boolean isExec()

Checks is this an exec sub event.

Returns:

true if this is an "Exec" 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.

isSubEvent

protected boolean isSubEvent(String subEvent)