southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/SouthboundConstants.java

   1 /*
   2  * Copyright (c) 2015 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.ovsdb.southbound;
   9
  10 import com.google.common.collect.ImmutableBiMap;
  11 import com.google.common.collect.ImmutableMap;
  12 import java.util.ArrayList;
  13 import java.util.Arrays;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow10;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow11;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow12;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow13;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow14;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow15;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeBase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeSecure;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeStandalone;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.QosEntryKey;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  30 import org.opendaylight.yangtools.yang.common.Uint32;
  31
  32 public final class SouthboundConstants {
  33     public enum VlanModes {
  34         ACCESS("access"),
  35         NATIVE_TAGGED("native-tagged"),
  36         NATIVE_UNTAGGED("native-untagged"),
  37         TRUNK("trunk");
  38
  39         private final String mode;
  40
  41         VlanModes(final String mode) {
  42             this.mode = mode;
  43         }
  44
  45         @Override
  46         public String toString() {
  47             return mode;
  48         }
  49
  50         public String getMode() {
  51             return mode;
  52         }
  53     }
  54
  55     public static final String OPEN_V_SWITCH = "Open_vSwitch";
  56     public static final @NonNull TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
  57     public static final String OVSDB_URI_PREFIX = "ovsdb";
  58     public static final String BRIDGE_URI_PREFIX = "bridge";
  59     public static final String TP_URI_PREFIX = "terminationpoint";
  60     public static final String QOS_URI_PREFIX = "qos";
  61     public static final String QOS_NAMED_UUID_PREFIX = "QOS";
  62     public static final @NonNull QosEntryKey PORT_QOS_LIST_KEY = new QosEntryKey(Uint32.ONE);
  63     public static final String QUEUE_URI_PREFIX = "queue";
  64     public static final String QUEUE_NAMED_UUID_PREFIX = "QUEUE";
  65     public static final String AUTOATTACH_URI_PREFIX = "autoattach";
  66     public static final String AUTOATTACH_SUPPORTED_OVS_SCHEMA_VERSION = "7.11.2";
  67     public static final Integer DEFAULT_OVSDB_PORT = 6640;
  68     public static final String DEFAULT_OPENFLOW_PORT = "6653";
  69     public static final String OPENFLOW_CONNECTION_PROTOCOL = "tcp";
  70     public static final String UUID = "uuid";
  71     public static final String QOS_LINUX_HTB = "linux-htb";
  72     public static final String QOS_LINUX_HFSC = "linux-hfsc";
  73     // The following four QoS types are present in OVS 2.5+
  74     // Refer to http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.txt
  75     public static final String QOS_LINUX_SFQ = "linux-sfq";
  76     public static final String QOS_LINUX_CODEL = "linux-codel";
  77     public static final String QOS_LINUX_FQ_CODEL = "linux-fq_codel";
  78     public static final String QOS_EGRESS_POLICER = "egress-policer";
  79     public static final String URI_SEPERATOR = "/";
  80     public static final String CREATED_BY = "created_by";
  81     public static final String ODL = "odl";
  82
  83     public static final ImmutableBiMap<Class<? extends OvsdbBridgeProtocolBase>, String> OVSDB_PROTOCOL_MAP =
  84         ImmutableBiMap.<Class<? extends OvsdbBridgeProtocolBase>, String>builder()
  85             .put(OvsdbBridgeProtocolOpenflow10.class, "OpenFlow10")
  86             .put(OvsdbBridgeProtocolOpenflow11.class, "OpenFlow11")
  87             .put(OvsdbBridgeProtocolOpenflow12.class, "OpenFlow12")
  88             .put(OvsdbBridgeProtocolOpenflow13.class, "OpenFlow13")
  89             .put(OvsdbBridgeProtocolOpenflow14.class, "OpenFlow14")
  90             .put(OvsdbBridgeProtocolOpenflow15.class, "OpenFlow15")
  91             .build();
  92
  93     public static final ImmutableBiMap<Class<? extends OvsdbFailModeBase>, String> OVSDB_FAIL_MODE_MAP =
  94         ImmutableBiMap.of(
  95             OvsdbFailModeStandalone.class, "standalone",
  96             OvsdbFailModeSecure.class,     "secure");
  97
  98     public static final String IID_EXTERNAL_ID_KEY = "opendaylight-iid";
  99     public static final String QOS_ID_EXTERNAL_ID_KEY = "opendaylight-qos-id";
 100     public static final String QUEUE_ID_EXTERNAL_ID_KEY = "opendaylight-queue-id";
 101     public static final String AUTOATTACH_ID_EXTERNAL_ID_KEY = "opendaylight-autoattach-id";
 102
 103     // Note: _version is an internal column of ovsdb schema, that gets updated with every change in the row
 104     //       of the table.
 105     //       The "Manager" entry needs to be a modifiable list, SouthboundProvider::setSkipManagerStatus() modifies it
 106     static final ImmutableMap<String, List<String>> SKIP_COLUMN_FROM_TABLE =
 107         ImmutableMap.<String,List<String>>builder()
 108             .put("Open_vSwitch", Arrays.asList("statistics","_version"))
 109             .put("Port", Arrays.asList("statistics","_version"))
 110             .put("Manager", new ArrayList<>(Collections.singletonList("_version")))
 111             .put("SSL", Collections.singletonList("_version"))
 112             .put("QoS", Collections.singletonList("_version"))
 113             .put("Queue", Collections.singletonList("_version"))
 114             .put("Bridge", Collections.singletonList("_version"))
 115             .put("Interface", Arrays.asList("statistics","_version"))
 116             .put("Controller", Arrays.asList("status","_version"))
 117             .build();
 118
 119     private SouthboundConstants() {
 120         // Hidden on purpose
 121     }
 122 }