01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */package org.apache.geronimo.kernel;
17:
18: import org.apache.geronimo.gbean.AbstractName;
19:
20: import java.util.Set;
21:
22: /**
23: * DependencyManager is the record keeper of the dependencies in Geronimo. The DependencyManager
24: * does not enforce any dependencies, it is simply a place where components can register their intent
25: * to be dependent on another component.
26: * <p/>
27: * The DependencyManager uses the nomenclature of parent-child where a child is dependent on a parent.
28: * The names parent and child have no other meaning are just a convience to make the code readable.
29: *
30: * @version $Rev: 476049 $ $Date: 2006-11-16 20:35:17 -0800 (Thu, 16 Nov 2006) $
31: */
32: public interface DependencyManager {
33: /**
34: * Closes the dependency manager releasing all resources
35: */
36: public void close();
37:
38: /**
39: * Declares a dependency from a child to a parent.
40: *
41: * @param child the dependent component
42: * @param parent the component the child is depending on
43: */
44: public void addDependency(AbstractName child, AbstractName parent);
45:
46: /**
47: * Removes a dependency from a child to a parent
48: *
49: * @param child the dependnet component
50: * @param parent the component that the child wil no longer depend on
51: */
52: public void removeDependency(AbstractName child, AbstractName parent);
53:
54: /**
55: * Removes all dependencies for a child
56: *
57: * @param child the component that will no longer depend on anything
58: */
59: public void removeAllDependencies(AbstractName child);
60:
61: /**
62: * Adds dependencies from the child to every parent in the parents set
63: *
64: * @param child the dependent component
65: * @param parents the set of components the child is depending on
66: */
67: public void addDependencies(AbstractName child, Set parents);
68:
69: /**
70: * Gets the set of parents that the child is depending on
71: *
72: * @param child the dependent component
73: * @return a collection containing all of the components the child depends on; will never be null
74: */
75: public Set getParents(AbstractName child);
76:
77: /**
78: * Gets all of the MBeans that have a dependency on the specified startParent.
79: *
80: * @param parent the component the returned childen set depend on
81: * @return a collection containing all of the components that depend on the parent; will never be null
82: */
83: public Set getChildren(AbstractName parent);
84:
85: }
|