KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ubermq > jms > common > routing > IConfigurableRouter


1 package com.ubermq.jms.common.routing;
2
3 import java.util.*;
4
5 /**
6  * Extends the router base functionality to provide dynamic modification
7  * of a route table during operation.
8  */
9 public interface IConfigurableRouter extends IRouter, java.io.Serializable JavaDoc
10 {
11     /**
12      * Adds a route from a source specification to a destination.
13      */
14     public void addRoute(SourceSpec source, RouteDestNode dest);
15
16     /**
17      * Adds an exclusion route. This is a route, which if it exists,
18      * precludes a match from occuring between the source and destination.
19      */
20     public void excludeRoute(SourceSpec source, RouteDestNode dest);
21
22     /**
23      * Removes a route.
24      */
25     public void remove(SourceSpec source, RouteDestNode dest);
26
27     /**
28      * Removes an exclusion.
29      */
30     public void removeExclusion(SourceSpec source, RouteDestNode dest);
31
32     /**
33      * Removes all routes to a given destination node, in preparation for
34      * its deletion.
35      */
36     public void removeRoutesTo(RouteDestNode dest);
37
38     /**
39      * Adds a known node. Source specifications will not match if the destination
40      * node is not currently known. This provides for the ability to quickly
41      * turn destinations on and off by keeping this set accurate.
42      */
43     public void addKnownNode(RouteDestNode node);
44
45     /**
46      * Removes a known node.Source specifications will not match if the destination
47      * node is not currently known. This provides for the ability to quickly
48      * turn destinations on and off by keeping this set accurate.
49      */
50     public void removeKnownNode(RouteDestNode node);
51
52     /**
53      * Returns a set of all known nodes, as RouteDestNode objects.
54      * @return a Set
55      */
56     public Set getKnownNodes();
57
58     /**
59      * @return a human readable label for this router.
60      */
61     public String JavaDoc getNodeLabel();
62
63     /**
64      * Sets a human readable label for this router.
65      */
66     public void setNodeLabel(String JavaDoc label);
67
68     /**
69      * Resets this router to its initial, empty state.
70      */
71     public void reset();
72 }
73
Popular Tags