Added javadocs for extensibility (#3366)

Signed-off-by: Owais Kazi <owaiskazi19@gmail.com>
opensearch-project · May 18, 2022 · 4f821e1 · 4f821e1
1 parent 7baed6e
commit 4f821e1
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/discovery/PluginRequest.java b/server/src/main/java/org/opensearch/discovery/PluginRequest.java
@@ -18,6 +18,11 @@
 import java.util.List;
 import java.util.Objects;
 
+/**
+ * PluginRequest to intialize plugin
+ *
+ * @opensearch.internal
+ */
 public class PluginRequest extends TransportRequest {
     private final DiscoveryNode sourceNode;
     /*

diff --git a/server/src/main/java/org/opensearch/discovery/PluginResponse.java b/server/src/main/java/org/opensearch/discovery/PluginResponse.java
@@ -39,6 +39,11 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * PluginResponse to intialize plugin
+ *
+ * @opensearch.internal
+ */
 public class PluginResponse extends TransportResponse {
     private String name;
 

diff --git a/server/src/main/java/org/opensearch/extensions/DiscoveryExtension.java b/server/src/main/java/org/opensearch/extensions/DiscoveryExtension.java
@@ -22,6 +22,11 @@
 import java.io.IOException;
 import java.util.Map;
 
+/**
+ * Discover extensions running independently or in a separate process
+ *
+ * @opensearch.internal
+ */
 public class DiscoveryExtension extends DiscoveryNode implements Writeable, ToXContentFragment {
 
     private final PluginInfo pluginInfo;

diff --git a/server/src/main/java/org/opensearch/extensions/ExtensionsOrchestrator.java b/server/src/main/java/org/opensearch/extensions/ExtensionsOrchestrator.java
@@ -44,6 +44,11 @@
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
+/**
+ * The main class for Plugin Extensibility
+ *
+ * @opensearch.internal
+ */
 public class ExtensionsOrchestrator implements ReportingService<PluginsAndModules> {
     public static final String REQUEST_EXTENSION_ACTION_NAME = "internal:discovery/extensions";
     public static final String INDICES_EXTENSION_POINT_ACTION_NAME = "indices:internal/extensions";

diff --git a/server/src/main/java/org/opensearch/index/IndicesModuleNameResponse.java b/server/src/main/java/org/opensearch/index/IndicesModuleNameResponse.java
@@ -14,6 +14,11 @@
 
 import java.io.IOException;
 
+/**
+ * Response for index name of onIndexModule extension point
+ *
+ * @opensearch.internal
+ */
 public class IndicesModuleNameResponse extends TransportResponse {
     private boolean requestAck;
 

diff --git a/server/src/main/java/org/opensearch/index/IndicesModuleRequest.java b/server/src/main/java/org/opensearch/index/IndicesModuleRequest.java
@@ -16,6 +16,11 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * Request for onIndexModule extension point
+ *
+ * @opensearch.internal
+ */
 public class IndicesModuleRequest extends TransportRequest {
     private final Index index;
     private final Settings indexSettings;

diff --git a/server/src/main/java/org/opensearch/index/IndicesModuleResponse.java b/server/src/main/java/org/opensearch/index/IndicesModuleResponse.java
@@ -15,6 +15,11 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * Response for onIndexModule extension point
+ *
+ * @opensearch.internal
+ */
 public class IndicesModuleResponse extends TransportResponse {
     private boolean addIndexEventListener;
     private boolean addIndexOperationListener;