01: /*
02: * Portions Copyright 2000-2007 Sun Microsystems, Inc. All Rights
03: * Reserved. Use is subject to license terms.
04: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License version
08: * 2 only, as published by the Free Software Foundation.
09: *
10: * This program is distributed in the hope that it will be useful, but
11: * WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * General Public License version 2 for more details (a copy is
14: * included at /legal/license.txt).
15: *
16: * You should have received a copy of the GNU General Public License
17: * version 2 along with this work; if not, write to the Free Software
18: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19: * 02110-1301 USA
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
22: * Clara, CA 95054 or visit www.sun.com if you need additional
23: * information or have any questions.
24: */
25: /*
26: */
27: package gov.nist.siplite.stack;
28:
29: import gov.nist.siplite.message.*;
30:
31: /**
32: * An interface for a genereic message processor for SIP Response messages.
33: * This is implemented by the application. The stack calls the message
34: * factory with a pointer to the parsed structure to create one of these
35: * and then calls processResponse on the newly created SIPServerResponse
36: * It is the applications responsibility to take care of what needs to be
37: * done to actually process the response.
38: *
39: * @version JAIN-SIP-1.1
40: *
41: *
42: * <a href="{@docRoot}/uncopyright.html">This code is in the public domain.</a>
43: *
44: */
45: public interface SIPServerResponseInterface {
46: /**
47: * Processes the Response.
48: * @param sipResponse is the responseto process.
49: * @param incomingChannel is the incoming message channel (parameter
50: * added in response to a request by Salvador Rey Calatayud.)
51: * @throws SIPServerException Exception that gets thrown by
52: * this processor when an exception is encountered in the
53: * message processing.
54: */
55: public void processResponse(Response sipResponse,
56: MessageChannel incomingChannel) throws SIPServerException;
57:
58: /**
59: * Gets the Channel for the sender.
60: * @return the MessageChannel through which you can send a
61: * new request to the responder.
62: */
63: public MessageChannel getRequestChannel();
64:
65: /**
66: * Gets the auxiliary information that is generated while logging
67: * for the purpose of writing out the log file.
68: * @return the processing infromation
69: */
70: public String getProcessingInfo();
71: }
|