[Javadocs] Add to o.o.disovery, env, gateway, http, ingest, lucene an…

…d node pkgs (#3185)

Adds javadocs to classes in the org.opensearch.discovery, env, gateway, http,
ingest, lucene, and node packages.

Signed-off-by: Nicholas Walter Knize <[email protected]>

server/src/main/java/org/opensearch/discovery/AckClusterStatePublishResponseHandler.java

@@ -42,6 +42,8 @@
  * Allows to wait for all nodes to reply to the publish of a new cluster state
  * and notifies the {@link org.opensearch.discovery.Discovery.AckListener}
  * so that the cluster state update can be acknowledged
+ *
+ * @opensearch.internal
  */
 public class AckClusterStatePublishResponseHandler extends BlockingClusterStatePublishResponseHandler {
 

server/src/main/java/org/opensearch/discovery/BlockingClusterStatePublishResponseHandler.java

@@ -43,6 +43,8 @@
 /**
  * Handles responses obtained when publishing a new cluster state from cluster-manager to all non cluster-manager nodes.
  * Allows to await a reply from all non cluster-manager nodes, up to a timeout
+ *
+ * @opensearch.internal
  */
 public class BlockingClusterStatePublishResponseHandler {
 

server/src/main/java/org/opensearch/discovery/Discovery.java

@@ -39,6 +39,8 @@
  * A pluggable module allowing to implement discovery of other nodes, publishing of the cluster
  * state to all nodes, electing a cluster-manager of the cluster that raises cluster state change
  * events.
+ *
+ * @opensearch.internal
  */
 public interface Discovery extends LifecycleComponent, ClusterStatePublisher {
 

server/src/main/java/org/opensearch/discovery/DiscoveryModule.java

@@ -75,6 +75,8 @@
 
 /**
  * A module for loading classes for node discovery.
+ *
+ * @opensearch.internal
  */
 public class DiscoveryModule {
     private static final Logger logger = LogManager.getLogger(DiscoveryModule.class);

server/src/main/java/org/opensearch/discovery/DiscoveryStats.java

@@ -42,6 +42,11 @@
 
 import java.io.IOException;
 
+/**
+ * Stores discovery stats
+ *
+ * @opensearch.internal
+ */
 public class DiscoveryStats implements Writeable, ToXContentFragment {
 
     private final PendingClusterStateStats queueStats;

server/src/main/java/org/opensearch/discovery/FileBasedSeedHostsProvider.java

@@ -57,6 +57,8 @@
  * 67.81.244.10
  * 67.81.244.11:9305
  * 67.81.244.15:9400
+ *
+ * @opensearch.internal
  */
 public class FileBasedSeedHostsProvider implements SeedHostsProvider {
 

server/src/main/java/org/opensearch/discovery/HandshakingTransportAddressConnector.java

@@ -57,6 +57,11 @@
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.emptySet;
 
+/**
+ * Connector for transport handshake
+ *
+ * @opensearch.internal
+ */
 public class HandshakingTransportAddressConnector implements TransportAddressConnector {
 
     private static final Logger logger = LogManager.getLogger(HandshakingTransportAddressConnector.class);

server/src/main/java/org/opensearch/discovery/MasterNotDiscoveredException.java

@@ -38,6 +38,11 @@
 
 import java.io.IOException;
 
+/**
+ * Exception when the cluster-manager is not discovered
+ *
+ * @opensearch.internal
+ */
 public class MasterNotDiscoveredException extends OpenSearchException {
 
     public MasterNotDiscoveredException() {

server/src/main/java/org/opensearch/discovery/PeerFinder.java

@@ -65,6 +65,11 @@
 
 import static java.util.Collections.emptyList;
 
+/**
+ * finds peers
+ *
+ * @opensearch.internal
+ */
 public abstract class PeerFinder {
 
     private static final Logger logger = LogManager.getLogger(PeerFinder.class);

server/src/main/java/org/opensearch/discovery/PeersRequest.java

@@ -41,6 +41,11 @@
 import java.util.List;
 import java.util.Objects;
 
+/**
+ * Request sent to a peer node
+ *
+ * @opensearch.internal
+ */
 public class PeersRequest extends TransportRequest {
     private final DiscoveryNode sourceNode;
     private final List<DiscoveryNode> knownPeers;

server/src/main/java/org/opensearch/discovery/SeedHostsProvider.java

@@ -38,6 +38,8 @@
 
 /**
  * A pluggable provider of the list of seed hosts to use for discovery.
+ *
+ * @opensearch.internal
  */
 public interface SeedHostsProvider {
 

server/src/main/java/org/opensearch/discovery/SeedHostsResolver.java

@@ -65,6 +65,11 @@
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+/**
+ * Resolves seed hosts listed in the config
+ *
+ * @opensearch.internal
+ */
 public class SeedHostsResolver extends AbstractLifecycleComponent implements ConfiguredHostsResolver {
     public static final Setting<Integer> LEGACY_DISCOVERY_ZEN_PING_UNICAST_CONCURRENT_CONNECTS_SETTING = Setting.intSetting(
         "discovery.zen.ping.unicast.concurrent_connects",

server/src/main/java/org/opensearch/discovery/SettingsBasedSeedHostsProvider.java

@@ -52,6 +52,8 @@
  *
  * An example setting might look as follows:
  * [67.81.244.10, 67.81.244.11:9305, 67.81.244.15:9400]
+ *
+ * @opensearch.internal
  */
 public class SettingsBasedSeedHostsProvider implements SeedHostsProvider {
 

server/src/main/java/org/opensearch/env/Environment.java

@@ -55,6 +55,8 @@
 
 /**
  * The environment of where things exists.
+ *
+ * @opensearch.internal
  */
 @SuppressForbidden(reason = "configures paths for the system")
 // TODO: move PathUtils to be package-private here instead of

server/src/main/java/org/opensearch/env/NodeEnvironment.java

@@ -107,6 +107,8 @@
 
 /**
  * A component that holds all data paths for a single node.
+ *
+ * @opensearch.internal
  */
 public final class NodeEnvironment implements Closeable {
     public static class NodePath {

server/src/main/java/org/opensearch/env/NodeMetadata.java

@@ -48,6 +48,8 @@
 /**
  * Metadata associated with this node: its persistent node ID and its version.
  * The metadata is persisted in the data folder of this node and is reused across restarts.
+ *
+ * @opensearch.internal
  */
 public final class NodeMetadata {
 

server/src/main/java/org/opensearch/env/NodeRepurposeCommand.java

@@ -59,6 +59,11 @@
 
 import static org.opensearch.env.NodeEnvironment.INDICES_FOLDER;
 
+/**
+ * Command to repurpose a node
+ *
+ * @opensearch.internal
+ */
 public class NodeRepurposeCommand extends OpenSearchNodeCommand {
 
     static final String ABORTED_BY_USER_MSG = OpenSearchNodeCommand.ABORTED_BY_USER_MSG;

server/src/main/java/org/opensearch/env/OpenSearchFileStore.java

@@ -49,6 +49,8 @@
  * additional features, such as SSD detection and better
  * filesystem information for the root filesystem.
  * @see Environment#getFileStore(Path)
+ *
+ * @opensearch.internal
  */
 class OpenSearchFileStore extends FileStore {
     /** Underlying filestore */

server/src/main/java/org/opensearch/env/OverrideNodeVersionCommand.java

@@ -43,6 +43,11 @@
 import java.nio.file.Path;
 import java.util.Arrays;
 
+/**
+ * Command to override a node version
+ *
+ * @opensearch.internal
+ */
 public class OverrideNodeVersionCommand extends OpenSearchNodeCommand {
     private static final String TOO_NEW_MESSAGE = DELIMITER
         + "\n"

server/src/main/java/org/opensearch/env/ShardLock.java

@@ -43,6 +43,8 @@
  * before executing any write operations on the shards data directory.
  *
  * @see NodeEnvironment
+ *
+ * @opensearch.internal
  */
 public abstract class ShardLock implements Closeable {
 

server/src/main/java/org/opensearch/env/ShardLockObtainFailedException.java

@@ -40,6 +40,8 @@
 
 /**
  * Exception used when the in-memory lock for a shard cannot be obtained
+ *
+ * @opensearch.internal
  */
 public class ShardLockObtainFailedException extends OpenSearchException {
 

server/src/main/java/org/opensearch/gateway/AsyncShardFetch.java

@@ -69,6 +69,8 @@
  * The async fetch logic maintains a map of which nodes are being fetched from in an async manner,
  * and once the results are back, it makes sure to schedule a reroute to make sure those results will
  * be taken into account.
+ *
+ * @opensearch.internal
  */
 public abstract class AsyncShardFetch<T extends BaseNodeResponse> implements Releasable {
 

server/src/main/java/org/opensearch/gateway/BaseGatewayShardAllocator.java

@@ -53,6 +53,8 @@
  *
  * Individual implementations of this class are responsible for providing
  * the logic to determine to which nodes (if any) those shards are allocated.
+ *
+ * @opensearch.internal
  */
 public abstract class BaseGatewayShardAllocator {
 

server/src/main/java/org/opensearch/gateway/ClusterStateUpdaters.java

@@ -49,6 +49,11 @@
 
 import static org.opensearch.gateway.GatewayService.STATE_NOT_RECOVERED_BLOCK;
 
+/**
+ * Updates cluster state
+ *
+ * @opensearch.internal
+ */
 public class ClusterStateUpdaters {
     private static final Logger logger = LogManager.getLogger(ClusterStateUpdaters.class);
 

server/src/main/java/org/opensearch/gateway/CorruptStateException.java

@@ -36,6 +36,8 @@
 /**
  * This exception is thrown when OpenSearch detects
  * an inconsistency in one of it's persistent states.
+ *
+ * @opensearch.internal
  */
 public class CorruptStateException extends OpenSearchCorruptionException {
 

server/src/main/java/org/opensearch/gateway/DanglingIndicesState.java

@@ -63,6 +63,8 @@
  * The dangling indices state is responsible for finding new dangling indices (indices that have
  * their state written on disk, but don't exists in the metadata of the cluster), and importing
  * them into the cluster.
+ *
+ * @opensearch.internal
  */
 public class DanglingIndicesState implements ClusterStateListener {
 

server/src/main/java/org/opensearch/gateway/Gateway.java

@@ -47,6 +47,11 @@
 import java.util.Arrays;
 import java.util.function.Function;
 
+/**
+ * The Gateway
+ *
+ * @opensearch.internal
+ */
 public class Gateway {
 
     private static final Logger logger = LogManager.getLogger(Gateway.class);

server/src/main/java/org/opensearch/gateway/GatewayAllocator.java

@@ -63,6 +63,11 @@
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 
+/**
+ * Allocator for the gateway
+ *
+ * @opensearch.internal
+ */
 public class GatewayAllocator implements ExistingShardsAllocator {
 
     public static final String ALLOCATOR_NAME = "gateway_allocator";

server/src/main/java/org/opensearch/gateway/GatewayException.java

@@ -37,6 +37,11 @@
 
 import java.io.IOException;
 
+/**
+ * Base Exception for the gateway
+ *
+ * @opensearch.internal
+ */
 public class GatewayException extends OpenSearchException {
 
     public GatewayException(StreamInput in) throws IOException {

server/src/main/java/org/opensearch/gateway/GatewayMetaState.java

@@ -91,6 +91,8 @@
  * the state being loaded when constructing the instance of this class is not necessarily the state that will be used as {@link
  * ClusterState#metadata()} because it might be stale or incomplete. Cluster-manager-eligible nodes must perform an election to find a complete and
  * non-stale state, and cluster-manager-ineligible nodes receive the real cluster state from the elected cluster-manager after joining the cluster.
+ *
+ * @opensearch.internal
  */
 public class GatewayMetaState implements Closeable {
 

server/src/main/java/org/opensearch/gateway/GatewayModule.java

@@ -34,6 +34,11 @@
 
 import org.opensearch.common.inject.AbstractModule;
 
+/**
+ * Binds the gateway module
+ *
+ * @opensearch.internal
+ */
 public class GatewayModule extends AbstractModule {
 
     @Override

server/src/main/java/org/opensearch/gateway/GatewayService.java

@@ -60,6 +60,11 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Function;
 
+/**
+ * The Gateway Service provider
+ *
+ * @opensearch.internal
+ */
 public class GatewayService extends AbstractLifecycleComponent implements ClusterStateListener {
     private static final Logger logger = LogManager.getLogger(GatewayService.class);
 

server/src/main/java/org/opensearch/gateway/IncrementalClusterStateWriter.java

@@ -54,6 +54,8 @@
 
 /**
  * Tracks the metadata written to disk, allowing updated metadata to be written incrementally (i.e. only writing out the changed metadata).
+ *
+ * @opensearch.internal
  */
 public class IncrementalClusterStateWriter {
 

server/src/main/java/org/opensearch/gateway/LocalAllocateDangledIndices.java

@@ -68,6 +68,11 @@
 
 import static org.opensearch.cluster.metadata.MetadataIndexStateService.isIndexVerifiedBeforeClosed;
 
+/**
+ * Allocates dangled indices
+ *
+ * @opensearch.internal
+ */
 public class LocalAllocateDangledIndices {
 
     private static final Logger logger = LogManager.getLogger(LocalAllocateDangledIndices.class);

server/src/main/java/org/opensearch/gateway/MetaStateService.java

@@ -54,6 +54,8 @@
 
 /**
  * Handles writing and loading {@link Manifest}, {@link Metadata} and {@link IndexMetadata}
+ *
+ * @opensearch.internal
  */
 public class MetaStateService {
     private static final Logger logger = LogManager.getLogger(MetaStateService.class);

server/src/main/java/org/opensearch/gateway/MetadataStateFormat.java

@@ -75,6 +75,8 @@
  * MetadataStateFormat is a base class to write checksummed
  * XContent based files to one or more directories in a standardized directory structure.
  * @param <T> the type of the XContent base data-structure
+ *
+ * @opensearch.internal
  */
 public abstract class MetadataStateFormat<T> {
     public static final XContentType FORMAT = XContentType.SMILE;

server/src/main/java/org/opensearch/gateway/PersistedClusterStateService.java

@@ -131,6 +131,8 @@
  * +---------------------------+-------------------------+-------------------------------------------------------------------------------+
  *
  * (the last-accepted term is recorded in Metadata → CoordinationMetadata so does not need repeating here)
+ *
+ * @opensearch.internal
  */
 public class PersistedClusterStateService {
     private static final Logger logger = LogManager.getLogger(PersistedClusterStateService.class);

server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java

@@ -74,6 +74,8 @@
  * (see {@link org.opensearch.cluster.routing.allocation.allocator.BalancedShardsAllocator}),
  * nor does it allocate primaries when a primary shard failed and there is a valid replica
  * copy that can immediately be promoted to primary, as this takes place in {@link RoutingNodes#failShard}.
+ *
+ * @opensearch.internal
  */
 public abstract class PrimaryShardAllocator extends BaseGatewayShardAllocator {
     /**

server/src/main/java/org/opensearch/gateway/PriorityComparator.java

@@ -51,6 +51,8 @@
  *     <li>Lastly the index names are compared, which is useful when a date is baked into the index
  *         name, e.g. <code>logstash-2015.05.03</code></li>
  * </ol>
+ *
+ * @opensearch.internal
  */
 public abstract class PriorityComparator implements Comparator<ShardRouting> {