org.asteriskjava.manager.action
Class SipShowPeerAction

java.lang.Object
  org.asteriskjava.manager.action.AbstractManagerAction
      org.asteriskjava.manager.action.SipShowPeerAction

All Implemented Interfaces:

java.io.Serializable, EventGeneratingAction, ManagerAction

public class SipShowPeerAction
extends AbstractManagerAction
implements EventGeneratingAction

Retrieves a the details about a given SIP peer.

For a PeerEntryEvent is sent by Asterisk containing the details of the peer followed by a PeerlistCompleteEvent.

Available since Asterisk 1.2

Since:

0.2

Version:

$Id: SipShowPeerAction.java 880 2007-08-10 01:24:36Z srt $

Author:

srt

See Also:

PeerEntryEvent, PeerlistCompleteEvent, Serialized Form

Constructor Summary

SipShowPeerAction()
Creates a new empty SipShowPeerAction.

SipShowPeerAction(java.lang.String peer)
Creates a new SipShowPeerAction that requests the details about the given SIP peer.

Method Summary

java.lang.String	getAction() Returns the name of the action for example "Hangup".
java.lang.Class	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
java.lang.String	getPeer() Returns the name of the peer to retrieve.
void	setPeer(java.lang.String peer) Sets the name of the peer to retrieve.

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

SipShowPeerAction

public SipShowPeerAction()

Creates a new empty SipShowPeerAction.

SipShowPeerAction

public SipShowPeerAction(java.lang.String peer)

Creates a new SipShowPeerAction that requests the details about the given SIP peer.

This is just the peer name without the channel type prefix. For example if your channel is called "SIP/john", the peer name is just "john".

Parameters:

peer - the name of the SIP peer to retrieve details for.

Since:

0.2

Method Detail

getAction

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

getPeer

public java.lang.String getPeer()

Returns the name of the peer to retrieve.

This parameter is mandatory.

Returns:

the name of the peer to retrieve without the channel type prefix.

setPeer

public void setPeer(java.lang.String peer)

Sets the name of the peer to retrieve.

This is just the peer name without the channel type prefix. For example if your channel is called "SIP/john", the peer name is just "john".

This parameter is mandatory.

Parameters:

peer - the name of the peer to retrieve without the channel type prefix.

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