summaryrefslogtreecommitdiffstats
path: root/infra/bgp-translate-api
diff options
context:
space:
mode:
authorMarek Gradzki <mgradzki@cisco.com>2017-06-16 10:40:20 +0200
committerMarek Gradzki <mgradzki@cisco.com>2017-06-16 13:27:49 +0200
commitb0c773ef9c6a3e480087200b856291a246c7c374 (patch)
tree8f9edd9c735e2cf6a5acfb3a6720597f1c73ac57 /infra/bgp-translate-api
parent49efef4c40d2426e3e073f430f5ab4750710ff69 (diff)
HONEYCOMB-356: translate API for BGP routes
Change-Id: Iba3698737772544f4e4bd99db4c07319d74305fc Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'infra/bgp-translate-api')
-rw-r--r--infra/bgp-translate-api/asciidoc/Readme.adoc11
-rw-r--r--infra/bgp-translate-api/pom.xml37
-rw-r--r--infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RibWriter.java32
-rw-r--r--infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriter.java64
-rw-r--r--infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriterFactory.java32
5 files changed, 176 insertions, 0 deletions
diff --git a/infra/bgp-translate-api/asciidoc/Readme.adoc b/infra/bgp-translate-api/asciidoc/Readme.adoc
new file mode 100644
index 0000000..29a8e32
--- /dev/null
+++ b/infra/bgp-translate-api/asciidoc/Readme.adoc
@@ -0,0 +1,11 @@
+= bgp-translate-api
+
+API for translation between Binding Aware representation of BGP routes and actual device data.
+Consists of writers responsible for RIB to FIB translation.
+
+Provides registry of writers for the data layer.
+For every supported route type (e.g. ipv4, ipv6, labeled-unicast, etc.),
+there should be at least one writer registered.
+
+BGP routes are based on bgp-rib model, provided by
+https://wiki.opendaylight.org/view/BGP_LS_PCEP:Main[ODL's BGP]. \ No newline at end of file
diff --git a/infra/bgp-translate-api/pom.xml b/infra/bgp-translate-api/pom.xml
new file mode 100644
index 0000000..ff214c0
--- /dev/null
+++ b/infra/bgp-translate-api/pom.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>impl-parent</artifactId>
+ <version>1.17.07-SNAPSHOT</version>
+ <relativePath>../../common/impl-parent</relativePath>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>io.fd.honeycomb</groupId>
+ <artifactId>bgp-translate-api</artifactId>
+ <name>${project.artifactId}</name>
+ <version>1.17.07-SNAPSHOT</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.opendaylight.mdsal</groupId>
+ <artifactId>yang-binding</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.opendaylight.bgpcep</groupId>
+ <artifactId>bgp-rib-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>io.fd.honeycomb</groupId>
+ <artifactId>translate-api</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+
+</project> \ No newline at end of file
diff --git a/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RibWriter.java b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RibWriter.java
new file mode 100644
index 0000000..c1365bc
--- /dev/null
+++ b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RibWriter.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.translate.bgp;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+
+/**
+ * Delegates RIB updates to specific route writers.
+ */
+@Beta
+public interface RibWriter {
+ /**
+ * Adds writer responsible for handling routes of specific type.
+ * @param writer specific route handler
+ */
+ void register(@Nonnull RouteWriter writer);
+}
diff --git a/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriter.java b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriter.java
new file mode 100644
index 0000000..31e1e3f
--- /dev/null
+++ b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriter.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.translate.bgp;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.translate.SubtreeManager;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Responsible for translation of Routes from local RIB and any other side.
+ * Handling all update operations(create, update, delete).
+ * Can be used for RIB to FIB translation.
+ *
+ * @param <R> Specific Route derived type, that is handled by this writer
+ */
+@Beta
+public interface RouteWriter<R extends Route> extends SubtreeManager<R> {
+ /**
+ * Handles create operation.
+ * @param id identifier(from root) of data being written
+ * @param dataAfter new data to be written
+ * @throws WriteFailedException.CreateFailedException if create was unsuccessful
+ */
+ void create(@Nonnull final InstanceIdentifier<R> id,
+ @Nullable final R dataAfter) throws WriteFailedException.CreateFailedException;
+
+ /**
+ * Handles delete operation.
+ * @param id identifier(from root) of data being deleted
+ * @param dataBefore old data being deleted
+ * @throws WriteFailedException.DeleteFailedException if delete was unsuccessful
+ */
+ void delete(@Nonnull final InstanceIdentifier<R> id,
+ @Nullable final R dataBefore) throws WriteFailedException.DeleteFailedException;
+
+ /**
+ * Handles update operation.
+ * @param id identifier(from root) of data being updated
+ * @param dataBefore old data
+ * @param dataAfter new, updated data
+ * @throws WriteFailedException.UpdateFailedException if update was unsuccessful
+ */
+ void update(@Nonnull final InstanceIdentifier<R> id,
+ @Nullable final R dataBefore,
+ @Nullable final R dataAfter) throws WriteFailedException.UpdateFailedException;
+}
diff --git a/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriterFactory.java b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriterFactory.java
new file mode 100644
index 0000000..3b23d2e
--- /dev/null
+++ b/infra/bgp-translate-api/src/main/java/io/fd/honeycomb/translate/bgp/RouteWriterFactory.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.translate.bgp;
+
+import com.google.common.annotations.Beta;
+import javax.annotation.Nonnull;
+
+/**
+ * Factory producing specific route writers for {@link RibWriter}.
+ */
+@Beta
+public interface RouteWriterFactory {
+ /**
+ * Initializes 1 or more route writers and add them to provided registry.
+ * @param registry registry of route writers
+ */
+ void init(@Nonnull RibWriter registry);
+}