opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/utils/NodeConnectorCreator.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.sal.utils;
  11
  12 import java.util.HashSet;
  13 import java.util.Set;
  14
  15 import org.opendaylight.controller.sal.core.ConstructionException;
  16 import org.opendaylight.controller.sal.core.Node;
  17 import org.opendaylight.controller.sal.core.NodeConnector;
  18 import org.opendaylight.controller.sal.core.Node.NodeIDType;
  19 import org.opendaylight.controller.sal.core.NodeConnector.NodeConnectorIDType;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22
  23 /**
  24  * The class provides helper functions to create a node connector
  25  *
  26  *
  27  */
  28 public abstract class NodeConnectorCreator {
  29     protected static final Logger logger = LoggerFactory
  30     .getLogger(NodeConnectorCreator.class);
  31     /**
  32      * Generic NodeConnector creator
  33      * The nodeConnector type is inferred from the node type
  34      *
  35      * @param portId
  36      * @param node
  37      * @return
  38      */
  39     public static NodeConnector createNodeConnector(Object portId, Node node) {
  40         if (node.getType().equals(NodeIDType.OPENFLOW)) {
  41             try {
  42                 return new NodeConnector(NodeConnectorIDType.OPENFLOW,
  43                         portId, node);
  44             } catch (ConstructionException e1) {
  45                 logger.error("",e1);
  46                 return null;
  47             }
  48         }
  49         return null;
  50     }
  51
  52     /**
  53      * Generic NodeConnector creator
  54      * The nodeConnector type is inferred from the node type
  55      *
  56      * @param portId The string representing the port id
  57      * @param node The network node as {@link org.opendaylight.controller.sal.core.Node Node} object
  58      * @return The corresponding {@link org.opendaylight.controller.sal.core.NodeConnector NodeConnector} object
  59      */
  60     public static NodeConnector createNodeConnector(String portId, Node node) {
  61         return NodeConnector.fromString(String.format("%s|%s@%s", node.getType(), portId, node.toString()));
  62     }
  63
  64     /**
  65      * NodeConnector creator where NodeConnector type can be specified
  66      * Needed to create special internal node connectors (like software stack)
  67      *
  68      * @param nodeConnectorType
  69      * @param portId
  70      * @param node
  71      * @return
  72      */
  73     public static NodeConnector createNodeConnector(
  74             String nodeConnectorType, Object portId, Node node) {
  75         try {
  76             return new NodeConnector(nodeConnectorType, portId, node);
  77         } catch (ConstructionException e1) {
  78             logger.error("",e1);
  79             return null;
  80         }
  81     }
  82
  83     public static NodeConnector createOFNodeConnector(Short portId, Node node) {
  84         try {
  85             return new NodeConnector(NodeConnectorIDType.OPENFLOW, portId, node);
  86         } catch (ConstructionException e1) {
  87             logger.error("",e1);
  88             return null;
  89         }
  90     }
  91
  92     public static Set<NodeConnector> createOFNodeConnectorSet(
  93             Set<Short> portIds, Node n) {
  94         try {
  95             Set<NodeConnector> nodeConnectors = new HashSet<NodeConnector>();
  96             for (Short ofPortID : portIds) {
  97                 NodeConnector p = new NodeConnector(
  98                         NodeConnector.NodeConnectorIDType.OPENFLOW, Short
  99                                 .valueOf(ofPortID), n);
 100                 nodeConnectors.add(p);
 101             }
 102             return nodeConnectors;
 103         } catch (ConstructionException e1) {
 104             logger.error("",e1);
 105             return null;
 106         }
 107     }
 108 }