KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > ve > luz > ica > jackass > solver > ComponentProxyManager


1 /*
2  * Copyright (c) 2003 by The Jackass Team
3  * Licensed under the Open Software License version 2.0
4  */

5 package ve.luz.ica.jackass.solver;
6
7 import org.omg.CORBA.Object JavaDoc;
8 /**
9  * This interface must be implemented by any class intended to be used as a manager
10  * for associations between component references, proxy references and nodes.
11  */

12 public interface ComponentProxyManager
13 {
14     /**
15      * Character(s) to be used as separator in the constituents of a Component ID.
16      * The ID of a component is the concatenation of the application name,
17      * the separator and the component name (as specified in the deployment descriptor).
18      */

19     String JavaDoc COMPONENT_ID_SEPARATOR = ":";
20
21     /**
22      * Returns all the proxies associated to a component.
23      * @param componentID the component ID.
24      * @return the proxies.
25      */

26     Object JavaDoc[] getProxies(String JavaDoc componentID);
27
28     /**
29      * Returns the proxy associated to a component in a specified node.
30      * @param node a string that identifies the node
31      * @param componentID the component ID
32      * @return the proxy
33      */

34     Object JavaDoc getProxy(String JavaDoc node, String JavaDoc componentID);
35
36     /**
37      * Adds an association between a component, a proxy and a node.
38      * @param componentID the component ID
39      * @param node a string that identifies the node
40      * @param proxy the proxy
41      */

42     void addProxyToComponent(String JavaDoc componentID, String JavaDoc node, Object JavaDoc proxy);
43
44     /**
45      * Removes all associations in which the specified node appears.
46      * @param node a string that identifies the node
47      */

48     void removeNode(String JavaDoc node);
49
50     /**
51      * Removes the specified component from the specified node. This effectively removes
52      * the proxy of the specified component in the specified node.
53      * @param componentID the component ID
54      * @param node a string that identifies the node
55      */

56     void removeNodeComponent(String JavaDoc componentID, String JavaDoc node);
57
58     /**
59      * Removes the specified component from the manager.
60      * @param componentID the ID of the component.
61      */

62     void removeComponent(String JavaDoc componentID);
63
64     /**
65      * Removes all components the belong to the specified application.
66      * @param appName the application name (as specified in the deployment descriptor.
67      */

68     void removeApplication(String JavaDoc appName);
69 }
70
Popular Tags