Class AsteriskAGIHandler

  extended by sunlabs.brazil.template.Template
      extended by sunlabs.brazil.asterisk.AsteriskAGIHandler (view source)
All Implemented Interfaces:
Runnable, Handler, TemplateInterface

public class AsteriskAGIHandler
extends Template
implements Handler, Runnable

FAGI (fast AGI) handler and template for Asterisk. This handler/template starts a server listening on the * FAGI port. Anytime it gets an agi request from * it creates a dummy request object (sort of like TestRequest) to simulate an http request, reads a file implied by the request agi:... string, and processes the file through the template runner. The template can be used to interact with * via standard agi commands, and the web via the SetTemplate and namespaces. The template output is discarded (if debug is enables, it is printed on the server console); everything is done via side effect. This allows us to interact with the ordinary template variables and namespaces. I'm still not sure how to deal with sessions, so we'll use a different one for each uniqueid in the agi request. (This is a bad idea unless we delete completed sessions "by hand").

(Implementation notes)
This class implements 4 different threads: - handler/init: to get the config params and start the listening socket - The thread that listens and accepts connections from * - the threads that handle the incoming agi requests - the threads that do the template stuff

Field Summary
Fields inherited from class sunlabs.brazil.template.Template
Constructor Summary
Method Summary
 boolean done(RewriteContext hr)
          Close the socket connection.
 boolean init(RewriteContext hr)
          Open the socket's streams at top of page.
 boolean init(Server server, String prefix)
          Start a Listening socket thread, and wait for AGI connections.
 boolean respond(Request request)
          We don't handle any "normal" requests.
 void run()
          Either start a listening socket or handle an AGI request.
 void tag_agi(RewriteContext hr)
          Provide the 'agi' tag.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public AsteriskAGIHandler()
Method Detail


public boolean init(Server server,
                    String prefix)
Start a Listening socket thread, and wait for AGI connections.

Specified by:
init in interface Handler
server - The HTTP server that created this Handler. Typical Handlers will use Server.props to obtain run-time configuration information.
prefix - The handlers name. The string this Handler may prepend to all of the keys that it uses to extract configuration information from Server.props. This is set (by the Server and ChainHandler) to help avoid configuration parameter namespace collisions.
true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.


public boolean respond(Request request)
                throws IOException
We don't handle any "normal" requests.

Specified by:
respond in interface Handler
request - The Request object that represents the HTTP request.
always false
IOException - if there was an I/O error while sending the response to the client. Typically, in that case, the Server will (try to) send an error message to the client and then close the client's connection.

The IOException should not be used to silently ignore problems such as being unable to access some server-side resource (for example getting a FileNotFoundException due to not being able to open a file). In that case, the Handler's duty is to turn that IOException into a HTTP response indicating, in this case, that a file could not be found.


public boolean init(RewriteContext hr)
Open the socket's streams at top of page. This will be used by the <agi> calls.

Specified by:
init in interface TemplateInterface
init in class Template


public boolean done(RewriteContext hr)
Close the socket connection.

Specified by:
done in interface TemplateInterface
done in class Template


public void tag_agi(RewriteContext hr)
Provide the 'agi' tag. <agi command="agi command"> The result is placed in "agi_result". NOTE: the thread running this instance doesn't set any of the instance variables. We get everything from "hr".


public void run()
Either start a listening socket or handle an AGI request.

Specified by:
run in interface Runnable

Version Kenai-svn-r24, Generated 08/18/09
Copyright (c) 2001-2009, Sun Microsystems.