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: package gov.nist.siplite.address;
26:
27: import gov.nist.siplite.message.*;
28: import gov.nist.siplite.*;
29: import java.util.*;
30:
31: /**
32: * Path for outbound message routing.
33: */
34: public interface Router {
35:
36: /**
37: * Return a linked list of addresses corresponding to a requestURI.
38: * This is called for sending out outbound messages for which we do
39: * not directly have the request URI. The implementaion function
40: * is expected to return a linked list of addresses to which the
41: * request is forwarded. The implementation may use this method
42: * to perform location searches etc.
43: *
44: * @param sipRequest is the message to route.
45: * @param isDialog target URI is taken from route list inside of dialog,
46: * else it is taken from request URI
47: * @return enumeration of next hops
48: */
49: public Enumeration getNextHops(Request sipRequest, boolean isDialog);
50:
51: /**
52: * Sets the outbound proxy.
53: * @param outboundProxy the outbound proxy address
54: */
55: public void setOutboundProxy(String outboundProxy);
56:
57: /**
58: * Sets the sip stack.
59: * @param sipStack the SIP stack context
60: */
61: public void setSipStack(SipStack sipStack);
62:
63: /**
64: * Gets the outbound proxy.
65: * @return the outbounc proxy address
66: */
67: public Hop getOutboundProxy();
68:
69: }
|