org.asteriskjava.manager.action

Class SipPeersAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.SipPeersAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class SipPeersAction
extends AbstractManagerAction
implements EventGeneratingAction

Retrieves a list of all defined SIP peers.

For each peer that is found a PeerEntryEvent is sent by Asterisk containing the details. When all peers have been reported a PeerlistCompleteEvent is sent.

Available since Asterisk 1.2 Permission required: write=system

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

PeerEntryEvent, PeerlistCompleteEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SipPeersAction() Creates a new SipPeersAction.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action for example "Hangup".
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.

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

SipPeersAction

public SipPeersAction()

Creates a new SipPeersAction.

Method Detail

getAction

public String getAction()

Description copied from interface: ManagerAction

Returns the name of the action for example "Hangup".

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