gerrit.fd Code Review - hc2vpp.git/blob

   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.v3po.translate.v3po.interfacesstate.ip;
  18
  19 import com.google.common.base.Optional;
  20 import io.fd.honeycomb.v3po.translate.MappingContext;
  21 import io.fd.honeycomb.v3po.translate.ModificationCache;
  22 import io.fd.honeycomb.v3po.translate.read.ReadContext;
  23 import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
  24 import io.fd.honeycomb.v3po.translate.spi.read.ListReaderCustomizer;
  25 import io.fd.honeycomb.v3po.translate.util.RWUtils;
  26 import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
  27 import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
  28 import io.fd.honeycomb.v3po.translate.v3po.util.ReadTimeoutException;
  29 import io.fd.honeycomb.v3po.translate.v3po.util.TranslateUtils;
  30 import java.util.Collections;
  31 import java.util.List;
  32 import java.util.stream.Collectors;
  33 import javax.annotation.Nonnull;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4Builder;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressKey;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLengthBuilder;
  41 import org.opendaylight.yangtools.concepts.Builder;
  42 import org.opendaylight.yangtools.yang.binding.DataObject;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.openvpp.jvpp.VppBaseCallException;
  45 import org.openvpp.jvpp.dto.IpAddressDetails;
  46 import org.openvpp.jvpp.dto.IpAddressDetailsReplyDump;
  47 import org.openvpp.jvpp.dto.IpAddressDump;
  48 import org.openvpp.jvpp.future.FutureJVpp;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 /**
  53  * Customizer for read operations for {@link Address} of {@link Ipv4}.
  54  */
  55 public class Ipv4AddressCustomizer extends FutureJVppCustomizer
  56     implements ListReaderCustomizer<Address, AddressKey, AddressBuilder> {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(Ipv4AddressCustomizer.class);
  59
  60     private static final String CACHE_KEY = Ipv4AddressCustomizer.class.getName();
  61
  62     private final NamingContext interfaceContext;
  63
  64     public Ipv4AddressCustomizer(@Nonnull final FutureJVpp futureJvpp, @Nonnull final NamingContext interfaceContext) {
  65         super(futureJvpp);
  66         this.interfaceContext = interfaceContext;
  67     }
  68
  69     @Override
  70     @Nonnull
  71     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
  72         return new AddressBuilder();
  73     }
  74
  75     @Override
  76     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
  77                                       @Nonnull ReadContext ctx)
  78         throws ReadFailedException {
  79         LOG.debug("Reading attributes...");
  80
  81         Optional<IpAddressDetailsReplyDump> dumpOptional = dumpAddresses(id, ctx);
  82
  83         if (dumpOptional.isPresent() && dumpOptional.get().ipAddressDetails != null) {
  84             List<IpAddressDetails> details = dumpOptional.get().ipAddressDetails;
  85
  86             AddressKey key = id.firstKeyOf(Address.class);
  87
  88             IpAddressDetails detail = details.stream()
  89                 .filter(singleDetail -> key.getIp().equals(TranslateUtils.arrayToIpv4AddressNoZone(singleDetail.ip)))
  90                 .collect(RWUtils.singleItemCollector());
  91
  92             builder.setIp(TranslateUtils.arrayToIpv4AddressNoZone(detail.ip))
  93                 .setSubnet(new PrefixLengthBuilder()
  94                     .setPrefixLength(Short.valueOf(detail.prefixLength)).build());
  95             LOG.info("Address read successful");
  96         } else {
  97             LOG.warn("No address dump present");
  98         }
  99     }
 100
 101     @Override
 102     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext context)
 103         throws ReadFailedException {
 104         // FIXME: this kind of logs provide very little information. At least the ID should be included so we know
 105         // from the logs what exact data is being processed
 106         // + Logs should be consistent in using punctuation
 107         LOG.debug("Extracting keys..");
 108
 109         Optional<IpAddressDetailsReplyDump> dumpOptional = dumpAddresses(id, context);
 110
 111         if (dumpOptional.isPresent() && dumpOptional.get().ipAddressDetails != null) {
 112
 113             return dumpOptional.get().ipAddressDetails.stream()
 114                 .map(detail -> new AddressKey(TranslateUtils.arrayToIpv4AddressNoZone(detail.ip)))
 115                 .collect(Collectors.toList());
 116         } else {
 117             // FIXME if this is expected then WARN should not be emitted
 118             // FIXME if this is not expected, throw an exception instead
 119             // Same in readCurrentAttributes()
 120             LOG.warn("No dump present");
 121             return Collections.emptyList();
 122         }
 123     }
 124
 125     @Override
 126     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
 127         ((Ipv4Builder) builder).setAddress(readData);
 128     }
 129
 130     // TODO refactor after there is a more generic implementation of cache operations
 131     // FIXME update TODO with what exactly should be refactored and how
 132     // TODO refactor after there is an more generic implementation of cache
 133     // operations
 134     private Optional<IpAddressDetailsReplyDump> dumpAddresses(InstanceIdentifier<Address> id, ReadContext ctx)
 135             throws ReadFailedException {
 136         final String cacheKey = CACHE_KEY + id.firstKeyOf(Interface.class).getName();
 137         Optional<IpAddressDetailsReplyDump> dumpFromCache = dumpAddressFromCache(cacheKey, ctx.getModificationCache());
 138
 139         if (dumpFromCache.isPresent()) {
 140             return dumpFromCache;
 141         }
 142
 143         Optional<IpAddressDetailsReplyDump> dumpFromOperational;
 144         try {
 145             dumpFromOperational = dumpAddressFromOperationalData(id, ctx.getMappingContext());
 146         } catch (VppBaseCallException e) {
 147             throw new ReadFailedException(id, e);
 148         }
 149
 150         if (dumpFromOperational.isPresent()) {
 151             ctx.getModificationCache().put(cacheKey, dumpFromOperational.get());
 152         }
 153
 154         return dumpFromOperational;
 155     }
 156
 157     private Optional<IpAddressDetailsReplyDump> dumpAddressFromCache(final String cacheKey,
 158                                                                      ModificationCache cache) {
 159         LOG.debug("Dumping from cache...");
 160         return Optional.fromNullable((IpAddressDetailsReplyDump) cache.get(cacheKey));
 161     }
 162
 163     private Optional<IpAddressDetailsReplyDump> dumpAddressFromOperationalData(final InstanceIdentifier<Address> id,
 164                                                                                final MappingContext mappingContext)
 165         throws VppBaseCallException, ReadTimeoutException {
 166         LOG.debug("Dumping from operational data...");
 167         final IpAddressDump dumpRequest = new IpAddressDump();
 168         dumpRequest.isIpv6 = 0;
 169         dumpRequest.swIfIndex = interfaceContext.getIndex(id.firstKeyOf(Interface.class).getName(), mappingContext);
 170         return Optional.fromNullable(
 171             TranslateUtils.getReplyForRead(getFutureJVpp().ipAddressDump(dumpRequest).toCompletableFuture(), id));
 172     }
 173
 174 }