[AETHER-76] Complete T3 offline mode
- For the performance improvement, T3 offline mode uses snapshots of the network states
called Network Information Base (NIB) instead of runtime interactions with ONOS core
during troubleshooting a Trellis system.
- Enables NIB to be manually filled with the followings via T3-load commands.
- Static dump files of onos-diagnostics (t3-load-file).
- Returns of API calls to live ONOS stores (t3-load-snapshot).
- Enables NIB to be auto-filled with live ONOS stores.
- When T3-execution commands (e.g. pingall) found NIB is invalid.
- Partially tested with some mininet topos for Trellis
(https://github.com/opennetworkinglab/routing/tree/master/trellis).
- Usage instruction docs (https://docs.trellisfabric.org/troubleshooting.html).
Change-Id: I2bb546bdde454a034338cd896388fa0b37d868be
(cherry picked from commit c3803e7fad5fb28ecf3e83253f183a34936be4a0)
diff --git a/app/src/main/java/org/onosproject/t3/cli/NibLoader.java b/app/src/main/java/org/onosproject/t3/cli/NibLoader.java
new file mode 100644
index 0000000..40690ca
--- /dev/null
+++ b/app/src/main/java/org/onosproject/t3/cli/NibLoader.java
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * 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 org.onosproject.t3.cli;
+
+import java.io.IOException;
+
+/**
+ * Common APIs for T3 CLI commands to load snapshots of the network states
+ * from {@link org.onosproject.t3.api.NibProfile.SourceType} and fill the NIB.
+ */
+public interface NibLoader {
+
+ /**
+ * Extracts flow-related information and fills the flow NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadFlowNib() throws IOException;
+
+ /**
+ * Extracts group-related information and fills the group NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadGroupNib() throws IOException;
+
+ /**
+ * Extracts host-related information and fills the host NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadHostNib() throws IOException;
+
+ /**
+ * Extracts link-related information and fills the link NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadLinkNib() throws IOException;
+
+ /**
+ * Extracts device-related information and fills the device NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadDeviceNib() throws IOException;
+
+ /**
+ * Extracts driver-related information and fills the driver NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadDriverNib() throws IOException;
+
+ /**
+ * Extracts mastership-related information and fills the mastership NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadMastershipNib() throws IOException;
+
+ /**
+ * Extracts edge port-related information and fills the edge port NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadEdgePortNib() throws IOException;
+
+ /**
+ * Extracts route-related information and fills the route NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadRouteNib() throws IOException;
+
+ /**
+ * Extracts network config-related information and fills the network configuration NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadNetworkConfigNib() throws IOException;
+
+ /**
+ * Extracts multicast route-related information and fills the multicast route NIB.
+ *
+ * @throws IOException exception during possible file I/O
+ */
+ void loadMulticastRouteNib() throws IOException;
+
+}