wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/graph/component/CheckExternallyRequiredVisitor.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 org.apache.commons.logging.Log;
  19 import org.apache.commons.logging.LogFactory;
  20
  21 import org.wamblee.system.core.SystemAssemblyException;
  22 import org.wamblee.system.graph.Edge;
  23 import org.wamblee.system.graph.Graph;
  24 import org.wamblee.system.graph.Node;
  25 import org.wamblee.system.graph.Visitor;
  26
  27 import java.util.List;
  28
  29
  30 /**
  31  * Visitor that checks whether all required external interfaces of the
  32  * container are provided.
  33  *
  34  * @author Erik Brakkee
  35  */
  36 public class CheckExternallyRequiredVisitor implements Visitor {
  37     /**
  38      * DOCUMENT ME!
  39      */
  40     private Log LOG = LogFactory.getLog(CheckExternallyRequiredVisitor.class);
  41
  42     /**
  43      * DOCUMENT ME!
  44      */
  45     private Graph graph;
  46
  47     /**
  48      * Creates a new CheckExternallyRequiredVisitor object.
  49      *
  50      * @param aGraph DOCUMENT ME!
  51      */
  52     public CheckExternallyRequiredVisitor(Graph aGraph) {
  53         graph = aGraph;
  54     }
  55
  56     /**
  57      * DOCUMENT ME!
  58      *
  59      * @param aEdge DOCUMENT ME!
  60      */
  61     @Override
  62     public void visitEdge(Edge aEdge) {
  63         // Empty.
  64     }
  65
  66     /**
  67      * DOCUMENT ME!
  68      *
  69      * @param aNode DOCUMENT ME!
  70      */
  71     @Override
  72     public void visitNode(Node aNode) {
  73         if (aNode instanceof ExternalRequiredInterfaceNode) {
  74             ExternalRequiredInterfaceNode required = (ExternalRequiredInterfaceNode) aNode;
  75
  76             if (!required.getRequired().isOptional()
  77                     && (required.getRequired().getProvider() == null)) {
  78                 throw new SystemAssemblyException(aNode
  79                     + ": External required interface is not provided");
  80             }
  81
  82             List<Edge> edges = graph.findIncoming(aNode);
  83
  84             if (edges.isEmpty()) {
  85                 LOG.warn(aNode + ": Superfluous required interface");
  86             }
  87
  88             for (Edge edge : edges) {
  89                 Node from = edge.getFrom();
  90                 assert from instanceof RequiredInterfaceNode;
  91
  92                 RequiredInterfaceNode reqNode = (RequiredInterfaceNode) from;
  93
  94                 if (!reqNode.getRequired().isOptional()
  95                         && required.getRequired().isOptional()) {
  96                     throw new SystemAssemblyException(aNode
  97                         + ": externally required interface is optional but a corresponding internal required interface is mandatory: "
  98                         + reqNode);
  99                 }
 100             }
 101         }
 102     }
 103 }