wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/graph/component/CheckRequiredProvidedMultiplicityVisitor.java

   1 /*
   2  * Copyright 2008 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.system.graph.component;
  17
  18 import java.util.List;
  19
  20 import org.wamblee.system.core.SystemAssemblyException;
  21 import org.wamblee.system.graph.Edge;
  22 import org.wamblee.system.graph.Graph;
  23 import org.wamblee.system.graph.Node;
  24 import org.wamblee.system.graph.Visitor;
  25
  26 /**
  27  * Visitor that checks whether required and provided interfaces are matched
  28  * appropriately:
  29  * <ul>
  30  * <li>Each required interface is connected to at most one provided interface
  31  * </li>
  32  * <li>Required interfaces that are not optional must be connected to precisely
  33  * one provided interface</li>
  34  * </ul>
  35  *
  36  * @author Erik Brakkee
  37  *
  38  */
  39 public class CheckRequiredProvidedMultiplicityVisitor implements Visitor {
  40
  41     private Graph graph;
  42
  43     public CheckRequiredProvidedMultiplicityVisitor(Graph aGraph) {
  44         graph = aGraph;
  45     }
  46
  47     @Override
  48     public void visitEdge(Edge aEdge) {
  49         // Empty
  50     }
  51
  52     @Override
  53     public void visitNode(Node aNode) {
  54         if (aNode instanceof RequiredInterfaceNode) {
  55             RequiredInterfaceNode required = (RequiredInterfaceNode) aNode;
  56             List<Edge> edges = graph.findOutgoing(aNode);
  57             if (edges.size() > 1) {
  58                 createDuplicateException("Multiple providers of required interface found", aNode, edges);
  59             }
  60             if (edges.size() == 0 && !required.getRequired().isOptional()) {
  61                 throw new SystemAssemblyException(
  62                         aNode
  63                                 + ": mandatpory required interface not provided by other components started earlier");
  64             }
  65         } else if ( aNode instanceof ExternalProvidedInterfaceNode) {
  66             List<Edge> edges = graph.findOutgoing(aNode);
  67             if ( edges.size() > 1) {
  68                 createDuplicateException("multiple internal matches for externally provided interface", aNode, edges);
  69             }
  70             if ( edges.size() == 0 ) {
  71                 throw new SystemAssemblyException(aNode + ": external provided interface is not provided internally");
  72             }
  73         }
  74     }
  75
  76     private void createDuplicateException(String aMsg, Node aNode, List<Edge> edges) {
  77         StringBuffer buf = new StringBuffer();
  78         buf.append(aNode
  79                 + ": " + aMsg + ": ");
  80         for (Edge edge : edges) {
  81             buf.append(edge.getTo() + "/ ");
  82         }
  83         throw new SystemAssemblyException(buf.toString());
  84     }
  85
  86 }