001: /*
002: * <copyright>
003: *
004: * Copyright 2001-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026: package org.cougaar.core.component;
027:
028: /** A base class for a BinderWrapper: A binder which is interposed between a container
029: * and another binder.
030: **/
031: public abstract class BinderWrapper extends BinderBase implements
032: ContainerAPI {
033: private Binder child;
034:
035: protected BinderWrapper(BinderFactory bf, Object childX) {
036: super (bf, childX);
037: }
038:
039: public final ComponentDescription getComponentDescription() {
040: return child == null ? null : child.getComponentDescription();
041: }
042:
043: protected void attachChild(Object cd) {
044: if (cd instanceof Binder) {
045: child = (Binder) cd;
046: } else {
047: throw new IllegalArgumentException(
048: "Child is not a Binder: " + cd);
049: }
050: }
051:
052: protected final Binder getChildBinder() {
053: return child;
054: }
055:
056: // implement ContainerAPI
057:
058: /** Defines a pass-through insulation layer to ensure that lower-level binders cannot
059: * downcast the ContainerAPI to the real BinderWrapper and gain additional
060: * privileges. The default is to implement it as a not-very secure return
061: * of the BinderWrapper itself.
062: **/
063: protected ContainerAPI getContainerProxy() {
064: return this ;
065: }
066:
067: public boolean remove(Object childComponent) {
068: return getContainer().remove(childComponent);
069: }
070:
071: public void requestStop() {
072: // ignore - this would be a request to stop the bind below, but the binder
073: // child should actually be using the remove(Object) api by this point instead.
074: }
075:
076: //
077: // child services initialization
078: //
079:
080: public void initialize() {
081: ContainerAPI proxy = getContainerProxy();
082: BindingUtility.setBindingSite(getChildBinder(), proxy);
083: if (getServiceBroker() != null) {
084: BindingUtility.setServices(getChildBinder(),
085: getServiceBroker());
086: } else {
087: throw new RuntimeException(
088: "BinderWrapper: No ServiceBroker!");
089: }
090: child.initialize();
091: }
092:
093: public void load() {
094: child.load();
095: }
096:
097: public void start() {
098: child.start();
099: }
100:
101: public void suspend() {
102: child.suspend();
103: }
104:
105: public void resume() {
106: child.resume();
107: }
108:
109: public void stop() {
110: child.stop();
111: }
112:
113: public void halt() {
114: child.halt();
115: }
116:
117: public void unload() {
118: child.unload();
119: }
120:
121: public int getModelState() {
122: return child.getModelState();
123: }
124:
125: public Object getState() {
126: return child.getState();
127: }
128:
129: public void setState(Object state) {
130: child.setState(state);
131: }
132: }
|