Home | History | Annotate | Download | only in stack
      1 /*
      2 * Conditions Of Use
      3 *
      4 * This software was developed by employees of the National Institute of
      5 * Standards and Technology (NIST), an agency of the Federal Government.
      6 * Pursuant to title 15 Untied States Code Section 105, works of NIST
      7 * employees are not subject to copyright protection in the United States
      8 * and are considered to be in the public domain.  As a result, a formal
      9 * license is not needed to use the software.
     10 *
     11 * This software is provided by NIST as a service and is expressly
     12 * provided "AS IS."  NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
     13 * OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
     14 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
     15 * AND DATA ACCURACY.  NIST does not warrant or make any representations
     16 * regarding the use of the software or the results thereof, including but
     17 * not limited to the correctness, accuracy, reliability or usefulness of
     18 * the software.
     19 *
     20 * Permission to use this software is contingent upon your acceptance
     21 * of the terms of this agreement
     22 *
     23 * .
     24 *
     25 */
     26 /*******************************************************************************
     27 * Product of NIST/ITL Advanced Networking Technologies Division (ANTD).        *
     28 *******************************************************************************/
     29 package gov.nist.javax.sip.stack;
     30 import gov.nist.javax.sip.message.*;
     31 
     32 /*
     33  *  Salvador Rey Calatayud suggested adding a parameter to the processRequest/processResponse
     34  *  methods.
     35  */
     36 
     37 /**
     38  * An interface for a genereic message processor for SIP Response messages.
     39  * This is implemented by the application. The stack calls the message
     40  * factory with a pointer to the parsed structure to create one of these
     41  * and then calls processResponse on the newly created SIPServerResponse
     42  * It is the applications responsibility to take care of what needs to be
     43  * done to actually process the response.
     44  *
     45  * @version 1.2 $Revision: 1.4 $ $Date: 2009/07/17 18:58:15 $
     46  *
     47  * @author M. Ranganathan   <br/>
     48  *
     49  *
     50  *
     51  */
     52 public interface ServerResponseInterface {
     53     /**
     54      * Process the Response.
     55      * @param  incomingChannel is the incoming message channel
     56      * @param sipResponse is the responseto process.
     57      * @param sipDialog -- dialog for this response
     58      */
     59     public void processResponse(
     60         SIPResponse sipResponse,
     61         MessageChannel incomingChannel,
     62         SIPDialog sipDialog);
     63 
     64 
     65 
     66 
     67     /**
     68      * This method is called prior to dialog assignment.
     69      * @param sipResponse
     70      * @param incomingChannel
     71      */
     72     public void processResponse(
     73             SIPResponse sipResponse,
     74             MessageChannel incomingChannel);
     75 
     76 
     77 
     78 }
     79