org.asteriskjava.manager.event
Class ManagerEvent

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbstractAgentEvent, AbstractChannelEvent, AbstractMeetMeEvent, AbstractParkedCallEvent, AbstractQueueMemberEvent, AgentCallbackLoginEvent, AgentCallbackLogoffEvent, AgentCalledEvent, AgentLoginEvent, AgentLogoffEvent, AlarmClearEvent, AlarmEvent, CdrEvent, ConnectEvent, DialEvent, DisconnectEvent, DndStateEvent, ExtensionStatusEvent, FaxReceivedEvent, HoldedCallEvent, HoldEvent, LinkageEvent, LogChannelEvent, MessageWaitingEvent, NewExtenEvent, PeerStatusEvent, ProtocolIdentifierReceivedEvent, QueueEvent, RegistryEvent, ReloadEvent, RenameEvent, ResponseEvent, ShutdownEvent, UnholdEvent, UserEvent

public abstract class ManagerEvent
extends java.util.EventObject
implements java.io.Serializable

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 564 2006-09-26 22:54:31Z srt $

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

Parameters:

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:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject