PeerEntryEvent (Asterisk-Java 3.29.0 API)

java.lang.Object
- java.util.EventObject
- - org.asteriskjava.manager.event.ManagerEvent
  - - org.asteriskjava.manager.event.ResponseEvent
    - - org.asteriskjava.manager.event.PeerEntryEvent

All Implemented Interfaces:

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$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String CHANNEL_TYPE_IAX

static String CHANNEL_TYPE_SIP
- Fields inherited from class org.asteriskjava.manager.event.ResponseEvent
  actionId
- Fields inherited from class org.asteriskjava.manager.event.ManagerEvent
  callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority
- Fields inherited from class java.util.EventObject
  source

Fields
Modifier and Type	Field and Description
`static String`	`CHANNEL_TYPE_IAX`
`static String`	`CHANNEL_TYPE_SIP`

Constructor Summary

Constructors
Constructor and Description

PeerEntryEvent(Object source)
Creates a new instance.

Constructors
Constructor and Description
`PeerEntryEvent(Object source)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAccountcode()`
`Boolean`	`getAcl()`
`String`	`getAutoComedia()`
`String`	`getAutoForcerport()`
`String`	`getChannelType()` Returns whether this event represents a SIP or an IAX peer.
`String`	`getChanObjectType()` For SIP peers this is either "peer" or "user".
`String`	`getComedia()`
`String`	`getDescription()`
`Boolean`	`getDynamic()`
`String`	`getEncryption()`
`Boolean`	`getForceRport()` Returns whether the nat option is set to `force_rport`. Available since Asterisk 1.8
`String`	`getIpAddress()` Returns the IP address of the peer.
`Integer`	`getIpPort()` Deprecated. since 1.0.0, use `getPort()` instead.
`Boolean`	`getNatSupport()`
`String`	`getObjectName()`
`String`	`getObjectUserName()`
`Integer`	`getPort()` Returns the port of the peer.
`String`	`getRealtimeDevice()` Available since Asterisk 1.4.
`String`	`getStatus()` Returns the status of this peer.
`Boolean`	`getTextSupport()` Returns whether the peer supports text messages.
`Boolean`	`getTrunk()` Returns whether to use IAX2 trunking with this peer.
`Boolean`	`getVideoSupport()` Available since Asterisk 1.4.
`void`	`setAccountcode(String accountcode)`
`void`	`setAcl(Boolean acl)`
`void`	`setAutoComedia(String autoComedia)`
`void`	`setAutoForcerport(String autoForcerport)`
`void`	`setChannelType(String channelType)`
`void`	`setChanObjectType(String chanObjectType)`
`void`	`setComedia(String comedia)`
`void`	`setDescription(String description)`
`void`	`setDynamic(Boolean dynamic)`
`void`	`setEncryption(String encryption)`
`void`	`setForceRport(Boolean forceRport)`
`void`	`setIpAddress(String ipAddress)` Sets the IP address of the peer.
`void`	`setIpPort(Integer ipPort)`
`void`	`setNatSupport(Boolean natSupport)`
`void`	`setObjectName(String objectName)`
`void`	`setObjectUserName(String objectUserName)`
`void`	`setPort(Integer port)`
`void`	`setRealtimeDevice(String realtimeDevice)` Available since Asterisk 1.4.
`void`	`setStatus(String status)` Sets the status of this peer.
`void`	`setTextSupport(Boolean textSupport)`
`void`	`setTrunk(Boolean trunk)`
`void`	`setVideoSupport(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
appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, 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 String CHANNEL_TYPE_SIP
```
    See Also:
    
    Constant Field Values
  - CHANNEL_TYPE_IAX
```
public static final String CHANNEL_TYPE_IAX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PeerEntryEvent
```
public PeerEntryEvent(Object source)
```
    Creates a new instance.
    
    Parameters:
    
    source -
- Method Detail
  - getChannelType
```
public 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(String channelType)
```
  - getObjectName
```
public String getObjectName()
```
  - setObjectName
```
public void setObjectName(String objectName)
```
  - getObjectUserName
```
public String getObjectUserName()
```
    Returns:
    
    Since:
    
    1.0.0
  - setObjectUserName
```
public void setObjectUserName(String objectUserName)
```
  - getChanObjectType
```
public String getChanObjectType()
```
    For SIP peers this is either "peer" or "user".
    
    Returns:
    
    "peer" or "user".
  - setChanObjectType
```
public void setChanObjectType(String chanObjectType)
```
  - getIpAddress
```
public 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(String ipAddress)
```
    Sets the IP address of the peer.
    
    Parameters:
    
    ipAddress - the IP address of the peer.
  - getIpPort
```
@Deprecated
public 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(Integer ipPort)
```
  - getPort
```
public Integer getPort()
```
    Returns the port of the peer.
    
    Returns:
    
    the port of the peer.
    
    Since:
    
    1.0.0
  - setPort
```
public void setPort(Integer port)
```
  - getDynamic
```
public Boolean getDynamic()
```
  - setDynamic
```
public void setDynamic(Boolean dynamic)
```
  - getNatSupport
```
public Boolean getNatSupport()
```
  - setNatSupport
```
public void setNatSupport(Boolean natSupport)
```
  - getForceRport
```
public Boolean getForceRport()
```
    Returns whether the nat option is set to force_rport.
    Available since Asterisk 1.8
    
    Returns:
    
    true if the nat option is set to force_rport, false otherwise or null if not supported by Asterisk.
  - setForceRport
```
public void setForceRport(Boolean forceRport)
```
  - getVideoSupport
```
public Boolean getVideoSupport()
```
    Available since Asterisk 1.4.
    
    Since:
    
    0.3
  - setVideoSupport
```
public void setVideoSupport(Boolean videoSupport)
```
    Available since Asterisk 1.4.
    
    Since:
    
    0.3
  - getTextSupport
```
public 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(Boolean textSupport)
```
  - getAcl
```
public Boolean getAcl()
```
  - setAcl
```
public void setAcl(Boolean acl)
```
  - getStatus
```
public 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(String status)
```
    Sets the status of this peer.
    
    Parameters:
    
    status - the status of this peer.
  - getRealtimeDevice
```
public String getRealtimeDevice()
```
    Available since Asterisk 1.4.
    
    Since:
    
    0.3
  - setRealtimeDevice
```
public void setRealtimeDevice(String realtimeDevice)
```
    Available since Asterisk 1.4.
    
    Since:
    
    0.3
  - getTrunk
```
public 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(Boolean trunk)
```
  - getEncryption
```
public String getEncryption()
```
  - setEncryption
```
public void setEncryption(String encryption)
```
  - getAutoComedia
```
public String getAutoComedia()
```
    Returns:
    
    the autoComedia
  - setAutoComedia
```
public void setAutoComedia(String autoComedia)
```
    Parameters:
    
    autoComedia - the autoComedia to set
  - getAutoForcerport
```
public String getAutoForcerport()
```
    Returns:
    
    the autoForcerport
  - setAutoForcerport
```
public void setAutoForcerport(String autoForcerport)
```
    Parameters:
    
    autoForcerport - the autoForcerport to set
  - getComedia
```
public String getComedia()
```
    Returns:
    
    the comedia
  - setComedia
```
public void setComedia(String comedia)
```
    Parameters:
    
    comedia - the comedia to set
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    the - description to set
  - getAccountcode
```
public String getAccountcode()
```
    Returns:
    
    the accountcode
  - setAccountcode
```
public void setAccountcode(String accountcode)
```
    Parameters:
    
    the - accountcode to set

Class PeerEntryEvent

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ResponseEvent

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

CHANNEL_TYPE_SIP

CHANNEL_TYPE_IAX

Constructor Detail

PeerEntryEvent

Method Detail

getChannelType

setChannelType

getObjectName

setObjectName

getObjectUserName

setObjectUserName

getChanObjectType

setChanObjectType

getIpAddress

setIpAddress

getIpPort

setIpPort

getPort

setPort

getDynamic

setDynamic

getNatSupport

setNatSupport

getForceRport

setForceRport

getVideoSupport

setVideoSupport

getTextSupport

setTextSupport

getAcl

setAcl

getStatus

setStatus

getRealtimeDevice

setRealtimeDevice

getTrunk

setTrunk

getEncryption

setEncryption

getAutoComedia

setAutoComedia

getAutoForcerport

setAutoForcerport

getComedia

setComedia

getDescription

setDescription

getAccountcode

setAccountcode