HONEYCOMB-139: ietf-acl translation layer. IP6 L3 ACL support

Other changes:
- documentation update
- eth + ip4 writer rafactoring + tests

Change-Id: I1ac6a4e99dd4f12c870cbd749af6b98018294dd4
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

1 files changed, 13 insertions, 0 deletions

diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/AceWriter.java b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/AceWriter.java
index be3889fb0..2d66619fd 100644
--- a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/AceWriter.java
+++ b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/AceWriter.java
@@ -24,7 +24,20 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.openvpp.jvpp.VppBaseCallException;
 import org.openvpp.jvpp.core.dto.InputAclSetInterface;
 
+/**
+ * Writer responsible for translation of ietf-acl model ACEs to VPP's classify tables and sessions.
+ */
 interface AceWriter {
+
+    /**
+     * Translates list of ACEs to chain of classify tables. Each ACE is translated into one classify table with single
+     * classify session. Also initializes input_acl_set_interface request message DTO with first classify table of the
+     * chain that was created.
+     *
+     * @param id      uniquely identifies ietf-acl container
+     * @param aces    list of access control entries
+     * @param request input_acl_set_interface request DTO
+     */
     void write(@Nonnull final InstanceIdentifier<?> id, @Nonnull final List<Ace> aces,
                @Nonnull final InputAclSetInterface request) throws VppBaseCallException, WriteTimeoutException;
 }