View Javadoc

1   /*
2    * Copyright  2004-2005 Stefan Reuter
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *
16   */
17  package net.sf.asterisk.fastagi;
18  
19  /***
20   * AGIScripts are used by the AsteriskServer to handle AGIRequests received from
21   * the Asterisk server.<br>
22   * To implement functionality using this framework you have to implement this
23   * interface.<br>
24   * Note: The implementation of AGIScript must be threadsafe as only one instance
25   * is used by AsteriskServer to handle all requests to a resource.
26   * 
27   * @author srt
28   * @version $Id: AGIScript.java,v 1.6 2005/03/11 09:37:39 srt Exp $
29   */
30  public interface AGIScript
31  {
32      /***
33       * The service method is called by the AsteriskServer whenever this
34       * AGIScript should handle an incoming AGIRequest.
35       * 
36       * @param request the initial data received from Asterisk when requesting
37       *            this script.
38       * @param channel a handle to communicate with Asterisk such as sending
39       *            commands to the channel sending the request.
40       * 
41       * @throws AGIException any exception thrown by your script will be logged.
42       */
43      void service(final AGIRequest request, final AGIChannel channel)
44              throws AGIException;
45  }