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