org.asteriskjava.manager.action

Class FilterAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.FilterAction

All Implemented Interfaces:

Serializable, ManagerAction

public class FilterAction
extends AbstractManagerAction

The FilterAction dynamically adds filters for the current user in a manager session. The filters added are only used for the current session. Once the connection is closed the filters are removed.

This command requires the user has read access to specific events(manager.conf) and system permission because it can be used to create filters that may bypass filters defined in manager.conf

There are 2 Types of filters: Blacklist: The event you no longer want to receive. It starts with an exclamation. eg. "!RTCPReceived". Whitelist: The event you are interested in receiving. eg. "RTCPReceived".

Regular expressions can be used for the filters.

Evaluation of the filters is as follows: If no filters are configured all events are reported as normal. If there are white filters only: Then it is implied that all events are black listed and only the specified white filter events are returned. If there are black filters only: Then it is implied that all events are white listed and only the specified black filter events are removed. If there are both white and black filters: Then it is implied that all events are black listed and only the specified white filter events are returned, and then specific blacklisted events are further removed. (Limited use cases)

Version:

$Id$

Author:

aavaz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilterAction() Creates a new FilterAction.
FilterAction(String filter) Creates a new FilterAction with the filter specified

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getFilter() Returns the filter.
String	getOperation() Returns the filter operation which is "Add" by default.
void	setFilter(String filter) Sets the filter.

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

FilterAction

public FilterAction()

Creates a new FilterAction.

FilterAction

public FilterAction(String filter)

Creates a new FilterAction with the filter specified

Parameters:

filter - the whitelist or blacklist filter to be added.

Since:

???

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "Filter".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getOperation

public String getOperation()

Returns the filter operation which is "Add" by default.

Returns:

the filter operation which is "Add" by default

getFilter

public String getFilter()

Returns the filter.

Returns:

the filter.

setFilter

public void setFilter(String filter)

Sets the filter.

Parameters:

filter - add the whitelist or blacklist event to be filtered.