net.sf.asterisk.manager.action
Class QueueStatusAction

java.lang.Object
  net.sf.asterisk.manager.action.AbstractManagerAction
      net.sf.asterisk.manager.action.QueueStatusAction

All Implemented Interfaces:

java.io.Serializable, EventGeneratingAction, ManagerAction

public class QueueStatusAction
extends AbstractManagerAction
implements EventGeneratingAction

The QueueStatusAction requests the state of all defined queues their members (agents) and entries (callers).
For each queue a QueueParamsEvent is generated, followed by a QueueMemberEvent for each member of that queue and a QueueEntryEvent for each entry in the queue.
Since Asterisk 1.2 a QueueStatusCompleteEvent is sent to denote the end of the generated dump.
This action is implemented in apps/app_queue.c

Version:

$Id: QueueStatusAction.java,v 1.7 2005/08/27 10:09:16 srt Exp $

Author:

srt

See Also:

QueueParamsEvent, QueueMemberEvent, QueueEntryEvent, QueueStatusCompleteEvent, Serialized Form

Constructor Summary

QueueStatusAction()
Creates a new QueueStatusAction.

Method Summary

java.lang.String	getAction() Returns the name of this action, i.e.
java.lang.Class	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
java.lang.String	getMember() Returns the member filter.
java.lang.String	getQueue() Returns the queue filter.
void	setMember(java.lang.String member) Sets the member filter.
void	setQueue(java.lang.String queue) Sets the queue filter.

Methods inherited from class net.sf.asterisk.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 net.sf.asterisk.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

QueueStatusAction

public QueueStatusAction()

Creates a new QueueStatusAction.

Method Detail

getAction

public java.lang.String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getQueue

public java.lang.String getQueue()

Returns the queue filter.

Returns:

the queue filter.

Since:

0.2

setQueue

public void setQueue(java.lang.String queue)

Sets the queue filter. If set QueueParamEvents are only generated for the given queue name.

Parameters:

queue - the queue filter.

Since:

0.2

getMember

public java.lang.String getMember()

Returns the member filter.

Returns:

the member filter.

Since:

0.2

setMember

public void setMember(java.lang.String member)

Sets the member filter. If set QueueMemberEvents are only generated for the given member name.

Parameters:

member - the member filter.

Since:

0.2

getActionCompleteEventClass

public java.lang.Class 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