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 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeBase;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeNetdev;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathTypeSystem;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdk;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkr;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhost;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeDpdkvhostuser;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGeneve;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeGre64;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeIpsecGre64;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeLisp;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypePatch;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeStt;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeSystem;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeTap;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlan;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeVxlanGpe;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow10;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow11;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow12;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow13;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow14;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolOpenflow15;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeBase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeSecure;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbFailModeStandalone;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeBase;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeEgressPolicer;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxCodel;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxFqCodel;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHfsc;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxHtb;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.QosTypeLinuxSfq;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  51
  52 public class SouthboundConstants {
  53
  54     private SouthboundConstants() { }
  55
  56     public static final String OPEN_V_SWITCH = "Open_vSwitch";
  57     public static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
  58     public static final String OVSDB_URI_PREFIX = "ovsdb";
  59     public static final String BRIDGE_URI_PREFIX = "bridge";
  60     public static final String TP_URI_PREFIX = "terminationpoint";
  61     public static final String QOS_URI_PREFIX = "qos";
  62     public static final String QOS_NAMED_UUID_PREFIX = "QOS";
  63     public static final Integer PORT_QOS_LIST_KEY = 1;
  64     public static final String QUEUE_URI_PREFIX = "queue";
  65     public static final String QUEUE_NAMED_UUID_PREFIX = "QUEUE";
  66     public static final String AUTOATTACH_URI_PREFIX = "autoattach";
  67     public static final String AUTOATTACH_SUPPORTED_OVS_SCHEMA_VERSION = "7.11.2";
  68     public static final Integer DEFAULT_OVSDB_PORT = 6640;
  69     public static final String DEFAULT_OPENFLOW_PORT = "6653";
  70     public static final String OPENFLOW_CONNECTION_PROTOCOL = "tcp";
  71     public static final String UUID = "uuid";
  72     public static final String QOS_LINUX_HTB = "linux-htb";
  73     public static final String QOS_LINUX_HFSC = "linux-hfsc";
  74     // The following four QoS types are present in OVS 2.5+
  75     // Refer to http://openvswitch.org/support/dist-docs/ovs-vswitchd.conf.db.5.txt
  76     public static final String QOS_LINUX_SFQ = "linux-sfq";
  77     public static final String QOS_LINUX_CODEL = "linux-codel";
  78     public static final String QOS_LINUX_FQ_CODEL = "linux-fq_codel";
  79     public static final String QOS_EGRESS_POLICER = "egress-policer";
  80     public static final ImmutableBiMap<Class<? extends QosTypeBase>,String> QOS_TYPE_MAP
  81         = new ImmutableBiMap.Builder<Class<? extends QosTypeBase>,String>()
  82             .put(QosTypeLinuxHtb.class,QOS_LINUX_HTB)
  83             .put(QosTypeLinuxHfsc.class,QOS_LINUX_HFSC)
  84             .put(QosTypeLinuxSfq.class,QOS_LINUX_SFQ)
  85             .put(QosTypeLinuxCodel.class,QOS_LINUX_CODEL)
  86             .put(QosTypeLinuxFqCodel.class,QOS_LINUX_FQ_CODEL)
  87             .put(QosTypeEgressPolicer.class,QOS_EGRESS_POLICER)
  88             .build();
  89
  90     public static final ImmutableBiMap<Class<? extends OvsdbBridgeProtocolBase>,String> OVSDB_PROTOCOL_MAP
  91         = new ImmutableBiMap.Builder<Class<? extends OvsdbBridgeProtocolBase>,String>()
  92             .put(OvsdbBridgeProtocolOpenflow10.class,"OpenFlow10")
  93             .put(OvsdbBridgeProtocolOpenflow11.class,"OpenFlow11")
  94             .put(OvsdbBridgeProtocolOpenflow12.class,"OpenFlow12")
  95             .put(OvsdbBridgeProtocolOpenflow13.class,"OpenFlow13")
  96             .put(OvsdbBridgeProtocolOpenflow14.class,"OpenFlow14")
  97             .put(OvsdbBridgeProtocolOpenflow15.class,"OpenFlow15")
  98             .build();
  99
 100     public static final ImmutableBiMap<Class<? extends OvsdbFailModeBase>,String> OVSDB_FAIL_MODE_MAP
 101         = new ImmutableBiMap.Builder<Class<? extends OvsdbFailModeBase>,String>()
 102             .put(OvsdbFailModeStandalone.class,"standalone")
 103             .put(OvsdbFailModeSecure.class,"secure")
 104             .build();
 105
 106     public static final ImmutableBiMap<String, Class<? extends InterfaceTypeBase>> OVSDB_INTERFACE_TYPE_MAP
 107         = new ImmutableBiMap.Builder<String, Class<? extends InterfaceTypeBase>>()
 108             .put("internal", InterfaceTypeInternal.class)
 109             .put("vxlan", InterfaceTypeVxlan.class)
 110             .put("vxlan-gpe", InterfaceTypeVxlanGpe.class)
 111             .put("patch", InterfaceTypePatch.class)
 112             .put("system", InterfaceTypeSystem.class)
 113             .put("tap", InterfaceTypeTap.class)
 114             .put("geneve", InterfaceTypeGeneve.class)
 115             .put("gre", InterfaceTypeGre.class)
 116             .put("ipsec_gre", InterfaceTypeIpsecGre.class)
 117             .put("gre64", InterfaceTypeGre64.class)
 118             .put("ipsec_gre64", InterfaceTypeIpsecGre64.class)
 119             .put("lisp", InterfaceTypeLisp.class)
 120             .put("dpdk", InterfaceTypeDpdk.class)
 121             .put("dpdkr", InterfaceTypeDpdkr.class)
 122             .put("dpdkvhost", InterfaceTypeDpdkvhost.class)
 123             .put("dpdkvhostuser", InterfaceTypeDpdkvhostuser.class)
 124             .put("stt", InterfaceTypeStt.class)
 125             .build();
 126
 127     public static final ImmutableBiMap<Class<? extends DatapathTypeBase>,String> DATAPATH_TYPE_MAP
 128         = new ImmutableBiMap.Builder<Class<? extends DatapathTypeBase>,String>()
 129             .put(DatapathTypeSystem.class,"system")
 130             .put(DatapathTypeNetdev.class,"netdev")
 131             .build();
 132     public static final String IID_EXTERNAL_ID_KEY = "opendaylight-iid";
 133     public static final String QOS_ID_EXTERNAL_ID_KEY = "opendaylight-qos-id";
 134     public static final String QUEUE_ID_EXTERNAL_ID_KEY = "opendaylight-queue-id";
 135     public static final String AUTOATTACH_ID_EXTERNAL_ID_KEY = "opendaylight-autoattach-id";
 136
 137     public enum VlanModes {
 138         ACCESS("access"),
 139         NATIVE_TAGGED("native-tagged"),
 140         NATIVE_UNTAGGED("native-untagged"),
 141         TRUNK("trunk");
 142
 143         private final String mode;
 144
 145         VlanModes(String mode) {
 146             this.mode = mode;
 147         }
 148
 149         @Override
 150         public String toString() {
 151             return mode;
 152         }
 153
 154         public String getMode() {
 155             return this.mode;
 156         }
 157     }
 158
 159     public enum OwnershipStates {
 160         OWNER("OWNER"),
 161         NONOWNER("NON-OWNER");
 162
 163         private final String state;
 164
 165         OwnershipStates(String state) {
 166             this.state = state;
 167         }
 168
 169         @Override
 170         public String toString() {
 171             return state;
 172         }
 173
 174         public String getState() {
 175             return this.state;
 176         }
 177     }
 178 }