/*
* Portions Copyright 2000-2009 Sun Microsystems, Inc. All Rights
* Reserved. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version
* 2 only, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details (a copy is
* included at /legal/license.txt).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 or visit www.sun.com if you need additional
* information or have any questions.
*/
/*
*/
package gov.nist.siplite.stack;
import gov.nist.siplite.message.*;
/**
* An interface for a genereic message processor for SIP Response messages.
* This is implemented by the application. The stack calls the message
* factory with a pointer to the parsed structure to create one of these
* and then calls processResponse on the newly created SIPServerResponse
* It is the applications responsibility to take care of what needs to be
* done to actually process the response.
*
* @version JAIN-SIP-1.1
*
*
* <a href="{@docRoot}/uncopyright.html">This code is in the public domain.</a>
*
*/
public interface SIPServerResponseInterface {
/**
* Processes the Response.
* @param sipResponse is the responseto process.
* @param incomingChannel is the incoming message channel (parameter
* added in response to a request by Salvador Rey Calatayud.)
* @throws SIPServerException Exception that gets thrown by
* this processor when an exception is encountered in the
* message processing.
*/
public void processResponse(Response sipResponse,
MessageChannel incomingChannel)
throws SIPServerException;
/**
* Gets the Channel for the sender.
* @return the MessageChannel through which you can send a
* new request to the responder.
*/
public MessageChannel getRequestChannel();
/**
* Gets the auxiliary information that is generated while logging
* for the purpose of writing out the log file.
* @return the processing infromation
*/
public String getProcessingInfo();
}