openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/util/MessageFactory.java

   1 /**
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.impl.util;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.List;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.HelloElementType;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloInput;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloInputBuilder;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.Elements;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.hello.ElementsBuilder;
  18
  19 public abstract class MessageFactory {
  20
  21     /**
  22      * @param helloVersion openflow version for hello message to send to switch
  23      * @param helloXid     transaction id for hello message
  24      * @return HelloInput without elements
  25      */
  26     public static HelloInput createHelloInput(short helloVersion, long helloXid) {
  27         return createHelloInput(helloVersion, helloXid, null);
  28     }
  29
  30     /**
  31      * @param highestVersion highest openflow version
  32      * @param xid            transaction id
  33      * @return builder with prepared header
  34      */
  35     private static HelloInputBuilder prepareHelloInputBuilder(
  36             short highestVersion, long xid) {
  37         HelloInputBuilder helloInputbuilder = new HelloInputBuilder();
  38         helloInputbuilder.setVersion(highestVersion);
  39         helloInputbuilder.setXid(xid);
  40         return helloInputbuilder;
  41     }
  42
  43     /**
  44      * @param helloVersion openflow version for hello message to send to switch
  45      * @param helloXid     transaction id for hello message
  46      * @param versionOrder list of openflow version in order
  47      * @return HelloInput with elements (version bitmap)
  48      */
  49     public static HelloInput createHelloInput(short helloVersion, long helloXid, List<Short> versionOrder) {
  50         HelloInputBuilder helloInputbuilder = prepareHelloInputBuilder(helloVersion, helloXid);
  51         if (versionOrder != null) {
  52
  53             ElementsBuilder elementsBuilder = new ElementsBuilder();
  54             elementsBuilder.setType(HelloElementType.VERSIONBITMAP);
  55             int resultVersionListSize = 0;
  56             if (!versionOrder.isEmpty()) {
  57                 resultVersionListSize = versionOrder.get(0) + 1;
  58             }
  59             List<Boolean> booleanList = new ArrayList<>(resultVersionListSize);
  60
  61             int versionOrderIndex = versionOrder.size() - 1;
  62
  63             while (versionOrderIndex >= 0) {
  64                 short version = versionOrder.get(versionOrderIndex);
  65                 if (version == booleanList.size()) {
  66                     booleanList.add(true);
  67                     versionOrderIndex--;
  68                 } else {
  69                     booleanList.add(false);
  70                 }
  71             }
  72
  73             elementsBuilder.setVersionBitmap(booleanList);
  74
  75             List<Elements> elementList = Collections.singletonList(elementsBuilder.build());
  76             helloInputbuilder.setElements(elementList);
  77         }
  78         return helloInputbuilder.build();
  79     }
  80
  81     /**
  82      * @param elements list of versions
  83      * @return version boolean list
  84      */
  85     public static List<Boolean> digVersions(List<Elements> elements) {
  86         List<Boolean> result = null;
  87         if (elements != null && !elements.isEmpty()) {
  88             for (Elements elm : elements) {
  89                 if (HelloElementType.VERSIONBITMAP.equals(elm.getType())) {
  90                     result = elm.getVersionBitmap();
  91                 }
  92             }
  93         }
  94         return result;
  95     }
  96 }