Asterisk-Java

org.asteriskjava.manager.action
Class QueueLogAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.QueueLogAction
All Implemented Interfaces:
java.io.Serializable, ManagerAction

public class QueueLogAction
extends AbstractManagerAction

The QueueLogAction adds a custom log entry to the queue_log.

It is implemented in apps/app_queue.c

Available since Asterisk 1.6.

Since:
1.0.0
Version:
$Id: QueueLogAction.java 1138 2008-08-18 15:44:13Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
QueueLogAction()
          Creates a new empty QueueLogAction.
QueueLogAction(java.lang.String queue, java.lang.String event)
          Creates a new QueueLogAction with the mandatory properties queue and event.
QueueLogAction(java.lang.String queue, java.lang.String event, java.lang.String message, java.lang.String iface, java.lang.String uniqueId)
          Creates a new QueueLogAction with the mandatory properties queue and event.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getEvent()
          Returns the event to log.
 java.lang.String getInterface()
          Returns the interface of the member to log the event for.
 java.lang.String getMessage()
          Returns the message to log.
 java.lang.String getQueue()
          Returns the name of the queue to log the event for.
 java.lang.String getUniqueId()
          Returns the unique id of the channel to log the event for.
 void setEvent(java.lang.String event)
          Sets the event to log.
 void setInterface(java.lang.String iface)
          Sets the interface of the member to log the event for.
 void setMessage(java.lang.String message)
          Sets the message to log.
 void setQueue(java.lang.String queue)
          Sets the name of the queue to log the event for.
 void setUniqueId(java.lang.String uniqueId)
          Sets the unique id of the channel to log the event for.
 
Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction
getActionId, setActionId, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueueLogAction

public QueueLogAction()
Creates a new empty QueueLogAction.


QueueLogAction

public QueueLogAction(java.lang.String queue,
                      java.lang.String event)
Creates a new QueueLogAction with the mandatory properties queue and event.

Parameters:
queue - the name of the queue to log the event for.
event - the event to log.

QueueLogAction

public QueueLogAction(java.lang.String queue,
                      java.lang.String event,
                      java.lang.String message,
                      java.lang.String iface,
                      java.lang.String uniqueId)
Creates a new QueueLogAction with the mandatory properties queue and event.

Parameters:
queue - the name of the queue to log the event for.
event - the event to log.
message - the message to log, may be null.
iface - the interface of the member to log the event for, may be null.
uniqueId - the unique id of the channel to log the event for, may be null.
Method Detail

getAction

public java.lang.String getAction()
Returns the name of this action, i.e. "QueueLog".

Specified by:
getAction in interface ManagerAction
Specified by:
getAction in class AbstractManagerAction
Returns:
the name of this action.

getInterface

public java.lang.String getInterface()
Returns the interface of the member to log the event for.

Returns:
the interface of the member to log the event for.

setInterface

public void setInterface(java.lang.String iface)
Sets the interface of the member to log the event for.

Parameters:
iface - the interface of the member to log the event for.

getQueue

public java.lang.String getQueue()
Returns the name of the queue to log the event for.

Returns:
the name of the queue to log the event for.

setQueue

public void setQueue(java.lang.String queue)
Sets the name of the queue to log the event for.

This property is mandatory.

Parameters:
queue - the name of the queue to log the event for.

getUniqueId

public java.lang.String getUniqueId()
Returns the unique id of the channel to log the event for.

Returns:
the unique id of the channel to log the event for.

setUniqueId

public void setUniqueId(java.lang.String uniqueId)
Sets the unique id of the channel to log the event for.

Parameters:
uniqueId - the unique id of the channel to log the event for.

getEvent

public java.lang.String getEvent()
Returns the event to log.

Returns:
the event to log.

setEvent

public void setEvent(java.lang.String event)
Sets the event to log.

This property is mandatory.

Parameters:
event - the event to log.

getMessage

public java.lang.String getMessage()
Returns the message to log.

Returns:
the message to log.

setMessage

public void setMessage(java.lang.String message)
Sets the message to log.

Parameters:
message - the message to log.

Asterisk-Java

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