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.core.node;
28:
29: import org.cougaar.core.component.ComponentDescription;
30: import org.cougaar.core.component.Service;
31:
32: /**
33: * This service provides access to the initial component model
34: * {@link ComponentDescription} list, specifying which components
35: * to load into the agents.
36: */
37: public interface ComponentInitializerService extends Service {
38:
39: /**
40: * Get the descriptions of components with the named parent having
41: * an insertion point <em>below</em> the given container insertion point.
42: * <p>
43: * For example, to get items with insertion point Node.AgentManager.Agent,
44: * pass in Node.AgentManager. Then use
45: * <code>ComponentDescriptions.extractInsertionPointComponent("Node.AgentManager.Agent")</code>
46: * to get just those with the required insertion point. Typical
47: * usage however is for the Node.AgentManager component to pass in its
48: * own insertion point as a way to find its child components.
49: * <p>
50: * Note that the returned value is in whatever order the underlying
51: * implementation uses. It is <em>not</em> sorted by priority.
52: */
53: ComponentDescription[] getComponentDescriptions(String parentName,
54: String insertionPoint) throws InitializerException;
55:
56: /**
57: * @return true if the component initializer implementation includes
58: * the default components (i.e. template based, such as the XML
59: * initializer)
60: */
61: boolean includesDefaultComponents();
62:
63: /**
64: * Generic exception for component initializer failures.
65: */
66: public class InitializerException extends Exception {
67: public InitializerException(String msg, Throwable t) {
68: super(msg, t);
69: }
70: }
71: }
|