e1f306140f7b7cc15a0d08501cc4a1bd9ee62c93
[hc2vpp.git] /
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 import static io.fd.honeycomb.translate.v3po.interfacesstate.ip.Ipv4ReadUtils.dumpAddresses;
21 import static io.fd.honeycomb.translate.v3po.interfacesstate.ip.Ipv4ReadUtils.findIpAddressDetailsByIp;
22 import static io.fd.honeycomb.translate.v3po.interfacesstate.ip.Ipv4ReadUtils.getAllIpv4AddressIds;
23
24 import com.google.common.base.Optional;
25 import io.fd.honeycomb.translate.read.ReadContext;
26 import io.fd.honeycomb.translate.read.ReadFailedException;
27 import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
28 import io.fd.honeycomb.translate.v3po.util.FutureJVppCustomizer;
29 import io.fd.honeycomb.translate.v3po.util.NamingContext;
30 import io.fd.honeycomb.translate.v3po.util.SubInterfaceUtils;
31 import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
32 import java.util.List;
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.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.interfaces.state._interface.sub.interfaces.SubInterface;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.ip4.attributes.Ipv4Builder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.ip4.attributes.ipv4.Address;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.ip4.attributes.ipv4.AddressBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.ip4.attributes.ipv4.AddressKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev150527.sub._interface.ip4.attributes.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.core.dto.IpAddressDetails;
45 import org.openvpp.jvpp.core.dto.IpAddressDetailsReplyDump;
46 import org.openvpp.jvpp.core.future.FutureJVppCore;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
49
50 /**
51  * Read customizer for sub-interface Ipv4 addresses.
52  */
53 public class SubInterfaceIpv4AddressCustomizer extends FutureJVppCustomizer
54     implements ListReaderCustomizer<Address, AddressKey, AddressBuilder> {
55
56     private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceIpv4AddressCustomizer.class);
57
58     private final NamingContext interfaceContext;
59
60     public SubInterfaceIpv4AddressCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
61                                              @Nonnull final NamingContext interfaceContext) {
62         super(futureJVppCore);
63         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
64     }
65
66     @Override
67     @Nonnull
68     public AddressBuilder getBuilder(@Nonnull InstanceIdentifier<Address> id) {
69         return new AddressBuilder();
70     }
71
72     @Override
73     public void readCurrentAttributes(@Nonnull InstanceIdentifier<Address> id, @Nonnull AddressBuilder builder,
74                                       @Nonnull ReadContext ctx)
75         throws ReadFailedException {
76         LOG.debug("Reading attributes for sub-interface address: {}", id);
77
78         final String subInterfaceName = getSubInterfaceName(id);
79         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
80         final Optional<IpAddressDetailsReplyDump> dumpOptional =
81             dumpAddresses(getFutureJVpp(), id, subInterfaceName, subInterfaceIndex, ctx);
82
83         final Optional<IpAddressDetails> ipAddressDetails =
84             findIpAddressDetailsByIp(dumpOptional, id.firstKeyOf(Address.class).getIp());
85
86         if (ipAddressDetails.isPresent()) {
87             final IpAddressDetails detail = ipAddressDetails.get();
88             builder.setIp(TranslateUtils.arrayToIpv4AddressNoZone(detail.ip))
89                 .setSubnet(new PrefixLengthBuilder().setPrefixLength(Short.valueOf(detail.prefixLength)).build());
90
91             if (LOG.isDebugEnabled()) {
92                 LOG.debug("Attributes for {} sub-interface (id={}) address {} successfully read: {}",
93                     subInterfaceName, subInterfaceIndex, id, builder.build());
94             }
95         }
96     }
97
98     @Override
99     public List<AddressKey> getAllIds(@Nonnull InstanceIdentifier<Address> id, @Nonnull ReadContext ctx)
100         throws ReadFailedException {
101         LOG.debug("Reading list of keys for sub-interface addresses: {}", id);
102
103         final String subInterfaceName = getSubInterfaceName(id);
104         final int subInterfaceIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
105         final Optional<IpAddressDetailsReplyDump> dumpOptional =
106             dumpAddresses(getFutureJVpp(), id, subInterfaceName, subInterfaceIndex, ctx);
107
108         return getAllIpv4AddressIds(dumpOptional, AddressKey::new);
109     }
110
111     @Override
112     public void merge(@Nonnull Builder<? extends DataObject> builder, @Nonnull List<Address> readData) {
113         ((Ipv4Builder) builder).setAddress(readData);
114     }
115
116     private static String getSubInterfaceName(@Nonnull final InstanceIdentifier<Address> id) {
117         return SubInterfaceUtils.getSubInterfaceName(id.firstKeyOf(Interface.class).getName(),
118             Math.toIntExact(id.firstKeyOf(SubInterface.class).getIdentifier()));
119     }
120 }