org.asteriskjava.manager.action

Class CommandAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.CommandAction

All Implemented Interfaces:

Serializable, ManagerAction

public class CommandAction
extends AbstractManagerAction

The CommandAction sends a command line interface (CLI) command to the asterisk server.

For a list of supported commands type help on Asterisk's command line.

In response to a CommandAction you will receive a CommandResponse that contains the CLI output.

Example:

 CommandAction commandAction = new CommandAction("iax2 show peers");
 CommandResponse response = (CommandResponse) c.sendAction(commandAction);
 for (String line : response.getResult())
 {
     System.out.println(line);
 }
 

Where c is an instance of ManagerConnection.

Version:

$Id$

Author:

srt

See Also:

CommandResponse, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	command

Constructor Summary

Constructors

Constructor and Description
CommandAction() Creates a new CommandAction.
CommandAction(String command) Creates a new CommandAction with the given command.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getCommand() Returns the command.
void	setCommand(String command) Sets the CLI command to send to the Asterisk server.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Field Detail

command

protected String command

Constructor Detail

CommandAction

public CommandAction()

Creates a new CommandAction.

CommandAction

public CommandAction(String command)

Creates a new CommandAction with the given command.

Parameters:

command - the CLI command to execute.

Since:

0.2

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "Command".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getCommand

public String getCommand()

Returns the command.

setCommand

public void setCommand(String command)

Sets the CLI command to send to the Asterisk server.