Asterisk-Java

org.asteriskjava.manager.action
Class SipShowPeerAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.SipShowPeerAction
All Implemented Interfaces:
java.io.Serializable, ManagerAction

public class SipShowPeerAction
extends AbstractManagerAction

Retrieves a the details about a given SIP peer.

The result is returned in the response received in reply to this action.

Use ManagerResponse.getAttribute(String) to retrieve the properties. Consider using SipPeersAction instead.

Available since Asterisk 1.2

Since:
0.2
Version:
$Id: SipShowPeerAction.java 1142 2008-08-20 12:02:59Z srt $
Author:
srt
See Also:
SipPeersAction, SipShowPeerResponse, 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.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
 

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.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.