org.asteriskjava.manager.action

Class StatusAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.StatusAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class StatusAction
extends AbstractManagerAction
implements EventGeneratingAction

The StatusAction requests the state of all active channels. Alternativly (as of Asterisk 1.6) you can also pass a channel name to only retrive the status of one specific channel.

For each active channel a StatusEvent is generated. After the state of all channels has been reported a StatusCompleteEvent is generated.

Version:

$Id$

Author:

srt

See Also:

StatusEvent, StatusCompleteEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusAction() Creates a new StatusAction that retrieves the status of all channels.
StatusAction(String channel) Creates a new StatusAction that retrieves the status of the given channel.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
String	getChannel() Returns the name of the channel.
String	getVariables()
void	setChannel(String channel) Sets the name of the channel.
void	setVariables(List<String> variables) Sets the names of the channel variables to return for each reported channel.
void	setVariables(String variables) Sets the names of the channel variables to return for each reported channel.

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

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

StatusAction

public StatusAction()

Creates a new StatusAction that retrieves the status of all channels.

StatusAction

public StatusAction(String channel)

Creates a new StatusAction that retrieves the status of the given channel.

Available since Asterisk 1.6.

Parameters:

channel - name of the channel.

Since:

1.0.0

Method Detail

getAction

public String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getActionCompleteEventClass

public Class<? extends ResponseEvent> getActionCompleteEventClass()

Description copied from interface: EventGeneratingAction

Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:

getActionCompleteEventClass in interface EventGeneratingAction

Returns:

a Class that is an instance of ResponseEvent.

See Also:

ResponseEvent

getChannel

public String getChannel()

Returns the name of the channel.

Available since Asterisk 1.6.

Returns:

the name of the channel or null for all channels.

Since:

1.0.0

setChannel

public void setChannel(String channel)

Sets the name of the channel.

Available since Asterisk 1.6.

Parameters:

channel - the name of the channel or null for all channels.

Since:

1.0.0

getVariables

public String getVariables()

setVariables

public void setVariables(String variables)

Sets the names of the channel variables to return for each reported channel.

Available since Asterisk 1.6.

Parameters:

variables - comma separated list of variables to return for each reported channel.

Since:

1.0.0

See Also:

StatusEvent.getVariables()

setVariables

public void setVariables(List<String> variables)

Sets the names of the channel variables to return for each reported channel.

Available since Asterisk 1.6.

Parameters:

variables - list of variables to return for each reported channel.

Since:

1.0.0

See Also:

StatusEvent.getVariables()