v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/ip/SubInterfaceIpv4AddressCustomizer.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 package io.fd.honeycomb.translate.v3po.interfacesstate.ip;
  18
  19 import static com.google.common.base.Preconditions.checkNotNull;
  20
  21 import com.google.common.base.Optional;
  22 import com.google.common.collect.ImmutableSet;
  23 import io.fd.honeycomb.translate.read.ReadContext;
  24 import io.fd.honeycomb.translate.read.ReadFailedException;
  25 import io.fd.honeycomb.translate.spi.read.Initialized;
  26 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  27 import io.fd.honeycomb.translate.util.RWUtils;
  28 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  29 import io.fd.honeycomb.translate.util.read.cache.IdentifierCacheKeyFactory;
  30 import io.fd.honeycomb.translate.v3po.interfacesstate.SubInterfaceCustomizer;
  31 import io.fd.honeycomb.translate.v3po.interfacesstate.ip.dump.params.AddressDumpParams;
  32 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  33 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  34 import io.fd.honeycomb.translate.vpp.util.SubInterfaceUtils;
  35 import io.fd.vpp.jvpp.core.dto.IpAddressDetails;
  36 import io.fd.vpp.jvpp.core.dto.IpAddressDetailsReplyDump;
  37 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  38 import java.util.List;
  39 import javax.annotation.Nonnull;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces.state._interface.sub.interfaces.SubInterface;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.Ipv4;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.Ipv4Builder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.Address;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.AddressBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.AddressKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.ip4.attributes.ipv4.address.subnet.PrefixLengthBuilder;
  48 import org.opendaylight.yangtools.concepts.Builder;
  49 import org.opendaylight.yangtools.yang.binding.DataObject;
  50 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 /**
  55  * Read customizer for sub-interface Ipv4 addresses.
  56  */
  57 public class SubInterfaceIpv4AddressCustomizer extends FutureJVppCustomizer
  58         implements InitializingListReaderCustomizer<Address, AddressKey, AddressBuilder>, Ipv4Reader {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceIpv4AddressCustomizer.class);
  61
  62     private final NamingContext interfaceContext;
  63     private final DumpCacheManager<IpAddressDetailsReplyDump, AddressDumpParams> dumpManager;
  64
  65     public SubInterfaceIpv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
  66                                              @Nonnull final NamingContext interfaceContext) {
  67         super(futureJVppCore);
  68         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
  69         this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<IpAddressDetailsReplyDump, AddressDumpParams>()
  70                 .withExecutor(createExecutor(futureJVppCore))
  71                 //same as with ipv4 addresses for interfaces, these must have cache scope of their parent sub-interface
  72                 .withCacheKeyFactory(new IdentifierCacheKeyFactory(ImmutableSet.of(SubInterface.class)))
  73                 .build();
  74     }
  75
  76     @Override
  77     @Nonnull
  78     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
  79         return new AddressBuilder();
  80     }
  81
  82     @Override
  83     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
  84                                       @Nonnull ReadContext ctx)
  85             throws ReadFailedException {
  86         LOG.debug("Reading attributes for sub-interface address: {}", id);
  87
  88         final String subInterfaceName = getSubInterfaceName(id);
  89         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
  90         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
  91                 .getDump(id, ctx.getModificationCache(), new AddressDumpParams(subInterfaceIndex, false));
  92
  93         final Optional<IpAddressDetails> ipAddressDetails =
  94                 findIpAddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
  95
  96         if (ipAddressDetails.isPresent()) {
  97             final IpAddressDetails detail = ipAddressDetails.get();
  98             builder.setIp(arrayToIpv4AddressNoZone(detail.ip));
  99             builder.setSubnet(new PrefixLengthBuilder().setPrefixLength(Short.valueOf(detail.prefixLength)).build());
 100
 101             if (LOG.isDebugEnabled()) {
 102                 LOG.debug("Attributes for {} sub-interface (id={}) address {} successfully read: {}",
 103                         subInterfaceName, subInterfaceIndex, id, builder.build());
 104             }
 105         }
 106     }
 107
 108     @Override
 109     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
 110             throws ReadFailedException {
 111         LOG.debug("Reading list of keys for sub-interface addresses: {}", id);
 112
 113         final String subInterfaceName = getSubInterfaceName(id);
 114         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
 115         final Optional<IpAddressDetailsReplyDump> dumpOptional = dumpManager
 116                 .getDump(id, ctx.getModificationCache(), new AddressDumpParams(subInterfaceIndex, false));
 117
 118         return getAllIpv4AddressIds(dumpOptional, AddressKey::new);
 119     }
 120
 121     @Override
 122     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
 123         ((Ipv4Builder) builder).setAddress(readData);
 124     }
 125
 126     private static String getSubInterfaceName(@Nonnull final InstanceIdentifier<Address> id) {
 127         return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
 128                 Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
 129     }
 130
 131     @Override
 132     public Initialized<Address> init(
 133             @Nonnull final InstanceIdentifier<Address> id, @Nonnull final Address readValue,
 134             @Nonnull final ReadContext ctx) {
 135         return Initialized.create(getCfgId(id), readValue);
 136     }
 137
 138     private InstanceIdentifier<Address> getCfgId(final InstanceIdentifier<Address> id) {
 139         return SubInterfaceCustomizer.getCfgId(RWUtils.cutId(id, SubInterface.class))
 140                 .child(Ipv4.class)
 141                 .child(Address.class, new AddressKey(id.firstKeyOf(Address.class)));
 142     }
 143 }