Asterisk-Java

org.asteriskjava.manager.event
Class ManagerEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AbstractAgentEvent, AbstractChannelEvent, AbstractMeetMeEvent, AbstractMonitorEvent, AbstractParkedCallEvent, AbstractQueueMemberEvent, AbstractRtcpEvent, AbstractRtpStatEvent, AgentCallbackLoginEvent, AgentCallbackLogoffEvent, AgentCalledEvent, AgentLoginEvent, AgentLogoffEvent, AgiExecEvent, AlarmClearEvent, AlarmEvent, BridgeEvent, BridgeExecEvent, CdrEvent, ChannelReloadEvent, ChannelUpdateEvent, ConnectEvent, DialEvent, DisconnectEvent, DndStateEvent, DtmfEvent, ExtensionStatusEvent, FaxReceivedEvent, HoldedCallEvent, HoldEvent, JabberEventEvent, JitterBufStatsEvent, LogChannelEvent, MasqueradeEvent, MeetMeEndEvent, MessageWaitingEvent, ModuleLoadReportEvent, MusicOnHoldEvent, NewAccountCodeEvent, NewExtenEvent, PeerStatusEvent, PriEventEvent, ProtocolIdentifierReceivedEvent, QueueEvent, QueueMemberPenaltyEvent, RegistryEvent, ReloadEvent, RenameEvent, ResponseEvent, ShutdownEvent, TransferEvent, UserEvent, VarSetEvent

public abstract class ManagerEvent
extends java.util.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: ManagerEvent.java 1164 2008-09-18 02:40:44Z sprior $
Author:
srt
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ManagerEvent(java.lang.Object source)
           
 
Method Summary
 java.util.Date getDateReceived()
          Returns the point in time this event was received from the Asterisk server.
 java.lang.String getPrivilege()
          Returns the AMI authorization class of this event.
 java.lang.String getServer()
          Returns the name of the Asterisk server from which this event has been received.
 java.lang.Double getTimestamp()
          Returns the timestamp for this event.
 void setDateReceived(java.util.Date dateReceived)
          Sets the point in time this event was received from the asterisk server.
 void setPrivilege(java.lang.String privilege)
          Sets the AMI authorization class of this event.
 void setServer(java.lang.String server)
          Sets the name of the Asterisk server from which this event has been received.
 void setTimestamp(java.lang.Double timestamp)
          Sets the timestamp for this event.
 java.lang.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
 

Constructor Detail

ManagerEvent

public ManagerEvent(java.lang.Object source)
Method Detail

getDateReceived

public java.util.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.


setDateReceived

public void setDateReceived(java.util.Date dateReceived)
Sets the point in time this event was received from the asterisk server.


getPrivilege

public java.lang.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.

Since:
0.2

setPrivilege

public void setPrivilege(java.lang.String privilege)
Sets the AMI authorization class of this event.

Since:
0.2

getTimestamp

public final java.lang.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

setTimestamp

public final void setTimestamp(java.lang.Double timestamp)
Sets the timestamp for this event.

Parameters:
timestamp - the timestamp to set.
Since:
0.3

getServer

public final java.lang.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

setServer

public final void setServer(java.lang.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

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject

Asterisk-Java

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