ManagerEvent (Asterisk-Java 2.0.2.fixed API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractAgentEvent, AbstractBridgeEvent, AbstractChannelEvent, AbstractFaxEvent, AbstractHoldEvent, AbstractMeetMeEvent, AbstractMonitorEvent, AbstractParkedCallEvent, AbstractQueueMemberEvent, AbstractRtcpEvent, AbstractRtpStatEvent, AgentCallbackLoginEvent, AgentCallbackLogoffEvent, AgentCalledEvent, AgentLoginEvent, AgentLogoffEvent, AgiExecEvent, AlarmClearEvent, AlarmEvent, BridgeEvent, BridgeExecEvent, BridgeMergeEvent, CdrEvent, CelEvent, ChallengeResponseFailedEvent, ChallengeSentEvent, ChannelReloadEvent, ChannelUpdateEvent, ChanSpyStartEvent, ChanSpyStopEvent, ConnectEvent, ContactStatusEvent, DAHDIChannelEvent, DeviceStateChangeEvent, DialEvent, DisconnectEvent, DndStateEvent, DongleCallStateChangeEvent, DongleCENDEvent, DongleNewCMGREvent, DongleNewSMSBase64Event, DongleNewSMSEvent, DongleStatusEvent, DtmfEvent, EndpointListCompleteEvent, EndpointListEvent, ExtensionStatusEvent, FullyBootedEvent, HoldedCallEvent, InvalidPasswordEvent, JabberEventEvent, JitterBufStatsEvent, LocalBridgeEvent, LogChannelEvent, MasqueradeEvent, MeetMeEndEvent, MessageWaitingEvent, ModuleLoadReportEvent, MusicOnHoldEvent, NewAccountCodeEvent, NewConnectedLineEvent, NewExtenEvent, PeerStatusEvent, PickupEvent, PriEventEvent, ProtocolIdentifierReceivedEvent, QueueEvent, QueueMemberPenaltyEvent, ReceiveFaxEvent, RegistryEvent, ReloadEvent, RenameEvent, ResponseEvent, ShutdownEvent, SuccessfulAuthEvent, TransferEvent, UserEvent, VarSetEvent
```
public abstract class ManagerEvent
extends EventObject
```
Abstract base class for all Events that can be received from the Asterisk server.
Events contain data pertaining to an event generated from within the Asterisk core or an extension module.
There is one conrete subclass of ManagerEvent per each supported Asterisk Event.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`callerIdName`
`protected String`	`callerIdNum`
`protected Integer`	`channelState`
`protected String`	`channelStateDesc`
`protected String`	`connectedLineName`
`protected String`	`connectedLineNum`
`protected String`	`context`
`protected String`	`exten`
`protected Integer`	`priority`

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description

ManagerEvent(Object source)

Constructors
Constructor and Description
`ManagerEvent(Object source)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendPropertyIfNotNull(StringBuilder sb, String property, Object value)`
`String`	`getCallerIdName()` Returns the Caller ID name of the caller's channel.
`String`	`getCallerIdNum()`
`Integer`	`getChannelState()`
`String`	`getChannelStateDesc()`
`String`	`getConnectedLineName()`
`String`	`getConnectedLineNum()`
`String`	`getContext()`
`Date`	`getDateReceived()` Returns the point in time this event was received from the Asterisk server.
`String`	`getExten()`
`String`	`getFile()` Returns the name of the file in Asterisk's source code that triggered this event.
`String`	`getFunc()` Returns the name of the C function in Asterisk's source code that triggered this event.
`Integer`	`getLine()` Returns the line number in Asterisk's source code where this event was triggered.
`Integer`	`getPriority()`
`String`	`getPrivilege()` Returns the AMI authorization class of this event.
`Integer`	`getSequenceNumber()` Returns the sequence numbers of this event.
`String`	`getServer()` Returns the name of the Asterisk server from which this event has been received.
`String`	`getSystemName()`
`Double`	`getTimestamp()` Returns the timestamp for this event.
`void`	`setCallerIdName(String callerIdName)`
`void`	`setCallerIdNum(String callerIdNum)`
`void`	`setChannelState(Integer channelState)`
`void`	`setChannelStateDesc(String channelStateDesc)`
`void`	`setConnectedLineName(String connectedLineName)`
`void`	`setConnectedLineNum(String connectedLineNum)`
`void`	`setContext(String context)`
`void`	`setDateReceived(Date dateReceived)` Sets the point in time this event was received from the asterisk server.
`void`	`setExten(String exten)`
`void`	`setFile(String file)`
`void`	`setFunc(String func)`
`void`	`setLine(Integer line)`
`void`	`setPriority(Integer priority)`
`void`	`setPrivilege(String privilege)` Sets the AMI authorization class of this event.
`void`	`setSequenceNumber(Integer sequenceNumber)`
`void`	`setServer(String server)` Sets the name of the Asterisk server from which this event has been received.
`void`	`setSystemName(String systemName)`
`void`	`setTimestamp(Double timestamp)` Sets the timestamp for this event.
`String`	`toJsonString()`
`String`	`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
  - callerIdName
```
protected String callerIdName
```
  - callerIdNum
```
protected String callerIdNum
```
  - channelState
```
protected Integer channelState
```
  - channelStateDesc
```
protected String channelStateDesc
```
  - connectedLineName
```
protected String connectedLineName
```
  - connectedLineNum
```
protected String connectedLineNum
```
  - context
```
protected String context
```
  - exten
```
protected String exten
```
  - priority
```
protected Integer priority
```
- Constructor Detail
  - ManagerEvent
```
public ManagerEvent(Object source)
```
- Method Detail
  - appendPropertyIfNotNull
```
protected void appendPropertyIfNotNull(StringBuilder sb,
                                       String property,
                                       Object value)
```
  - getCallerIdName
```
public String getCallerIdName()
```
    Returns the Caller ID name of the caller's channel.
    
    Returns:
    
    the Caller ID name of the caller's channel or "unknown" if none has been set.
    
    Since:
    
    0.2
  - getCallerIdNum
```
public String getCallerIdNum()
```
  - getChannelState
```
public Integer getChannelState()
```
  - getChannelStateDesc
```
public String getChannelStateDesc()
```
  - getConnectedLineName
```
public String getConnectedLineName()
```
  - getConnectedLineNum
```
public String getConnectedLineNum()
```
  - getContext
```
public String getContext()
```
  - getDateReceived
```
public Date getDateReceived()
```
    Returns the point in time this event was received from the Asterisk server.
    Pseudo events that are not directly received from the asterisk server (for example ConnectEvent and DisconnectEvent) may return null.
    
    Returns:
    
    time this event was received from the Asterisk server
  - getExten
```
public String getExten()
```
  - getFile
```
public String getFile()
```
    Returns the name of the file in Asterisk's source code that triggered this event. For example pbx.c.
    This property is only available if debugging for the Manager API has been turned on in Asterisk. This can be done by calling manager debug on on Asterisk's command line interface or by adding debug=on to Asterisk's manager.conf. This feature is availble in Asterisk since 1.6.0.
    
    Returns:
    
    the name of the file in that triggered this event or null if debgging is turned off.
    
    Since:
    
    1.0.0
    
    See Also:
    
    getFunc(), getLine()
  - getFunc
```
public String getFunc()
```
    Returns the name of the C function in Asterisk's source code that triggered this event. For example pbx_builtin_setvar_helper
    This property is only available if debugging for the Manager API has been turned on in Asterisk. This can be done by calling manager debug on on Asterisk's command line interface or by adding debug=on to Asterisk's manager.conf. This feature is availble in Asterisk since 1.6.0.
    
    Returns:
    
    the name of the C function that triggered this event or null if debgging is turned off.
    
    Since:
    
    1.0.0
    
    See Also:
    
    getFile(), getLine()
  - getLine
```
public Integer getLine()
```
    Returns the line number in Asterisk's source code where this event was triggered.
    This property is only available if debugging for the Manager API has been turned on in Asterisk. This can be done by calling manager debug on on Asterisk's command line interface or by adding debug=on to Asterisk's manager.conf. This feature is availble in Asterisk since 1.6.0.
    
    Returns:
    
    the line number where this event was triggered or null if debgging is turned off.
    
    Since:
    
    1.0.0
    
    See Also:
    
    getFile(), getFunc()
  - getPriority
```
public Integer getPriority()
```
  - getPrivilege
```
public String getPrivilege()
```
    Returns the AMI authorization class of this event.
    This is one or more of system, call, log, verbose, command, agent or user. Multiple privileges are separated by comma.
    Note: This property is not available from Asterisk 1.0 servers.
    
    Returns:
    
    privilege
    
    Since:
    
    0.2
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
    Returns the sequence numbers of this event. Sequence numbers are only incremented while debugging is enabled.
    This property is only available if debugging for the Manager API has been turned on in Asterisk. This can be done by calling manager debug on on Asterisk's command line interface or by adding debug=on to Asterisk's manager.conf. This feature is availble in Asterisk since 1.6.0.
    
    Returns:
    
    the sequence number of this event or null if debgging is turned off.
    
    Since:
    
    1.0.0
    
    See Also:
    
    getFile(), getLine()
  - getServer
```
public final String getServer()
```
    Returns the name of the Asterisk server from which this event has been received.
    This property is only available when using to AstManProxy.
    
    Returns:
    
    the name of the Asterisk server from which this event has been received or null when directly connected to an Asterisk server instead of AstManProxy.
    
    Since:
    
    1.0.0
  - getSystemName
```
public String getSystemName()
```
  - getTimestamp
```
public final Double getTimestamp()
```
    Returns the timestamp for this event.
    The timestamp property is available in Asterisk since 1.4 if enabled in manager.conf by setting timestampevents = yes.
    In contains the time the event was generated in seconds since the epoch.
    Example: 1159310429.569108
    
    Returns:
    
    the timestamp for this event.
    
    Since:
    
    0.3
  - setCallerIdName
```
public void setCallerIdName(String callerIdName)
```
  - setCallerIdNum
```
public void setCallerIdNum(String callerIdNum)
```
  - setChannelState
```
public void setChannelState(Integer channelState)
```
  - setChannelStateDesc
```
public void setChannelStateDesc(String channelStateDesc)
```
  - setConnectedLineName
```
public void setConnectedLineName(String connectedLineName)
```
  - setConnectedLineNum
```
public void setConnectedLineNum(String connectedLineNum)
```
  - setContext
```
public void setContext(String context)
```
  - setDateReceived
```
public void setDateReceived(Date dateReceived)
```
    Sets the point in time this event was received from the asterisk server.
    
    Parameters:
    
    dateReceived - time this event was received from the asterisk server
  - setExten
```
public void setExten(String exten)
```
  - setFile
```
public void setFile(String file)
```
  - setFunc
```
public void setFunc(String func)
```
  - setLine
```
public void setLine(Integer line)
```
  - setPriority
```
public void setPriority(Integer priority)
```
  - setPrivilege
```
public void setPrivilege(String privilege)
```
    Sets the AMI authorization class of this event.
    
    Parameters:
    
    privilege - privilege
    
    Since:
    
    0.2
  - setSequenceNumber
```
public void setSequenceNumber(Integer sequenceNumber)
```
  - setServer
```
public final void setServer(String server)
```
    Sets the name of the Asterisk server from which this event has been received.
    
    Parameters:
    
    server - the name of the Asterisk server from which this event has been received.
    
    Since:
    
    1.0.0
  - setSystemName
```
public void setSystemName(String systemName)
```
  - setTimestamp
```
public final void setTimestamp(Double timestamp)
```
    Sets the timestamp for this event.
    
    Parameters:
    
    timestamp - the timestamp to set.
    
    Since:
    
    0.3
  - toJsonString
```
public String toJsonString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class EventObject

Class ManagerEvent

Field Summary

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

callerIdName

callerIdNum

channelState

channelStateDesc

connectedLineName

connectedLineNum

context

exten

priority

Constructor Detail

ManagerEvent

Method Detail

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

toJsonString

toString