v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfacesstate/acl/ingress/SubInterfaceAclCustomizer.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.acl.ingress;
  18
  19 import static com.google.common.base.Preconditions.checkArgument;
  20 import static com.google.common.base.Preconditions.checkNotNull;
  21 import static io.fd.honeycomb.translate.vpp.util.SubInterfaceUtils.getSubInterfaceName;
  22
  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.InitializingReaderCustomizer;
  27 import io.fd.honeycomb.translate.util.RWUtils;
  28 import io.fd.honeycomb.translate.v3po.interfacesstate.SubInterfaceCustomizer;
  29 import io.fd.honeycomb.translate.v3po.vppclassifier.VppClassifierContextManager;
  30 import io.fd.honeycomb.translate.vpp.util.FutureJVppCustomizer;
  31 import io.fd.honeycomb.translate.vpp.util.JvppReplyConsumer;
  32 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  33 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterface;
  34 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterfaceReply;
  35 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
  36 import javax.annotation.Nonnull;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces.state._interface.sub.interfaces.SubInterface;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.interfaces.state._interface.sub.interfaces.SubInterfaceKey;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.base.attributes.Acl;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.base.attributes.AclBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.base.attributes.acl.Ingress;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214.sub._interface.base.attributes.acl.IngressBuilder;
  45 import org.opendaylight.yangtools.concepts.Builder;
  46 import org.opendaylight.yangtools.yang.binding.DataObject;
  47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * Customizer for reading ingress ACLs enabled on given sub-interface.
  53  */
  54 public class SubInterfaceAclCustomizer extends FutureJVppCustomizer
  55         implements InitializingReaderCustomizer<Ingress, IngressBuilder>, AclReader, JvppReplyConsumer {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(SubInterfaceAclCustomizer.class);
  58     private final NamingContext interfaceContext;
  59     private final VppClassifierContextManager classifyTableContext;
  60
  61     public SubInterfaceAclCustomizer(@Nonnull final FutureJVppCore jvpp, @Nonnull final NamingContext interfaceContext,
  62                                      @Nonnull final VppClassifierContextManager classifyTableContext) {
  63         super(jvpp);
  64         this.interfaceContext = checkNotNull(interfaceContext, "interfaceContext should not be null");
  65         this.classifyTableContext = checkNotNull(classifyTableContext, "classifyTableContext should not be null");
  66     }
  67
  68     @Override
  69     public void merge(@Nonnull final Builder<? extends DataObject> parentBuilder, @Nonnull final Ingress readValue) {
  70         ((AclBuilder) parentBuilder).setIngress(readValue);
  71     }
  72
  73     @Nonnull
  74     @Override
  75     public IngressBuilder getBuilder(@Nonnull final InstanceIdentifier<Ingress> id) {
  76         return new IngressBuilder();
  77     }
  78
  79     @Override
  80     public void readCurrentAttributes(@Nonnull final InstanceIdentifier<Ingress> id,
  81                                       @Nonnull final IngressBuilder builder,
  82                                       @Nonnull final ReadContext ctx) throws ReadFailedException {
  83         LOG.debug("Reading attributes for sub-interface ACL: {}", id);
  84         final InterfaceKey parentInterfacekey = id.firstKeyOf(Interface.class);
  85         checkArgument(parentInterfacekey != null, "No parent interface key found");
  86         final SubInterfaceKey subInterfacekey = id.firstKeyOf(SubInterface.class);
  87         checkArgument(subInterfacekey != null, "No sub-interface key found");
  88         final String subInterfaceName =
  89                 getSubInterfaceName(parentInterfacekey.getName(), subInterfacekey.getIdentifier().intValue());
  90
  91         final ClassifyTableByInterface request = new ClassifyTableByInterface();
  92         request.swIfIndex = interfaceContext.getIndex(subInterfaceName, ctx.getMappingContext());
  93
  94         final ClassifyTableByInterfaceReply reply =
  95                 getReplyForRead(getFutureJVpp().classifyTableByInterface(request).toCompletableFuture(), id);
  96
  97         builder.setL2Acl(readL2Acl(reply.l2TableId, classifyTableContext, ctx.getMappingContext()));
  98         builder.setIp4Acl(readIp4Acl(reply.ip4TableId, classifyTableContext, ctx.getMappingContext()));
  99         builder.setIp6Acl(readIp6Acl(reply.ip6TableId, classifyTableContext, ctx.getMappingContext()));
 100
 101         if (LOG.isTraceEnabled()) {
 102             LOG.trace("Attributes for ACL {} successfully read: {}", id, builder.build());
 103         }
 104     }
 105
 106     @Override
 107     public Initialized<Ingress> init(
 108             @Nonnull final InstanceIdentifier<Ingress> id,
 109             @Nonnull final Ingress readValue,
 110             @Nonnull final ReadContext ctx) {
 111         return Initialized.create(getCfgId(id), readValue);
 112     }
 113
 114     static InstanceIdentifier<Ingress> getCfgId(
 115             final InstanceIdentifier<Ingress> id) {
 116         return SubInterfaceCustomizer.getCfgId(RWUtils.cutId(id, SubInterface.class))
 117                 .child(Acl.class)
 118                 .child(Ingress.class);
 119     }
 120 }