Now added support for ProvidedInterfaces in Container.
authorErik Brakkee <erik@brakkee.org>
Wed, 14 May 2008 12:10:03 +0000 (12:10 +0000)
committerErik Brakkee <erik@brakkee.org>
Wed, 14 May 2008 12:10:03 +0000 (12:10 +0000)
As a result. UserAdministrationComponent can be simplified and in general writing composite components becomes easier.

system/general/src/main/java/org/wamblee/system/core/AbstractComponent.java
system/general/src/main/java/org/wamblee/system/core/Container.java
system/general/src/test/java/org/wamblee/system/core/ContainerTest.java

index 3c6be957ff78034e49f59e02284d8653600e77f2..6567e4e74067cf13f563e5e0f7f4ab6aa4cdc4be 100644 (file)
@@ -112,12 +112,13 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
 
        @Override
        public final Type start(Scope aScope) {
-               LOG.info("Initializing '" + getQualifiedName() + "'");
+               LOG.info("Initialization starting '" + getQualifiedName() + "'");
                List<ProvidedInterface> oldRemaining = _remaining.get();
                _remaining.set(new ArrayList<ProvidedInterface>(Arrays.asList(getProvidedInterfaces())));
                try {
                        Type runtime = doStart(aScope);
                        checkNotStartedInterfaces();
+                       LOG.info("Initialization finished '" + getQualifiedName() + "'");
                        return runtime;
                } finally {
                        _remaining.set(oldRemaining);
@@ -164,8 +165,9 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
 
        @Override
        public void stop(Type aRuntime) {
-           LOG.info("Stopping '" + getQualifiedName() + "'");
+           LOG.info("Stopping initiated '" + getQualifiedName() + "'");
                doStop(aRuntime);
+               LOG.info("Stopping completed '" + getQualifiedName() + "'");
        }
 
        protected abstract void doStop(Type aRuntime);
index 1c19be341d874e10675fb465ee702b5a662845ea..d117da95462055d1bfe2a0d703cc1e4551805be2 100644 (file)
@@ -185,23 +185,42 @@ public class Container extends AbstractComponent<Scope> {
     }
 
     private void validateProvidedInterfacesArePresent() {
-        List<ProvidedInterface> provided = new ArrayList<ProvidedInterface>();
-        for (Component component : _components) {
-            provided.addAll(Arrays.asList(component.getProvidedInterfaces()));
-        }
         for (ProvidedInterface service : getProvidedInterfaces()) {
-            // TODO provided interfaces by components could be
-            // provide subclasses or implementations of the
-            // provided interfaces of the container.
-            // The code below assumes an exact match.
-            if (!(provided.contains(service))) {
-                throw new SystemAssemblyException(getQualifiedName() + ": Service '"
-                        + service
-                        + "' is not provided by any of its components");
+            findProvidedInterface(service);
+        }
+    }
+    
+    /**
+     * Finds the component and provided interface that matches a provided interface of this 
+     * container. 
+     * @param aProvided Interface to provide externally. 
+     * @return Pair of component and provided interface
+     * @throws SystemAssemblyException In case there are multiple matches or no match at all.  
+     */
+    private Pair<Component,ProvidedInterface> findProvidedInterface(ProvidedInterface aProvided) {
+        List<Pair<Component,ProvidedInterface>> result = 
+            new ArrayList<Pair<Component,ProvidedInterface>>(); 
+        for (Component component: _components) { 
+            for (ProvidedInterface provided: component.getProvidedInterfaces()) { 
+                if ( aProvided.equals(provided) ) { 
+                    result.add(new Pair<Component,ProvidedInterface>(component, provided));   
+                }
             }
         }
+        if ( result.size() == 0) { 
+            throw new SystemAssemblyException(getQualifiedName() + ": Service '"
+                    + aProvided
+                    + "' is not provided by any of its components");
+        }
+        if ( result.size() > 1) { 
+            throw new SystemAssemblyException(getQualifiedName() + ": Service '"
+                    + aProvided
+                    + "' is provided by multiple components: " + result);
+        }
+        return result.get(0);
     }
 
+    
     /**
      * Seal the container, meaning that no further components or interfaces may
      * be added.
@@ -235,10 +254,19 @@ public class Container extends AbstractComponent<Scope> {
         validate();
         Scope scope = new DefaultScope(getProvidedInterfaces(), aExternalScope);
         doStartOptionalDryRun(scope, false);
+        exposeProvidedInterfaces(aExternalScope, scope);
         seal();
         return scope;
     }
 
+    private void exposeProvidedInterfaces(Scope aExternalScope, Scope aInternalScope) {
+        for (ProvidedInterface intf: getProvidedInterfaces()) { 
+            Pair<Component, ProvidedInterface> found = findProvidedInterface(intf);
+            Object svc = aInternalScope.getInterfaceImplementation(found.getSecond(), Object.class);
+            addInterface(intf, svc, aExternalScope);
+        }
+    }
+
     private void doStartOptionalDryRun(Scope aScope, boolean aDryRun) {
         LOG.info("Starting '" + getQualifiedName() + "'");
 
index 2104e3a94e3dbba93db6d6de0c19cfe11983cf75..da8f8350918d4a6df144c4fe4f3b582c0160a35d 100644 (file)
@@ -69,30 +69,33 @@ public class ContainerTest extends TestCase {
                 Serializable.class);
         ProvidedInterface prov3 = new DefaultProvidedInterface("name",
                 MyMultiple.class);
-        
+
         Component client = new Application("client");
         Component dummy = new Application("dummy");
-        
-        InterfaceRestriction noRestriction = new InterfaceRestriction() { 
-          @Override
+
+        InterfaceRestriction noRestriction = new InterfaceRestriction() {
+            @Override
             public boolean isViolated(Component aClient,
                     RequiredInterface aRequired, Component aServer,
                     ProvidedInterface aProvided) {
                 return false;
-            }  
+            }
         };
 
         AssertionUtils.assertEquals(new ProvidedInterface[] { prov1 },
-                Container.filterProvidedServices(client, req1, 
-                        createProvidedInput(new ProvidedInterface[] { prov1 }, dummy), noRestriction));
+                Container.filterProvidedServices(client, req1,
+                        createProvidedInput(new ProvidedInterface[] { prov1 },
+                                dummy), noRestriction));
         AssertionUtils.assertEquals(new ProvidedInterface[] { prov1 },
-                Container.filterProvidedServices(client, req1, 
-                        createProvidedInput(new ProvidedInterface[] { prov1, prov2 }, dummy), noRestriction));
+                Container.filterProvidedServices(client, req1,
+                        createProvidedInput(new ProvidedInterface[] { prov1,
+                                prov2 }, dummy), noRestriction));
         AssertionUtils.assertEquals(new ProvidedInterface[] { prov1, prov3 },
-                Container.filterProvidedServices(client, req1, 
-                        createProvidedInput(new ProvidedInterface[] { prov1, prov3 }, dummy), noRestriction));
-        
-        InterfaceRestriction everything = new InterfaceRestriction() { 
+                Container.filterProvidedServices(client, req1,
+                        createProvidedInput(new ProvidedInterface[] { prov1,
+                                prov3 }, dummy), noRestriction));
+
+        InterfaceRestriction everything = new InterfaceRestriction() {
             @Override
             public boolean isViolated(Component aClient,
                     RequiredInterface aRequired, Component aServer,
@@ -100,10 +103,11 @@ public class ContainerTest extends TestCase {
                 return true;
             }
         };
-        AssertionUtils.assertEquals(new ProvidedInterface[0],
-                Container.filterProvidedServices(client, req1, 
-                        createProvidedInput(new ProvidedInterface[] { prov1, prov3 }, dummy), everything));
-        
+        AssertionUtils.assertEquals(new ProvidedInterface[0], Container
+                .filterProvidedServices(client, req1, createProvidedInput(
+                        new ProvidedInterface[] { prov1, prov3 }, dummy),
+                        everything));
+
     }
 
     public void testEnvironmentApplication() {
@@ -504,22 +508,66 @@ public class ContainerTest extends TestCase {
         assertEquals(env1.getString(), app.getString());
         assertFalse(env2.getString().equals(app.getString()));
     }
-    
-    public void testProvidedInDifferentScopes() { 
-        // Scoping problem occurred. Externally and internally provided components clashed
-        // because unique id generation in the scope was wrong. 
-        
+
+    public void testProvidedInDifferentScopes() {
+        // Scoping problem occurred. Externally and internally provided
+        // components clashed
+        // because unique id generation in the scope was wrong.
+
         StringComponent str = new StringComponent("string");
         Application app = new Application("app");
-        Container container = new Container("top").addComponent(str).addComponent(app);
-        container.addRequiredInterface(new DefaultRequiredInterface("integer", Integer.class));
-        
-        ProvidedInterface provided = new DefaultProvidedInterface("hallo", Integer.class);
-        container.getRequiredInterfaces()[0]
-                                       .setProvider(provided);
-        
+        Container container = new Container("top").addComponent(str)
+                .addComponent(app);
+        container.addRequiredInterface(new DefaultRequiredInterface("integer",
+                Integer.class));
+
+        ProvidedInterface provided = new DefaultProvidedInterface("hallo",
+                Integer.class);
+        container.getRequiredInterfaces()[0].setProvider(provided);
+
         Scope external = new DefaultScope(new ProvidedInterface[0]);
         external.publishInterface(provided, 100);
         Scope scope = container.start(external);
     }
+
+    public void testProvidedInterfaces() {
+        Environment env = new Environment(_tracker);
+        Container envcontainer = new Container("0").addComponent(env)
+                .addProvidedInterface(
+                        new DefaultProvidedInterface("string", String.class))
+                .addProvidedInterface(
+                        new DefaultProvidedInterface("integer", Integer.class));
+        Scope scope = envcontainer.start();
+
+        AssertionUtils.assertEquals(new String[] { "start.environment" },
+                _tracker.getEvents(Thread.currentThread()).toArray(
+                        new String[0]));
+
+        envcontainer.stop(scope);
+    }
+
+    public void testCoupleTwoContainers() {
+        Environment env = new Environment(_tracker);
+        Container envcontainer = new Container("0").addComponent(env)
+                .addProvidedInterface(
+                        new DefaultProvidedInterface("string", String.class))
+                .addProvidedInterface(
+                        new DefaultProvidedInterface("integer", Integer.class));
+
+        Application app = new Application(_tracker);
+        Container appcontainer = new Container("1").addComponent(app)
+                .addRequiredInterface(
+                        new DefaultRequiredInterface("string", String.class))
+                .addRequiredInterface(
+                        new DefaultRequiredInterface("integer", Integer.class));
+
+        Container top = new Container("top");
+        top.addComponent(envcontainer).addComponent(appcontainer);
+
+        top.start();
+        AssertionUtils.assertEquals(new String[] { "start.environment", "start.application" },
+                _tracker.getEvents(Thread.currentThread()).toArray(
+                        new String[0]));
+
+    }
 }