01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.mts.base;
28:
29: import org.cougaar.mts.std.AttributedMessage;
30: import org.cougaar.core.component.Service;
31:
32: /**
33: * The third station for an outgoing message. In theory a
34: * given Message Transport subsystem can have multiple Routers.
35: * For this release we only make one, instantiated as a RouterImpl.
36: * Either way, the Routers are instantiated by a RouterFactory,
37: * accesible to SendQueueImpls as the internal MTS service
38: * <ff>Router</ff>.
39: * <p>
40: * The <strong>routeMessage</strong> method is used to requesting
41: * routing for a given message, which would ordinarily mean passing
42: * the message on to a DestinationQueue for the message's destination.
43: * Ordinarily this method would only be called from a SendQueue
44: * implementation.
45: * <p>
46: * The previous station is SendQueue. The next station is
47: * DestinationQueue.
48: *
49: * @see RouterFactory
50: * @see SendLink
51: * @see SendQueue
52: * @see DestinationQueue
53: * @see DestinationLink
54: * @see MessageWriter
55: * @see MessageReader
56: * @see MessageDeliverer
57: * @see ReceiveLink
58: *
59: * Javadoc contributions from George Mount.
60: */
61: public interface Router extends Service {
62:
63: /**
64: * Used by SendQueue implementations to route an outgoing
65: * message, ordinarily to the DestinatonQueue corresponding to the
66: * message's destintion.
67: *
68: * @see DestinationQueue#holdMessage(AttributedMessage)
69: */
70: void routeMessage(AttributedMessage message);
71: }
|