v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/ingress/AceWriter.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.interfaces.acl.ingress;
  18
  19 import io.fd.honeycomb.translate.write.WriteFailedException;
  20 import java.util.List;
  21 import javax.annotation.Nonnegative;
  22 import javax.annotation.Nonnull;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.Ace;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.InterfaceMode;
  25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  26 import io.fd.vpp.jvpp.core.dto.InputAclSetInterface;
  27
  28 /**
  29  * Writer responsible for translation of ietf-acl model ACEs to VPP's classify tables and sessions.
  30  */
  31 interface AceWriter {
  32
  33     /**
  34      * Translates list of ACEs to chain of classify tables. Each ACE is translated into one classify table with single
  35      * classify session. Also initializes input_acl_set_interface request message DTO with first classify table of the
  36      * chain that was created.
  37      *  @param id      uniquely identifies ietf-acl container
  38      * @param aces    list of access control entries
  39      * @param mode
  40      * @param request input_acl_set_interface request DTO
  41      */
  42     void write(@Nonnull final InstanceIdentifier<?> id, @Nonnull final List<Ace> aces,
  43                final InterfaceMode mode, @Nonnull final InputAclSetInterface request, @Nonnegative final int vlanTags)
  44         throws WriteFailedException;
  45 }