org.asteriskjava.manager.event
Class PeerEntryEvent

java.lang.Object
  java.util.EventObject
      org.asteriskjava.manager.event.ManagerEvent
          org.asteriskjava.manager.event.ResponseEvent
              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 or SIPShowPeerAction and contains information about a peer.

It is implemented in channels/chan_sip.c

Since:

0.2

Version:

$Id: PeerEntryEvent.java 1047 2008-05-19 13:57:49Z srt $

Author:

srt

See Also:

Serialized Form

Field Summary

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() For SIP peers and users this is "SIP".
java.lang.String	getChanObjectType() For SIP peers this is either "peer" or "user".
java.lang.Boolean	getDynamic()
java.lang.String	getIpAddress() Returns the IP address of the peer.
java.lang.Integer	getIpPort()
java.lang.Boolean	getNatSupport()
java.lang.String	getObjectName()
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	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	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	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	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

Constructor Detail

PeerEntryEvent

public PeerEntryEvent(java.lang.Object source)

Creates a new instance.

Parameters:

source -

Method Detail

getChannelType

public java.lang.String getChannelType()

For SIP peers and users this is "SIP".

Returns:

"SIP"

setChannelType

public void setChannelType(java.lang.String channelType)

getObjectName

public java.lang.String getObjectName()

setObjectName

public void setObjectName(java.lang.String objectName)

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()

setIpPort

public void setIpPort(java.lang.Integer ipPort)

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