Asterisk-Java

org.asteriskjava.manager.event
Class AbstractAgentEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.AbstractAgentEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AgentCompleteEvent, AgentConnectEvent, AgentDumpEvent, AgentRingNoAnswerEvent

public abstract class AbstractAgentEvent
extends ManagerEvent

Abstract base class for several agent related events.

Since:
0.2
Version:
$Id: AbstractAgentEvent.java 1154 2008-08-24 02:05:26Z srt $
Author:
srt, martins
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
protected AbstractAgentEvent(java.lang.Object source)
           
 
Method Summary
 java.lang.String getChannel()
          Returns the name of the channel.
 java.lang.String getMember()
          Returns the name of the member's interface.
 java.lang.String getMemberName()
          Returns the member name supplied for logging when the member is added.
 java.lang.String getQueue()
          Returns the name of the queue.
 java.lang.String getUniqueId()
          Returns the unique id of the channel.
 java.util.Map<java.lang.String,java.lang.String> getVariables()
          Returns the channel variables if eventwhencalled is set to vars in queues.conf.
 void setChannel(java.lang.String channel)
           
 void setMember(java.lang.String member)
           
 void setMemberName(java.lang.String memberName)
           
 void setQueue(java.lang.String queue)
           
 void setUniqueId(java.lang.String uniqueId)
           
 void setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
          Sets the channel variables.
 
Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, setServer, 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
 

Constructor Detail

AbstractAgentEvent

protected AbstractAgentEvent(java.lang.Object source)
Method Detail

getChannel

public java.lang.String getChannel()
Returns the name of the channel.

Returns:
the name of the channel.

setChannel

public void setChannel(java.lang.String channel)

getUniqueId

public java.lang.String getUniqueId()
Returns the unique id of the channel.

Returns:
the unique id of the channel.

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

getQueue

public java.lang.String getQueue()
Returns the name of the queue.

Returns:
the name of the queue.

setQueue

public void setQueue(java.lang.String queue)

getMember

public java.lang.String getMember()
Returns the name of the member's interface.

Returns:
the name of the member's interface.

setMember

public void setMember(java.lang.String member)

getMemberName

public java.lang.String getMemberName()
Returns the member name supplied for logging when the member is added.

Available since Asterisk 1.4.

Returns:
the member name supplied for logging when the member is added.

setMemberName

public void setMemberName(java.lang.String memberName)

getVariables

public java.util.Map<java.lang.String,java.lang.String> getVariables()
Returns the channel variables if eventwhencalled is set to vars in queues.conf.

Available since Asterisk 1.6

Returns:
the channel variables.
Since:
1.0.0

setVariables

public void setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
Sets the channel variables.

Available since Asterisk 1.6

Parameters:
variables - the channel variables.
Since:
1.0.0

Asterisk-Java

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