sunlabs.brazil.asterisk
public class AsteriskHandler extends Template implements Handler
Usage:
<register queue=xxx key=xxx pattern=xxx [context=xxx server=xxx]> - register interest in a manager event (or events). All generated events will be available with <dequeue name=xxx ...>, where the "name" parameter of the <dequeue> matches the "queue" parameter of <register>. <unregister queue=xxx key=xxx> - unregister interest in a previously registered event. <enqueue name="queue" from="my-q" ...> - Send an command to the manager interface. "queue" is the name specified in the handler "queue" parameter. The enqueue'd data must have an "action" key. The result of the command is obtained by: <dequeue name="my-q" ...> where "my-q" is the "from" attribute of the corrosponding <enqueue> <amicommand server=xxx action=xxx ...> - A syncronous version of the <enqueue> ... <dequeue> above. See below for details.
Nested Class Summary | |
---|---|
static class | AsteriskHandler.AmiStringMap
This class is built on top of the StringMap class and
adds methods for reading Asterisk ManagerInterface replies.
|
static class | AsteriskHandler.EventItem
Keep track of an event listener entry. |
static class | AsteriskHandler.Events
Class to manage the set of events. |
Method Summary | |
---|---|
static void | addEvent(String queue, String key, String exp, String context, String serverName)
Java access to adding event registrations. |
boolean | init(Server server, String prefix)
Remember the host, port, id, and password for an asterisk
manager connection. |
static int | removeEvents(String queue, String key, String exp)
java access to removing event registrations. |
boolean | respond(Request request)
The handler only registers * servers. |
void | tag_amicommand(RewriteContext hr)
Issue a synchronous command to the Asterisk AMI interface.
|
void | tag_asterisk(RewriteContext hr)
This only emits diagnostic information to stdout. |
void | tag_register(RewriteContext hr)
Register an event.
|
void | tag_unregister(RewriteContext hr)
Unregister an event (or events). |
When using multiple servers, only one of the server handler configurations should be listed as a template (there can only be one template instance for a given entity) which server doesn't matter, as events get registered for all servers (the "server" attribute of the response determines where it came from). As above, commands to a server are distinquished with either the "queue" or "server" attributes, depending on whether the command Qs are used directly, or the <amicommand> template is used.
To Do
Figure out where to send unregistered events, such as "reload".
Attributes:
<register queue=xxx key=xxx exp=xxx [context=xxx server=xxx]> queue: The Q name to send the results to. key: The manager response key to match on. Use "*" for all keys. exp: A regular expression that matches a key value context: If specified, only events with this context are considered. server: If specified, only events from this server are considered. The server matches the "Server" item in the event, and is the server name, followed by a ":", then the port number (e.g. pbx.com:5038).