|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.asteriskjava.manager.event.ManagerEvent
public abstract class ManagerEvent
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.
Field Summary |
---|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
ManagerEvent(java.lang.Object source)
|
Method Summary | |
---|---|
protected void |
appendPropertyIfNotNull(java.lang.StringBuilder sb,
java.lang.String property,
java.lang.Object value)
|
java.util.Date |
getDateReceived()
Returns the point in time this event was received from the Asterisk server. |
java.lang.String |
getFile()
Returns the name of the file in Asterisk's source code that triggered this event. |
java.lang.String |
getFunc()
Returns the name of the C function in Asterisk's source code that triggered this event. |
java.lang.Integer |
getLine()
Returns the line number in Asterisk's source code where this event was triggered. |
java.lang.String |
getPrivilege()
Returns the AMI authorization class of this event. |
java.lang.Integer |
getSequenceNumber()
Returns the sequence numbers 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 |
setFile(java.lang.String file)
|
void |
setFunc(java.lang.String func)
|
void |
setLine(java.lang.Integer line)
|
void |
setPrivilege(java.lang.String privilege)
Sets the AMI authorization class of this event. |
void |
setSequenceNumber(java.lang.Integer sequenceNumber)
|
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 |
---|
public ManagerEvent(java.lang.Object source)
Method Detail |
---|
public java.util.Date getDateReceived()
null
.
public void setDateReceived(java.util.Date dateReceived)
public java.lang.String getPrivilege()
public void setPrivilege(java.lang.String privilege)
public final java.lang.Double getTimestamp()
manager.conf
by setting timestampevents = yes
.
In contains the time the event was generated in seconds since the epoch.
Example: 1159310429.569108
public final void setTimestamp(java.lang.Double timestamp)
timestamp
- the timestamp to set.public final java.lang.String getServer()
null
when directly connected to an Asterisk server
instead of AstManProxy.public final void setServer(java.lang.String server)
server
- the name of the Asterisk server from which this event has been received.public java.lang.String getFile()
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.
null
if debgging is turned off.getFunc()
,
getLine()
public void setFile(java.lang.String file)
public java.lang.Integer getLine()
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.
null
if debgging is turned off.getFile()
,
getFunc()
public void setLine(java.lang.Integer line)
public java.lang.String getFunc()
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.
null
if debgging is turned off.getFile()
,
getLine()
public void setFunc(java.lang.String func)
public java.lang.Integer getSequenceNumber()
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.
null
if debgging is turned off.getFile()
,
getLine()
public void setSequenceNumber(java.lang.Integer sequenceNumber)
public java.lang.String toString()
toString
in class java.util.EventObject
protected void appendPropertyIfNotNull(java.lang.StringBuilder sb, java.lang.String property, java.lang.Object value)
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |