Asterisk-Java

org.asteriskjava.manager.event
Class PeerEntryEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.ResponseEvent
              extended by org.asteriskjava.manager.event.PeerEntryEvent
All Implemented Interfaces:
java.io.Serializable

public class PeerEntryEvent
extends ResponseEvent

A PeerEntryEvent is triggered in response to a SipPeersAction, SipShowPeerAction or IaxPeerListAction and contains information about a SIP or IAX peer.

It is implemented in channels/chan_sip.c and channels/chan_iax.c

Since:
0.2
Version:
$Id: PeerEntryEvent.java 1300 2009-04-30 00:28:00Z srt $
Author:
srt
See Also:
Serialized Form

Field Summary
static java.lang.String CHANNEL_TYPE_IAX
           
static java.lang.String CHANNEL_TYPE_SIP
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PeerEntryEvent(java.lang.Object source)
          Creates a new instance.
 
Method Summary
 java.lang.Boolean getAcl()
           
 java.lang.String getChannelType()
          Returns whether this event represents a SIP or an IAX peer.
 java.lang.String getChanObjectType()
          For SIP peers this is either "peer" or "user".
 java.lang.Boolean getDynamic()
           
 java.lang.String getEncryption()
           
 java.lang.String getIpAddress()
          Returns the IP address of the peer.
 java.lang.Integer getIpPort()
          Deprecated. since 1.0.0, use getPort() instead.
 java.lang.Boolean getNatSupport()
           
 java.lang.String getObjectName()
           
 java.lang.String getObjectUserName()
           
 java.lang.Integer getPort()
          Returns the port of the peer.
 java.lang.String getRealtimeDevice()
          Available since Asterisk 1.4.
 java.lang.String getStatus()
          Returns the status of this peer.
 java.lang.Boolean getTextSupport()
          Returns whether the peer supports text messages.
 java.lang.Boolean getTrunk()
          Returns whether to use IAX2 trunking with this peer.
 java.lang.Boolean getVideoSupport()
          Available since Asterisk 1.4.
 void setAcl(java.lang.Boolean acl)
           
 void setChannelType(java.lang.String channelType)
           
 void setChanObjectType(java.lang.String chanObjectType)
           
 void setDynamic(java.lang.Boolean dynamic)
           
 void setEncryption(java.lang.String encryption)
           
 void setIpAddress(java.lang.String ipAddress)
          Sets the IP address of the peer.
 void setIpPort(java.lang.Integer ipPort)
           
 void setNatSupport(java.lang.Boolean natSupport)
           
 void setObjectName(java.lang.String objectName)
           
 void setObjectUserName(java.lang.String objectUserName)
           
 void setPort(java.lang.Integer port)
           
 void setRealtimeDevice(java.lang.String realtimeDevice)
          Available since Asterisk 1.4.
 void setStatus(java.lang.String status)
          Sets the status of this peer.
 void setTextSupport(java.lang.Boolean textSupport)
           
 void setTrunk(java.lang.Boolean trunk)
           
 void setVideoSupport(java.lang.Boolean videoSupport)
          Available since Asterisk 1.4.
 
Methods inherited from class org.asteriskjava.manager.event.ResponseEvent
getActionId, getInternalActionId, setActionId, setInternalActionId
 
Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, setServer, setTimestamp, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CHANNEL_TYPE_SIP

public static final java.lang.String CHANNEL_TYPE_SIP
See Also:
Constant Field Values

CHANNEL_TYPE_IAX

public static final java.lang.String CHANNEL_TYPE_IAX
See Also:
Constant Field Values
Constructor Detail

PeerEntryEvent

public PeerEntryEvent(java.lang.Object source)
Creates a new instance.

Parameters:
source -
Method Detail

getChannelType

public java.lang.String getChannelType()
Returns whether this event represents a SIP or an IAX peer.

Returns:
"SIP" or "IAX".
See Also:
CHANNEL_TYPE_SIP, CHANNEL_TYPE_IAX

setChannelType

public void setChannelType(java.lang.String channelType)

getObjectName

public java.lang.String getObjectName()

setObjectName

public void setObjectName(java.lang.String objectName)

getObjectUserName

public java.lang.String getObjectUserName()
Returns:
Since:
1.0.0

setObjectUserName

public void setObjectUserName(java.lang.String objectUserName)

getChanObjectType

public java.lang.String getChanObjectType()
For SIP peers this is either "peer" or "user".

Returns:
"peer" or "user".

setChanObjectType

public void setChanObjectType(java.lang.String chanObjectType)

getIpAddress

public java.lang.String getIpAddress()
Returns the IP address of the peer.

Returns:
the IP address of the peer or "-none-" if none is available.

setIpAddress

public void setIpAddress(java.lang.String ipAddress)
Sets the IP address of the peer.

Parameters:
ipAddress - the IP address of the peer.

getIpPort

public java.lang.Integer getIpPort()
Deprecated. since 1.0.0, use getPort() instead.

Returns the port of the peer.

Returns:
the port of the peer.

setIpPort

public void setIpPort(java.lang.Integer ipPort)

getPort

public java.lang.Integer getPort()
Returns the port of the peer.

Returns:
the port of the peer.
Since:
1.0.0

setPort

public void setPort(java.lang.Integer port)

getDynamic

public java.lang.Boolean getDynamic()

setDynamic

public void setDynamic(java.lang.Boolean dynamic)

getNatSupport

public java.lang.Boolean getNatSupport()

setNatSupport

public void setNatSupport(java.lang.Boolean natSupport)

getVideoSupport

public java.lang.Boolean getVideoSupport()
Available since Asterisk 1.4.

Since:
0.3

setVideoSupport

public void setVideoSupport(java.lang.Boolean videoSupport)
Available since Asterisk 1.4.

Since:
0.3

getTextSupport

public java.lang.Boolean getTextSupport()
Returns whether the peer supports text messages.

Available since Asterisk 1.6.

Returns:
true if the peer supports text messages, false otherwise or null if the property is not set (i.e. for Asterisk prior to 1.6).
Since:
1.0.0

setTextSupport

public void setTextSupport(java.lang.Boolean textSupport)

getAcl

public java.lang.Boolean getAcl()

setAcl

public void setAcl(java.lang.Boolean acl)

getStatus

public java.lang.String getStatus()
Returns the status of this peer.

For SIP peers this is one of:

"UNREACHABLE"
"LAGGED (%d ms)"
"OK (%d ms)"
"UNKNOWN"
"Unmonitored"

Returns:
the status of this peer.

setStatus

public void setStatus(java.lang.String status)
Sets the status of this peer.

Parameters:
status - the status of this peer.

getRealtimeDevice

public java.lang.String getRealtimeDevice()
Available since Asterisk 1.4.

Since:
0.3

setRealtimeDevice

public void setRealtimeDevice(java.lang.String realtimeDevice)
Available since Asterisk 1.4.

Since:
0.3

getTrunk

public java.lang.Boolean getTrunk()
Returns whether to use IAX2 trunking with this peer.

Available since Asterisk 1.6.

Returns:
true if trunking is used, false if not or null if not set.
Since:
1.0.0

setTrunk

public void setTrunk(java.lang.Boolean trunk)

getEncryption

public java.lang.String getEncryption()

setEncryption

public void setEncryption(java.lang.String encryption)

Asterisk-Java

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