2 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package io.fd.hc2vpp.l3.write.ipv4.subinterface;
19 import static com.google.common.base.Preconditions.checkNotNull;
21 import io.fd.hc2vpp.common.translate.util.FutureJVppCustomizer;
22 import io.fd.hc2vpp.common.translate.util.NamingContext;
23 import io.fd.hc2vpp.l3.utils.ip.write.IpWriter;
24 import io.fd.hc2vpp.v3po.util.SubInterfaceUtils;
25 import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
26 import io.fd.honeycomb.translate.write.WriteContext;
27 import io.fd.honeycomb.translate.write.WriteFailedException;
28 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
29 import javax.annotation.Nonnull;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces._interface.sub.interfaces.SubInterface;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces._interface.sub.interfaces.SubInterfaceKey;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.Address;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.AddressKey;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.address.Subnet;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.address.subnet.Netmask;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.address.subnet.PrefixLength;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Write customizer for sub-interface {@link Address}
47 public class SubInterfaceIpv4AddressCustomizer extends FutureJVppCustomizer
48 implements ListWriterCustomizer<Address, AddressKey>, IpWriter {
50 private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceIpv4AddressCustomizer.class);
51 private final NamingContext interfaceContext;
53 public SubInterfaceIpv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
54 @Nonnull final NamingContext interfaceContext) {
55 super(futureJVppCore);
56 this.interfaceContext = checkNotNull(interfaceContext, "interface context should not be null");
60 public void writeCurrentAttributes(InstanceIdentifier<Address> id, Address dataAfter, WriteContext writeContext)
61 throws WriteFailedException {
62 setAddress(true, id, dataAfter, writeContext);
66 public void updateCurrentAttributes(InstanceIdentifier<Address> id, Address dataBefore, Address dataAfter,
67 WriteContext writeContext) throws WriteFailedException {
68 throw new WriteFailedException.UpdateFailedException(id, dataBefore, dataAfter,
69 new UnsupportedOperationException("Operation not supported"));
73 public void deleteCurrentAttributes(InstanceIdentifier<Address> id, Address dataBefore, WriteContext writeContext)
74 throws WriteFailedException {
75 setAddress(false, id, dataBefore, writeContext);
78 private void setAddress(boolean add, final InstanceIdentifier<Address> id, final Address address,
79 final WriteContext writeContext) throws WriteFailedException {
81 final String interfaceName = id.firstKeyOf(Interface.class).getName();
82 final String subInterfaceName = getSubInterfaceName(id);
83 final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, writeContext.getMappingContext());
85 Subnet subnet = address.getSubnet();
87 if (subnet instanceof PrefixLength) {
88 setPrefixLengthSubnet(add, id, interfaceName, subInterfaceIndex, address, (PrefixLength) subnet);
89 } else if (subnet instanceof Netmask) {
90 setNetmaskSubnet(add, id, interfaceName, subInterfaceIndex, address, (Netmask) subnet);
92 LOG.error("Unable to handle subnet of type {}", subnet.getClass());
93 throw new WriteFailedException(id, "Unable to handle subnet of type " + subnet.getClass());
97 private String getSubInterfaceName(@Nonnull final InstanceIdentifier<Address> id) {
98 final InterfaceKey parentInterfacekey = id.firstKeyOf(Interface.class);
99 final SubInterfaceKey subInterfacekey = id.firstKeyOf(SubInterface.class);
100 return SubInterfaceUtils
101 .getSubInterfaceName(parentInterfacekey.getName(), subInterfacekey.getIdentifier().intValue());
104 private void setNetmaskSubnet(final boolean add, @Nonnull final InstanceIdentifier<Address> id,
105 @Nonnull final String subInterfaceName, final int subInterfaceIndex,
106 @Nonnull final Address address, @Nonnull final Netmask subnet)
107 throws WriteFailedException {
109 LOG.debug("Setting Subnet(subnet-mask) for sub-interface: {}(id={}). Subnet: {}, address: {}",
110 subInterfaceName, subInterfaceIndex, subnet, address);
112 final DottedQuad netmask = subnet.getNetmask();
113 checkNotNull(netmask, "netmask value should not be null");
115 final byte subnetLength = getSubnetMaskLength(netmask.getValue());
116 addDelAddress(getFutureJVpp(), add, id, subInterfaceIndex, address.getIp(), subnetLength);
119 private void setPrefixLengthSubnet(final boolean add, @Nonnull final InstanceIdentifier<Address> id,
120 @Nonnull final String subInterfaceName, final int subInterfaceIndex,
121 @Nonnull final Address address, @Nonnull final PrefixLength subnet)
122 throws WriteFailedException {
123 LOG.debug("Setting Subnet(prefix-length) for sub-interface: {}(id={}). Subnet: {}, address: {}",
124 subInterfaceName, subInterfaceIndex, subnet, address);
126 addDelAddress(getFutureJVpp(), add, id, subInterfaceIndex, address.getIp(),
127 subnet.getPrefixLength().byteValue());
129 LOG.debug("Subnet(prefix-length) set successfully for sub-interface: {}(id={}). Subnet: {}, address: {}",
130 subInterfaceName, subInterfaceIndex, subnet, address);