v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/ip/Ipv4AddressCustomizer.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 com.google.common.base.Preconditions;
  24 import io.fd.honeycomb.translate.read.ReadContext;
  25 import io.fd.honeycomb.translate.read.ReadFailedException;
  26 import io.fd.honeycomb.translate.spi.read.Initialized;
  27 import io.fd.honeycomb.translate.spi.read.InitializingListReaderCustomizer;
  28 import io.fd.honeycomb.translate.util.RWUtils;
  29 import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
  30 import io.fd.honeycomb.translate.util.read.cache.IdentifierCacheKeyFactory;
  31 import io.fd.honeycomb.translate.v3po.interfacesstate.InterfaceCustomizer;
  32 import io.fd.honeycomb.translate.v3po.interfacesstate.ip.dump.params.AddressDumpParams;
  33 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  34 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  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.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.Subnet;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4Builder;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressKey;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLengthBuilder;
  49 import org.opendaylight.yangtools.concepts.Builder;
  50 import org.opendaylight.yangtools.yang.binding.DataObject;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * Read customizer for interface Ipv4 addresses.
  57  */
  58 public class Ipv4AddressCustomizer extends FutureJVppCustomizer
  59         implements InitializingListReaderCustomizer<Address, AddressKey, AddressBuilder>, Ipv4Reader {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(Ipv4AddressCustomizer.class);
  62     private static final String CACHE_KEY = Ipv4AddressCustomizer.class.getName();
  63
  64     private final NamingContext interfaceContext;
  65     private final DumpCacheManager<IpAddressDetailsReplyDump, AddressDumpParams> dumpManager;
  66
  67     public Ipv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
  68                                  @Nonnull final NamingContext interfaceContext) {
  69         super(futureJVppCore);
  70         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
  71         this.dumpManager =
  72                 new DumpCacheManager.DumpCacheManagerBuilder<IpAddressDetailsReplyDump, AddressDumpParams>()
  73                         .withExecutor(createExecutor(futureJVppCore))
  74                         // Key needs to contain interface ID to distinguish dumps between interfaces
  75                         .withCacheKeyFactory(new IdentifierCacheKeyFactory(ImmutableSet.of(Interface.class)))
  76                         .build();
  77     }
  78
  79     @Override
  80     @Nonnull
  81     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
  82         return new AddressBuilder();
  83     }
  84
  85     @Override
  86     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
  87                                       @Nonnull ReadContext ctx)
  88             throws ReadFailedException {
  89         LOG.debug("Reading attributes for interface address: {}", id);
  90
  91         final String interfaceName = id.firstKeyOf(Interface.class).getName();
  92         final int interfaceIndex = interfaceContext.getIndex(interfaceName, ctx.getMappingContext());
  93         final Optional<IpAddressDetailsReplyDump> dumpOptional =
  94                 dumpManager.getDump(id, ctx.getModificationCache(), new AddressDumpParams(interfaceIndex, false));
  95
  96         if (!dumpOptional.isPresent() || dumpOptional.get().ipAddressDetails.isEmpty()) {
  97             return;
  98         }
  99         final Optional<IpAddressDetails> ipAddressDetails =
 100                 findIpAddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
 101
 102         if (ipAddressDetails.isPresent()) {
 103             final IpAddressDetails detail = ipAddressDetails.get();
 104             builder.setIp(arrayToIpv4AddressNoZone(detail.ip))
 105                     .setSubnet(
 106                             new PrefixLengthBuilder().setPrefixLength(Short.valueOf(detail.prefixLength)).build());
 107
 108             if (LOG.isDebugEnabled()) {
 109                 LOG.debug("Attributes for {} interface (id={}) address {} successfully read: {}",
 110                         interfaceName, interfaceIndex, id, builder.build());
 111             }
 112         }
 113     }
 114
 115     @Override
 116     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
 117             throws ReadFailedException {
 118         LOG.debug("Reading list of keys for interface addresses: {}", id);
 119
 120         final String interfaceName = id.firstKeyOf(Interface.class).getName();
 121         final int interfaceIndex = interfaceContext.getIndex(interfaceName, ctx.getMappingContext());
 122         final Optional<IpAddressDetailsReplyDump> dumpOptional =
 123                 dumpManager.getDump(id, ctx.getModificationCache(), new AddressDumpParams(interfaceIndex, false));
 124
 125         return getAllIpv4AddressIds(dumpOptional, AddressKey::new);
 126     }
 127
 128     @Override
 129     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
 130         ((Ipv4Builder) builder).setAddress(readData);
 131     }
 132
 133     @Override
 134     public Initialized<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address> init(
 135             @Nonnull final InstanceIdentifier<Address> id, @Nonnull final Address readValue,
 136             @Nonnull final ReadContext ctx) {
 137         return Initialized.create(getCfgId(id),
 138                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressBuilder()
 139                         .setIp(readValue.getIp())
 140                         .setSubnet(getSubnet(readValue))
 141                         .build());
 142     }
 143
 144     private static Subnet getSubnet(final Address address) {
 145         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.Subnet
 146                 subnet = address.getSubnet();
 147
 148         // Only prefix length supported
 149         Preconditions.checkArgument(
 150                 subnet instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength);
 151
 152         return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.subnet.PrefixLengthBuilder()
 153                 .setPrefixLength(
 154                 ((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength) subnet)
 155                         .getPrefixLength()).build();
 156     }
 157
 158     static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address> getCfgId(
 159             final InstanceIdentifier<Address> id) {
 160         return InterfaceCustomizer.getCfgId(RWUtils.cutId(id, Interface.class))
 161                 .augmentation(Interface1.class)
 162                 .child(Ipv4.class)
 163                 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address.class,
 164                         new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressKey(id.firstKeyOf(Address.class).getIp()));
 165     }
 166 }