org.asteriskjava.manager.action

Class QueueLogAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.QueueLogAction

All Implemented Interfaces:

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$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueueLogAction() Creates a new empty QueueLogAction.
QueueLogAction(String queue, String event) Creates a new QueueLogAction with the mandatory properties queue and event.
QueueLogAction(String queue, String event, String message, String iface, String uniqueId) Creates a new QueueLogAction with the mandatory properties queue and event.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getEvent() Returns the event to log.
String	getInterface() Returns the interface of the member to log the event for.
String	getMessage() Returns the message to log.
String	getQueue() Returns the name of the queue to log the event for.
String	getUniqueId() Returns the unique id of the channel to log the event for.
void	setEvent(String event) Sets the event to log.
void	setInterface(String iface) Sets the interface of the member to log the event for.
void	setMessage(String message) Sets the message to log.
void	setQueue(String queue) Sets the name of the queue to log the event for.
void	setUniqueId(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(String queue,
                      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(String queue,
                      String event,
                      String message,
                      String iface,
                      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 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 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(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 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(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 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(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 String getEvent()

Returns the event to log.

Returns:

the event to log.

setEvent

public void setEvent(String event)

Sets the event to log.

This property is mandatory.

Parameters:

event - the event to log.

getMessage

public String getMessage()

Returns the message to log.

Returns:

the message to log.

setMessage

public void setMessage(String message)

Sets the message to log.

Parameters:

message - the message to log.