renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/commands/LoopbackCommand.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems. 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
   9 package org.opendaylight.groupbasedpolicy.renderer.vpp.commands;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Strings;
  13 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.General.Operations;
  14 import org.opendaylight.groupbasedpolicy.util.NetUtils;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1Builder;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4Builder;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.subnet.PrefixLengthBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang._interface.nat.rev161214.NatInterfaceAugmentation;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang._interface.nat.rev161214.NatInterfaceAugmentationBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang._interface.nat.rev161214._interface.nat.attributes.NatBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang._interface.nat.rev161214._interface.nat.attributes.nat.InboundBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.Loopback;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.VppInterfaceAugmentation;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.VppInterfaceAugmentationBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.interfaces._interface.L2Builder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.interfaces._interface.LoopbackBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.interfaces._interface.RoutingBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.l2.base.attributes.interconnection.BridgeBasedBuilder;
  38
  39 import java.util.Collections;
  40
  41 public class LoopbackCommand extends AbstractInterfaceCommand {
  42
  43     private PhysAddress physAddress;
  44     private boolean bvi;
  45     private IpAddress ipAddress;
  46     private IpPrefix ipPrefix;
  47     private Long vrfId;
  48
  49     private LoopbackCommand(LoopbackCommandBuilder builder) {
  50         this.name = builder.getInterfaceName();
  51         this.operation = builder.getOperation();
  52         this.physAddress = builder.getPhysAddress();
  53         this.enabled = builder.isEnabled();
  54         this.description = builder.getDescription();
  55         this.bridgeDomain = builder.getBridgeDomain();
  56         this.bvi = builder.isBvi();
  57         this.ipAddress = builder.getIpAddress();
  58         this.ipPrefix = builder.getIpPrefix();
  59         this.vrfId = builder.getVrfId();
  60     }
  61
  62     public static LoopbackCommandBuilder builder() {
  63         return new LoopbackCommandBuilder();
  64     }
  65
  66     PhysAddress getPhysAddress() {
  67         return physAddress;
  68     }
  69
  70     public boolean getBvi() {
  71         return bvi;
  72     }
  73
  74     IpAddress getIpAddress() {
  75         return ipAddress;
  76     }
  77
  78     IpPrefix getIpPrefix() {
  79         return ipPrefix;
  80     }
  81
  82     Long getVrfId() {
  83         return vrfId;
  84     }
  85
  86     @Override
  87     public InterfaceBuilder getInterfaceBuilder() {
  88         InterfaceBuilder interfaceBuilder = new InterfaceBuilder().setKey(new InterfaceKey(name))
  89                 .setEnabled(enabled)
  90                 .setDescription(description)
  91                 .setType(Loopback.class)
  92                 .setName(name)
  93                 .setLinkUpDownTrapEnable(Interface.LinkUpDownTrapEnable.Enabled)
  94                 .addAugmentation(NatInterfaceAugmentation.class, buildInboundNatAugmentation());
  95
  96         // Create the Loopback augmentation
  97         VppInterfaceAugmentationBuilder
  98                 vppAugmentationBuilder =
  99                 new VppInterfaceAugmentationBuilder().setLoopback(new LoopbackBuilder().setMac(this.physAddress).build());
 100
 101         if (getVrfId() != null) {
 102             vppAugmentationBuilder.setRouting(new RoutingBuilder().setIpv4VrfId(getVrfId()).build());
 103         }
 104
 105         if (!Strings.isNullOrEmpty(bridgeDomain)) {
 106             vppAugmentationBuilder.setL2(new L2Builder().setInterconnection(
 107                     new BridgeBasedBuilder().setBridgeDomain(bridgeDomain).setBridgedVirtualInterface(bvi).build())
 108                     .build());
 109         }
 110         Interface1Builder
 111                 interface1Builder =
 112                 new Interface1Builder().setIpv4(new Ipv4Builder().setAddress(Collections.singletonList(
 113                         new AddressBuilder().setIp(new Ipv4AddressNoZone(this.ipAddress.getIpv4Address()))
 114                                 .setSubnet(new PrefixLengthBuilder().setPrefixLength(this.getPrefixLength()).build())
 115                                 .build())).build());
 116         interfaceBuilder.addAugmentation(Interface1.class, interface1Builder.build());
 117         interfaceBuilder.addAugmentation(VppInterfaceAugmentation.class, vppAugmentationBuilder.build());
 118         return interfaceBuilder;
 119     }
 120
 121     private NatInterfaceAugmentation buildInboundNatAugmentation() {
 122         return new NatInterfaceAugmentationBuilder().setNat(
 123                 new NatBuilder().setInbound(new InboundBuilder().build()).build()).build();
 124     }
 125
 126     @Override
 127     public String toString() {
 128         return "LoopPortUserCommand [physAddress=" + physAddress + ", IpAddress=" + ipAddress + ", IpPrefix=" + ipPrefix
 129                 + ", bridgeDomain=" + bridgeDomain + ", operations=" + operation + ", name=" + name + ", description="
 130                 + description + ", enabled=" + enabled + ", bvi=" + bvi + "]";
 131     }
 132
 133     private short getPrefixLength() {
 134         return (short) NetUtils.getMaskFromPrefix(this.ipPrefix.getIpv4Prefix().getValue());
 135     }
 136
 137     public static class LoopbackCommandBuilder {
 138
 139         private String interfaceName;
 140         private Operations operation;
 141         private PhysAddress physAddress;
 142         private String bridgeDomain;
 143         private String description;
 144         private boolean bvi = false;
 145         private boolean enabled = true;
 146         private IpAddress ipAddress;
 147         private IpPrefix ipPrefix;
 148         private Long vrfId;
 149
 150         String getInterfaceName() {
 151             return interfaceName;
 152         }
 153
 154         public LoopbackCommandBuilder setInterfaceName(String interfaceName) {
 155             this.interfaceName = interfaceName;
 156             return this;
 157         }
 158
 159         public Operations getOperation() {
 160             return operation;
 161         }
 162
 163         public LoopbackCommandBuilder setOperation(Operations operation) {
 164             this.operation = operation;
 165             return this;
 166         }
 167
 168         PhysAddress getPhysAddress() {
 169             return physAddress;
 170         }
 171
 172         public LoopbackCommandBuilder setPhysAddress(PhysAddress physAddress) {
 173             this.physAddress = physAddress;
 174             return this;
 175         }
 176
 177         String getBridgeDomain() {
 178             return bridgeDomain;
 179         }
 180
 181         LoopbackCommandBuilder setBridgeDomain(String bridgeDomain) {
 182             this.bridgeDomain = bridgeDomain;
 183             return this;
 184         }
 185
 186         public String getDescription() {
 187             return description;
 188         }
 189
 190         public LoopbackCommandBuilder setDescription(String description) {
 191             this.description = description;
 192             return this;
 193         }
 194
 195         boolean isEnabled() {
 196             return enabled;
 197         }
 198
 199         LoopbackCommandBuilder setEnabled(boolean enabled) {
 200             this.enabled = enabled;
 201             return this;
 202         }
 203
 204         IpAddress getIpAddress() {
 205             return ipAddress;
 206         }
 207
 208         public LoopbackCommandBuilder setIpAddress(IpAddress ipAddress) {
 209             this.ipAddress = ipAddress;
 210             return this;
 211         }
 212
 213         IpPrefix getIpPrefix() {
 214             return ipPrefix;
 215         }
 216
 217         public LoopbackCommandBuilder setIpPrefix(IpPrefix ipPrefix) {
 218             this.ipPrefix = ipPrefix;
 219             return this;
 220         }
 221
 222         public boolean isBvi() {
 223             return bvi;
 224         }
 225
 226         public LoopbackCommandBuilder setBvi(boolean bvi) {
 227             this.bvi = bvi;
 228             return this;
 229         }
 230
 231         Long getVrfId() {
 232             return vrfId;
 233         }
 234
 235         public LoopbackCommandBuilder setVrfId(Long vrfId) {
 236             this.vrfId = vrfId;
 237             return this;
 238         }
 239
 240         /**
 241          * LoopPortCommand build method.
 242          *
 243          * @return LoopPortCommand
 244          * @throws IllegalArgumentException if interfaceName or operation is null.
 245          */
 246         public LoopbackCommand build() {
 247             Preconditions.checkArgument(this.interfaceName != null);
 248             Preconditions.checkArgument(this.operation != null);
 249
 250             return new LoopbackCommand(this);
 251         }
 252     }
 253 }