org.asteriskjava.fastagi.reply

Interface AgiReply

All Superinterfaces:

Serializable

All Known Implementing Classes:

AgiReplyImpl

public interface AgiReply
extends Serializable

Reply received in response to an AgiCommand.

The AgiReply contains information about success or failure of the execution of an AgiCommand and - depending on the command sent - additional information returned, for example the value of a variable requested by a GetVariableCommand.

Version:

$Id$

Author:

srt

See Also:

AgiCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	SC_DEAD_CHANNEL Status code (511) indicating Asterisk was unable to execute the command because the channel has been hung up.
static int	SC_INVALID_COMMAND_SYNTAX Status code (520) indicating Asterisk was unable to process the AgiCommand because the syntax used was not correct.
static int	SC_INVALID_OR_UNKNOWN_COMMAND Status code (510) indicating Asterisk was unable to process the AgiCommand because there is no command with the given name available.
static int	SC_SUCCESS Status code (200) indicating Asterisk successfully processed the AgiCommand.
static int	SC_TRYING Status code (100) indicating Asterisk needs to process the AgiCommand and will report a final result code soon.

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String name) Returns an additional attribute contained in the reply.
String	getExtra() Returns the text in parenthesis contained in this reply.
String	getFirstLine() Returns the first line of the raw reply.
List<String>	getLines() Returns a List containing the lines of the raw reply.
String	getResult() Returns the result, that is the part directly following the "result=" string.
int	getResultCode() Returns the return code (the result as int).
char	getResultCodeAsChar() Returns the return code as character.
int	getStatus() Returns the status code.
String	getSynopsis() Returns the synopsis of the command sent if Asterisk expected a different syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).
String	getUsage() Returns the usage of the command sent if Asterisk expected a different syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).

Field Detail

SC_TRYING

static final int SC_TRYING

Status code (100) indicating Asterisk needs to process the AgiCommand and will report a final result code soon.

This code is only used by Asterisk-Java as an intermediate status and is never returned to the user.

See Also:

Constant Field Values

SC_SUCCESS

static final int SC_SUCCESS

Status code (200) indicating Asterisk successfully processed the AgiCommand.

See Also:

Constant Field Values

SC_INVALID_OR_UNKNOWN_COMMAND

static final int SC_INVALID_OR_UNKNOWN_COMMAND

Status code (510) indicating Asterisk was unable to process the AgiCommand because there is no command with the given name available.

See Also:

Constant Field Values

SC_DEAD_CHANNEL

static final int SC_DEAD_CHANNEL

Status code (511) indicating Asterisk was unable to execute the command because the channel has been hung up. Up to Asterisk 1.4 the TCP connection was closed on hangup, since Asterisk 1.6 the connection stays alive and commands that require a channel return a reply with this status code.

Since:

1.0.0

See Also:

Constant Field Values

SC_INVALID_COMMAND_SYNTAX

static final int SC_INVALID_COMMAND_SYNTAX

Status code (520) indicating Asterisk was unable to process the AgiCommand because the syntax used was not correct. This is most likely due to missing required parameters or additional parameters sent that are not understood.

Ensure proper quoting of the parameters when you receive this status code.

See Also:

Constant Field Values

Method Detail

getFirstLine

String getFirstLine()

Returns the first line of the raw reply.

Returns:

the first line of the raw reply.

getLines

List<String> getLines()

Returns a List containing the lines of the raw reply.

Returns:

a List containing the lines of the raw reply.

getResultCode

int getResultCode()

Returns the return code (the result as int).

Returns:

the return code or -1 if the result is not an int.

getResultCodeAsChar

char getResultCodeAsChar()

Returns the return code as character.

Returns:

the return code as character.

getResult

String getResult()

Returns the result, that is the part directly following the "result=" string.

Returns:

the result.

getStatus

int getStatus()

Returns the status code.

Supported status codes are:

• 100 Trying
• 200 Success
• 510 Invalid or unknown command
• 511 Command Not Permitted on a dead channel (since Asterisk 1.6)
• 520 Invalid command syntax

Returns:

the status code.

See Also:

SC_TRYING, SC_SUCCESS, SC_INVALID_OR_UNKNOWN_COMMAND, SC_DEAD_CHANNEL, SC_INVALID_COMMAND_SYNTAX

getAttribute

String getAttribute(String name)

Returns an additional attribute contained in the reply.

For example the reply to the StreamFileCommand contains an additional endpos attribute indicating the frame where the playback was stopped. This can be retrieved by calling getAttribute("endpos") on the corresponding reply.

Parameters:

name - the name of the attribute to retrieve. The name is case insensitive.

Returns:

the value of the attribute or null if it is not set.

getExtra

String getExtra()

Returns the text in parenthesis contained in this reply.

The meaning of this property depends on the command sent. Sometimes it contains a flag like "timeout" or "hangup" or - in case of the GetVariableCommand - the value of the variable.

Returns:

the text in the parenthesis or null if not set.

getSynopsis

String getSynopsis()

Returns the synopsis of the command sent if Asterisk expected a different syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).

Returns:

the synopsis of the command sent, null if there were no syntax errors.

getUsage

String getUsage()

Returns the usage of the command sent if Asterisk expected a different syntax (getStatus() == SC_INVALID_COMMAND_SYNTAX).

Returns:

the usage of the command sent, null if there were no syntax errors.