diff --git a/server/src/main/java/org/opensearch/discovery/AckClusterStatePublishResponseHandler.java b/server/src/main/java/org/opensearch/discovery/AckClusterStatePublishResponseHandler.java index e281bbbfacba1..2de585e049f56 100644 --- a/server/src/main/java/org/opensearch/discovery/AckClusterStatePublishResponseHandler.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/discovery/BlockingClusterStatePublishResponseHandler.java b/server/src/main/java/org/opensearch/discovery/BlockingClusterStatePublishResponseHandler.java index 6ee01d055be04..daed425034087 100644 --- a/server/src/main/java/org/opensearch/discovery/BlockingClusterStatePublishResponseHandler.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/discovery/Discovery.java b/server/src/main/java/org/opensearch/discovery/Discovery.java index 25d136d8a2563..25b3cb6c2b90d 100644 --- a/server/src/main/java/org/opensearch/discovery/Discovery.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/discovery/DiscoveryModule.java b/server/src/main/java/org/opensearch/discovery/DiscoveryModule.java index af3d07a1b12d5..c12283df1dbc9 100644 --- a/server/src/main/java/org/opensearch/discovery/DiscoveryModule.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/discovery/DiscoveryStats.java b/server/src/main/java/org/opensearch/discovery/DiscoveryStats.java index e480799c9f7c4..78fafb98040eb 100644 --- a/server/src/main/java/org/opensearch/discovery/DiscoveryStats.java +++ b/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; diff --git a/server/src/main/java/org/opensearch/discovery/FileBasedSeedHostsProvider.java b/server/src/main/java/org/opensearch/discovery/FileBasedSeedHostsProvider.java index c6cd8411afc91..94f36ba0a546e 100644 --- a/server/src/main/java/org/opensearch/discovery/FileBasedSeedHostsProvider.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/discovery/HandshakingTransportAddressConnector.java b/server/src/main/java/org/opensearch/discovery/HandshakingTransportAddressConnector.java index d2e2c5fbea8ac..fcc890b1c21c9 100644 --- a/server/src/main/java/org/opensearch/discovery/HandshakingTransportAddressConnector.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/discovery/MasterNotDiscoveredException.java b/server/src/main/java/org/opensearch/discovery/MasterNotDiscoveredException.java index 337a6cf309dec..dec50388b5624 100644 --- a/server/src/main/java/org/opensearch/discovery/MasterNotDiscoveredException.java +++ b/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() { diff --git a/server/src/main/java/org/opensearch/discovery/PeerFinder.java b/server/src/main/java/org/opensearch/discovery/PeerFinder.java index c174016925696..45b21b1eaa5da 100644 --- a/server/src/main/java/org/opensearch/discovery/PeerFinder.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/discovery/PeersRequest.java b/server/src/main/java/org/opensearch/discovery/PeersRequest.java index 6a96ee3450050..83545acf80ba3 100644 --- a/server/src/main/java/org/opensearch/discovery/PeersRequest.java +++ b/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 knownPeers; diff --git a/server/src/main/java/org/opensearch/discovery/SeedHostsProvider.java b/server/src/main/java/org/opensearch/discovery/SeedHostsProvider.java index 23944f7bb122c..1a4b5a3182dbe 100644 --- a/server/src/main/java/org/opensearch/discovery/SeedHostsProvider.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/discovery/SeedHostsResolver.java b/server/src/main/java/org/opensearch/discovery/SeedHostsResolver.java index 0c002a2f29a5e..94e51fe5804ca 100644 --- a/server/src/main/java/org/opensearch/discovery/SeedHostsResolver.java +++ b/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 LEGACY_DISCOVERY_ZEN_PING_UNICAST_CONCURRENT_CONNECTS_SETTING = Setting.intSetting( "discovery.zen.ping.unicast.concurrent_connects", diff --git a/server/src/main/java/org/opensearch/discovery/SettingsBasedSeedHostsProvider.java b/server/src/main/java/org/opensearch/discovery/SettingsBasedSeedHostsProvider.java index 87fd49bde6aad..2dcd819e727f2 100644 --- a/server/src/main/java/org/opensearch/discovery/SettingsBasedSeedHostsProvider.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/env/Environment.java b/server/src/main/java/org/opensearch/env/Environment.java index 4a1e5e5069ccb..c9e75bcbb616f 100644 --- a/server/src/main/java/org/opensearch/env/Environment.java +++ b/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 diff --git a/server/src/main/java/org/opensearch/env/NodeEnvironment.java b/server/src/main/java/org/opensearch/env/NodeEnvironment.java index a09e462c474f4..54bd376371b86 100644 --- a/server/src/main/java/org/opensearch/env/NodeEnvironment.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/env/NodeMetadata.java b/server/src/main/java/org/opensearch/env/NodeMetadata.java index cb6257002b62b..3944ecfd72d4c 100644 --- a/server/src/main/java/org/opensearch/env/NodeMetadata.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/env/NodeRepurposeCommand.java b/server/src/main/java/org/opensearch/env/NodeRepurposeCommand.java index dd4819f5804ac..2e9ea67a93944 100644 --- a/server/src/main/java/org/opensearch/env/NodeRepurposeCommand.java +++ b/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; diff --git a/server/src/main/java/org/opensearch/env/OpenSearchFileStore.java b/server/src/main/java/org/opensearch/env/OpenSearchFileStore.java index dce985f8320d4..834fb0e748915 100644 --- a/server/src/main/java/org/opensearch/env/OpenSearchFileStore.java +++ b/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 */ diff --git a/server/src/main/java/org/opensearch/env/OverrideNodeVersionCommand.java b/server/src/main/java/org/opensearch/env/OverrideNodeVersionCommand.java index ec92d00a88a6e..d07ea1acd25fa 100644 --- a/server/src/main/java/org/opensearch/env/OverrideNodeVersionCommand.java +++ b/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" diff --git a/server/src/main/java/org/opensearch/env/ShardLock.java b/server/src/main/java/org/opensearch/env/ShardLock.java index 21278a41dc76f..6e4cf7ebef016 100644 --- a/server/src/main/java/org/opensearch/env/ShardLock.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/env/ShardLockObtainFailedException.java b/server/src/main/java/org/opensearch/env/ShardLockObtainFailedException.java index 0bcd4c4128dbe..ea0715e063907 100644 --- a/server/src/main/java/org/opensearch/env/ShardLockObtainFailedException.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/AsyncShardFetch.java b/server/src/main/java/org/opensearch/gateway/AsyncShardFetch.java index e3c840b5d896e..6e359d690b1ec 100644 --- a/server/src/main/java/org/opensearch/gateway/AsyncShardFetch.java +++ b/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 implements Releasable { diff --git a/server/src/main/java/org/opensearch/gateway/BaseGatewayShardAllocator.java b/server/src/main/java/org/opensearch/gateway/BaseGatewayShardAllocator.java index bbc78d78f4636..59ef894958cbe 100644 --- a/server/src/main/java/org/opensearch/gateway/BaseGatewayShardAllocator.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/ClusterStateUpdaters.java b/server/src/main/java/org/opensearch/gateway/ClusterStateUpdaters.java index b9913fa5983f7..4402da155ff5a 100644 --- a/server/src/main/java/org/opensearch/gateway/ClusterStateUpdaters.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/CorruptStateException.java b/server/src/main/java/org/opensearch/gateway/CorruptStateException.java index 7c5aeb76e5118..3632dc057a053 100644 --- a/server/src/main/java/org/opensearch/gateway/CorruptStateException.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/DanglingIndicesState.java b/server/src/main/java/org/opensearch/gateway/DanglingIndicesState.java index 25a1096919939..8c2a55fda3742 100644 --- a/server/src/main/java/org/opensearch/gateway/DanglingIndicesState.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/Gateway.java b/server/src/main/java/org/opensearch/gateway/Gateway.java index c25097723b8f7..1891c5020015c 100644 --- a/server/src/main/java/org/opensearch/gateway/Gateway.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/GatewayAllocator.java b/server/src/main/java/org/opensearch/gateway/GatewayAllocator.java index 76dc33e73a530..cdcf813d9ede0 100644 --- a/server/src/main/java/org/opensearch/gateway/GatewayAllocator.java +++ b/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"; diff --git a/server/src/main/java/org/opensearch/gateway/GatewayException.java b/server/src/main/java/org/opensearch/gateway/GatewayException.java index 262b45c9bba28..59313a3fe84a4 100644 --- a/server/src/main/java/org/opensearch/gateway/GatewayException.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/GatewayMetaState.java b/server/src/main/java/org/opensearch/gateway/GatewayMetaState.java index 0ca70f37afa83..610219ab1f054 100644 --- a/server/src/main/java/org/opensearch/gateway/GatewayMetaState.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/GatewayModule.java b/server/src/main/java/org/opensearch/gateway/GatewayModule.java index a58fe3657d27d..59ec0243c88c9 100644 --- a/server/src/main/java/org/opensearch/gateway/GatewayModule.java +++ b/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 diff --git a/server/src/main/java/org/opensearch/gateway/GatewayService.java b/server/src/main/java/org/opensearch/gateway/GatewayService.java index 1a0efbcdf5bfb..06e92b7f0d7cf 100644 --- a/server/src/main/java/org/opensearch/gateway/GatewayService.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/IncrementalClusterStateWriter.java b/server/src/main/java/org/opensearch/gateway/IncrementalClusterStateWriter.java index 4933b70384960..3fdde3a3bad09 100644 --- a/server/src/main/java/org/opensearch/gateway/IncrementalClusterStateWriter.java +++ b/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 { diff --git a/server/src/main/java/org/opensearch/gateway/LocalAllocateDangledIndices.java b/server/src/main/java/org/opensearch/gateway/LocalAllocateDangledIndices.java index 4c29bc6f2692f..c100bbb9a7406 100644 --- a/server/src/main/java/org/opensearch/gateway/LocalAllocateDangledIndices.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/MetaStateService.java b/server/src/main/java/org/opensearch/gateway/MetaStateService.java index eb5a4adba9b0f..ffc9fe5cad0f1 100644 --- a/server/src/main/java/org/opensearch/gateway/MetaStateService.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/MetadataStateFormat.java b/server/src/main/java/org/opensearch/gateway/MetadataStateFormat.java index fd1dee46815a8..db21d9cb8804e 100644 --- a/server/src/main/java/org/opensearch/gateway/MetadataStateFormat.java +++ b/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 the type of the XContent base data-structure + * + * @opensearch.internal */ public abstract class MetadataStateFormat { public static final XContentType FORMAT = XContentType.SMILE; diff --git a/server/src/main/java/org/opensearch/gateway/PersistedClusterStateService.java b/server/src/main/java/org/opensearch/gateway/PersistedClusterStateService.java index 4bcd6bb9fc7a5..c3581265945b1 100644 --- a/server/src/main/java/org/opensearch/gateway/PersistedClusterStateService.java +++ b/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); diff --git a/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java b/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java index dbde8abf02d6d..b9cfebaa98521 100644 --- a/server/src/main/java/org/opensearch/gateway/PrimaryShardAllocator.java +++ b/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 { /** diff --git a/server/src/main/java/org/opensearch/gateway/PriorityComparator.java b/server/src/main/java/org/opensearch/gateway/PriorityComparator.java index cf4cbf53daa37..7b3179a509057 100644 --- a/server/src/main/java/org/opensearch/gateway/PriorityComparator.java +++ b/server/src/main/java/org/opensearch/gateway/PriorityComparator.java @@ -51,6 +51,8 @@ *
  • Lastly the index names are compared, which is useful when a date is baked into the index * name, e.g. logstash-2015.05.03
  • * + * + * @opensearch.internal */ public abstract class PriorityComparator implements Comparator { diff --git a/server/src/main/java/org/opensearch/gateway/ReplicaShardAllocator.java b/server/src/main/java/org/opensearch/gateway/ReplicaShardAllocator.java index 64146201e29db..c0b831b6fe4d0 100644 --- a/server/src/main/java/org/opensearch/gateway/ReplicaShardAllocator.java +++ b/server/src/main/java/org/opensearch/gateway/ReplicaShardAllocator.java @@ -65,6 +65,11 @@ import static org.opensearch.cluster.routing.UnassignedInfo.INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING; +/** + * Allocates replica shards + * + * @opensearch.internal + */ public abstract class ReplicaShardAllocator extends BaseGatewayShardAllocator { /** * Process existing recoveries of replicas and see if we need to cancel them if we find a better diff --git a/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayMetaState.java b/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayMetaState.java index ce78962ef7843..ce9af1a7dd748 100644 --- a/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayMetaState.java +++ b/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayMetaState.java @@ -57,6 +57,11 @@ import java.io.IOException; import java.util.List; +/** + * Lists gateway meta state + * + * @opensearch.internal + */ public class TransportNodesListGatewayMetaState extends TransportNodesAction< TransportNodesListGatewayMetaState.Request, TransportNodesListGatewayMetaState.NodesGatewayMetaState, diff --git a/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayStartedShards.java b/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayStartedShards.java index 413bf0e23090d..11a2c8370ae7b 100644 --- a/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayStartedShards.java +++ b/server/src/main/java/org/opensearch/gateway/TransportNodesListGatewayStartedShards.java @@ -72,6 +72,8 @@ * This transport action is used to fetch the shard version from each node during primary allocation in {@link GatewayAllocator}. * We use this to find out which node holds the latest shard version and which of them used to be a primary in order to allocate * shards after node or cluster restarts. + * + * @opensearch.internal */ public class TransportNodesListGatewayStartedShards extends TransportNodesAction< TransportNodesListGatewayStartedShards.Request, diff --git a/server/src/main/java/org/opensearch/gateway/WriteStateException.java b/server/src/main/java/org/opensearch/gateway/WriteStateException.java index 11614397be5e5..e60eb0c11310d 100644 --- a/server/src/main/java/org/opensearch/gateway/WriteStateException.java +++ b/server/src/main/java/org/opensearch/gateway/WriteStateException.java @@ -37,6 +37,8 @@ /** * This exception is thrown when there is a problem of writing state to disk. + * + * @opensearch.internal */ public class WriteStateException extends IOException { private final boolean dirty; diff --git a/server/src/main/java/org/opensearch/http/AbstractHttpServerTransport.java b/server/src/main/java/org/opensearch/http/AbstractHttpServerTransport.java index 8d98370a90538..eb0a9a14836e8 100644 --- a/server/src/main/java/org/opensearch/http/AbstractHttpServerTransport.java +++ b/server/src/main/java/org/opensearch/http/AbstractHttpServerTransport.java @@ -78,6 +78,11 @@ import static org.opensearch.http.HttpTransportSettings.SETTING_HTTP_PUBLISH_HOST; import static org.opensearch.http.HttpTransportSettings.SETTING_HTTP_PUBLISH_PORT; +/** + * Base HttpServer class + * + * @opensearch.internal + */ public abstract class AbstractHttpServerTransport extends AbstractLifecycleComponent implements HttpServerTransport { private static final Logger logger = LogManager.getLogger(AbstractHttpServerTransport.class); private static final ActionListener NO_OP = ActionListener.wrap(() -> {}); diff --git a/server/src/main/java/org/opensearch/http/BindHttpException.java b/server/src/main/java/org/opensearch/http/BindHttpException.java index cfa537fca9bb7..0f0e7198db548 100644 --- a/server/src/main/java/org/opensearch/http/BindHttpException.java +++ b/server/src/main/java/org/opensearch/http/BindHttpException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown when trying to bind to an http endpoint + * + * @opensearch.internal + */ public class BindHttpException extends HttpException { public BindHttpException(String message) { diff --git a/server/src/main/java/org/opensearch/http/CorsHandler.java b/server/src/main/java/org/opensearch/http/CorsHandler.java index 0b2cedf093f33..3a16c8f82e40c 100644 --- a/server/src/main/java/org/opensearch/http/CorsHandler.java +++ b/server/src/main/java/org/opensearch/http/CorsHandler.java @@ -84,6 +84,8 @@ * * It modifies the original netty code to operate on OpenSearch http request/response abstractions. * Additionally, it removes CORS features that are not used by OpenSearch. + * + * @opensearch.internal */ public class CorsHandler { diff --git a/server/src/main/java/org/opensearch/http/DefaultRestChannel.java b/server/src/main/java/org/opensearch/http/DefaultRestChannel.java index d94eadf82463a..9df59cbb6f377 100644 --- a/server/src/main/java/org/opensearch/http/DefaultRestChannel.java +++ b/server/src/main/java/org/opensearch/http/DefaultRestChannel.java @@ -58,6 +58,8 @@ /** * The default rest channel for incoming requests. This class implements the basic logic for sending a rest * response. It will set necessary headers nad ensure that bytes are released after the response is sent. + * + * @opensearch.internal */ public class DefaultRestChannel extends AbstractRestChannel implements RestChannel { diff --git a/server/src/main/java/org/opensearch/http/HttpChannel.java b/server/src/main/java/org/opensearch/http/HttpChannel.java index c309a8c5decad..a3a3d46f629ce 100644 --- a/server/src/main/java/org/opensearch/http/HttpChannel.java +++ b/server/src/main/java/org/opensearch/http/HttpChannel.java @@ -37,6 +37,11 @@ import java.net.InetSocketAddress; +/** + * Represents an HTTP comms channel + * + * @opensearch.internal + */ public interface HttpChannel extends CloseableChannel { /** diff --git a/server/src/main/java/org/opensearch/http/HttpException.java b/server/src/main/java/org/opensearch/http/HttpException.java index 70fb6a956b8a1..c5eb734bbe5fc 100644 --- a/server/src/main/java/org/opensearch/http/HttpException.java +++ b/server/src/main/java/org/opensearch/http/HttpException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown on HTTP requests + * + * @opensearch.internal + */ public class HttpException extends OpenSearchException { public HttpException(String message) { diff --git a/server/src/main/java/org/opensearch/http/HttpHandlingSettings.java b/server/src/main/java/org/opensearch/http/HttpHandlingSettings.java index 3e9d252bd64d3..37f754d591b22 100644 --- a/server/src/main/java/org/opensearch/http/HttpHandlingSettings.java +++ b/server/src/main/java/org/opensearch/http/HttpHandlingSettings.java @@ -46,6 +46,11 @@ import static org.opensearch.http.HttpTransportSettings.SETTING_HTTP_RESET_COOKIES; import static org.opensearch.http.HttpTransportSettings.SETTING_PIPELINING_MAX_EVENTS; +/** + * HTTP Settings + * + * @opensearch.internal + */ public class HttpHandlingSettings { private final int maxContentLength; diff --git a/server/src/main/java/org/opensearch/http/HttpInfo.java b/server/src/main/java/org/opensearch/http/HttpInfo.java index cf49d2621ccfa..58a36091c7f99 100644 --- a/server/src/main/java/org/opensearch/http/HttpInfo.java +++ b/server/src/main/java/org/opensearch/http/HttpInfo.java @@ -44,6 +44,11 @@ import java.io.IOException; +/** + * Information about an http connection + * + * @opensearch.internal + */ public class HttpInfo implements ReportingService.Info { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(HttpInfo.class); diff --git a/server/src/main/java/org/opensearch/http/HttpPipelinedMessage.java b/server/src/main/java/org/opensearch/http/HttpPipelinedMessage.java index 4b1a8fc3ddd18..879da973274e5 100644 --- a/server/src/main/java/org/opensearch/http/HttpPipelinedMessage.java +++ b/server/src/main/java/org/opensearch/http/HttpPipelinedMessage.java @@ -31,6 +31,11 @@ package org.opensearch.http; +/** + * Pipeline messages for http connections + * + * @opensearch.internal + */ public interface HttpPipelinedMessage extends Comparable { /** diff --git a/server/src/main/java/org/opensearch/http/HttpPipelinedRequest.java b/server/src/main/java/org/opensearch/http/HttpPipelinedRequest.java index 1ab0b0afd46eb..852c35e2417d4 100644 --- a/server/src/main/java/org/opensearch/http/HttpPipelinedRequest.java +++ b/server/src/main/java/org/opensearch/http/HttpPipelinedRequest.java @@ -39,6 +39,11 @@ import java.util.List; import java.util.Map; +/** + * Pipeline requests for http connections + * + * @opensearch.internal + */ public class HttpPipelinedRequest implements HttpRequest, HttpPipelinedMessage { private final int sequence; diff --git a/server/src/main/java/org/opensearch/http/HttpPipelinedResponse.java b/server/src/main/java/org/opensearch/http/HttpPipelinedResponse.java index 4729e8f47c5d6..c535d977c0e1a 100644 --- a/server/src/main/java/org/opensearch/http/HttpPipelinedResponse.java +++ b/server/src/main/java/org/opensearch/http/HttpPipelinedResponse.java @@ -31,6 +31,11 @@ package org.opensearch.http; +/** + * Pipeline responses for http connections + * + * @opensearch.internal + */ public class HttpPipelinedResponse implements HttpPipelinedMessage, HttpResponse { private final int sequence; diff --git a/server/src/main/java/org/opensearch/http/HttpPipeliningAggregator.java b/server/src/main/java/org/opensearch/http/HttpPipeliningAggregator.java index 46db0aa3a8c4f..df6eb01a0b157 100644 --- a/server/src/main/java/org/opensearch/http/HttpPipeliningAggregator.java +++ b/server/src/main/java/org/opensearch/http/HttpPipeliningAggregator.java @@ -38,6 +38,11 @@ import java.util.List; import java.util.PriorityQueue; +/** + * Aggregates HTTP requests + * + * @opensearch.internal + */ public class HttpPipeliningAggregator { private final int maxEventsHeld; diff --git a/server/src/main/java/org/opensearch/http/HttpReadTimeoutException.java b/server/src/main/java/org/opensearch/http/HttpReadTimeoutException.java index 86045f7bbbe28..2769ab12730bb 100644 --- a/server/src/main/java/org/opensearch/http/HttpReadTimeoutException.java +++ b/server/src/main/java/org/opensearch/http/HttpReadTimeoutException.java @@ -31,6 +31,11 @@ package org.opensearch.http; +/** + * Timeout Exception for HTTP read operations + * + * @opensearch.internal + */ public class HttpReadTimeoutException extends RuntimeException { public HttpReadTimeoutException(long readTimeoutMillis) { diff --git a/server/src/main/java/org/opensearch/http/HttpRequest.java b/server/src/main/java/org/opensearch/http/HttpRequest.java index e0d4e739f1fd4..83980c3539ddc 100644 --- a/server/src/main/java/org/opensearch/http/HttpRequest.java +++ b/server/src/main/java/org/opensearch/http/HttpRequest.java @@ -44,6 +44,8 @@ /** * A basic http request abstraction. Http modules needs to implement this interface to integrate with the * server package's rest handling. + * + * @opensearch.internal */ public interface HttpRequest { diff --git a/server/src/main/java/org/opensearch/http/HttpResponse.java b/server/src/main/java/org/opensearch/http/HttpResponse.java index bec0a6348cd07..3c8269f4400e7 100644 --- a/server/src/main/java/org/opensearch/http/HttpResponse.java +++ b/server/src/main/java/org/opensearch/http/HttpResponse.java @@ -35,6 +35,8 @@ /** * A basic http response abstraction. Http modules must implement this interface as the server package rest * handling needs to set http headers for a response. + * + * @opensearch.internal */ public interface HttpResponse { diff --git a/server/src/main/java/org/opensearch/http/HttpServerChannel.java b/server/src/main/java/org/opensearch/http/HttpServerChannel.java index 5b9ad2b36f0f4..e57f03c54ce24 100644 --- a/server/src/main/java/org/opensearch/http/HttpServerChannel.java +++ b/server/src/main/java/org/opensearch/http/HttpServerChannel.java @@ -36,6 +36,11 @@ import java.net.InetSocketAddress; +/** + * Http server channel + * + * @opensearch.internal + */ public interface HttpServerChannel extends CloseableChannel { /** diff --git a/server/src/main/java/org/opensearch/http/HttpServerTransport.java b/server/src/main/java/org/opensearch/http/HttpServerTransport.java index ad7378073f84f..425fa23047764 100644 --- a/server/src/main/java/org/opensearch/http/HttpServerTransport.java +++ b/server/src/main/java/org/opensearch/http/HttpServerTransport.java @@ -39,6 +39,11 @@ import org.opensearch.rest.RestChannel; import org.opensearch.rest.RestRequest; +/** + * HTTP Transport server + * + * @opensearch.internal + */ public interface HttpServerTransport extends LifecycleComponent, ReportingService { String HTTP_SERVER_WORKER_THREAD_NAME_PREFIX = "http_server_worker"; diff --git a/server/src/main/java/org/opensearch/http/HttpStats.java b/server/src/main/java/org/opensearch/http/HttpStats.java index 11450abcab020..c454853659443 100644 --- a/server/src/main/java/org/opensearch/http/HttpStats.java +++ b/server/src/main/java/org/opensearch/http/HttpStats.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Stats for HTTP connections + * + * @opensearch.internal + */ public class HttpStats implements Writeable, ToXContentFragment { private final long serverOpen; diff --git a/server/src/main/java/org/opensearch/http/HttpTracer.java b/server/src/main/java/org/opensearch/http/HttpTracer.java index a57694dc9adf4..bdabbb04d57f3 100644 --- a/server/src/main/java/org/opensearch/http/HttpTracer.java +++ b/server/src/main/java/org/opensearch/http/HttpTracer.java @@ -48,6 +48,8 @@ /** * Http request trace logger. See {@link #maybeTraceRequest(RestRequest, Exception)} for details. + * + * @opensearch.internal */ class HttpTracer { diff --git a/server/src/main/java/org/opensearch/http/HttpTransportSettings.java b/server/src/main/java/org/opensearch/http/HttpTransportSettings.java index 8ab881907fc2e..4522a59d67c05 100644 --- a/server/src/main/java/org/opensearch/http/HttpTransportSettings.java +++ b/server/src/main/java/org/opensearch/http/HttpTransportSettings.java @@ -50,6 +50,11 @@ import static org.opensearch.common.settings.Setting.intSetting; import static org.opensearch.common.settings.Setting.listSetting; +/** + * Transport settings for http connections + * + * @opensearch.internal + */ public final class HttpTransportSettings { public static final Setting SETTING_CORS_ENABLED = Setting.boolSetting("http.cors.enabled", false, Property.NodeScope); diff --git a/server/src/main/java/org/opensearch/http/HttpUtils.java b/server/src/main/java/org/opensearch/http/HttpUtils.java index 825e3ad756e78..39eee29a57ac3 100644 --- a/server/src/main/java/org/opensearch/http/HttpUtils.java +++ b/server/src/main/java/org/opensearch/http/HttpUtils.java @@ -32,6 +32,11 @@ package org.opensearch.http; +/** + * Utility class for HTTP connections + * + * @opensearch.internal + */ public class HttpUtils { static final String CLOSE = "close"; diff --git a/server/src/main/java/org/opensearch/ingest/AbstractProcessor.java b/server/src/main/java/org/opensearch/ingest/AbstractProcessor.java index a9547f9edeb86..6c22d1b7d21c0 100644 --- a/server/src/main/java/org/opensearch/ingest/AbstractProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/AbstractProcessor.java @@ -35,6 +35,8 @@ /** * An Abstract Processor that holds tag and description information * about the processor. + * + * @opensearch.internal */ public abstract class AbstractProcessor implements Processor { protected final String tag; diff --git a/server/src/main/java/org/opensearch/ingest/CompoundProcessor.java b/server/src/main/java/org/opensearch/ingest/CompoundProcessor.java index 0857cdd7f9f19..8cdbc487dc137 100644 --- a/server/src/main/java/org/opensearch/ingest/CompoundProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/CompoundProcessor.java @@ -48,6 +48,8 @@ /** * A Processor that executes a list of other "processors". It executes a separate list of * "onFailureProcessors" when any of the processors throw an {@link Exception}. + * + * @opensearch.internal */ public class CompoundProcessor implements Processor { public static final String ON_FAILURE_MESSAGE_FIELD = "on_failure_message"; diff --git a/server/src/main/java/org/opensearch/ingest/ConditionalProcessor.java b/server/src/main/java/org/opensearch/ingest/ConditionalProcessor.java index dcb249d75afc6..7d4a2b32fbb5f 100644 --- a/server/src/main/java/org/opensearch/ingest/ConditionalProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/ConditionalProcessor.java @@ -57,6 +57,11 @@ import static org.opensearch.ingest.ConfigurationUtils.newConfigurationException; +/** + * Ingest processor based on specific conditions + * + * @opensearch.internal + */ public class ConditionalProcessor extends AbstractProcessor implements WrappingProcessor { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(DynamicMap.class); diff --git a/server/src/main/java/org/opensearch/ingest/ConfigurationUtils.java b/server/src/main/java/org/opensearch/ingest/ConfigurationUtils.java index 2f8516181b5e3..1a49e7407942e 100644 --- a/server/src/main/java/org/opensearch/ingest/ConfigurationUtils.java +++ b/server/src/main/java/org/opensearch/ingest/ConfigurationUtils.java @@ -58,6 +58,11 @@ import static org.opensearch.script.Script.DEFAULT_TEMPLATE_LANG; +/** + * Utility class for ingest processor configurations + * + * @opensearch.internal + */ public final class ConfigurationUtils { public static final String TAG_KEY = "tag"; diff --git a/server/src/main/java/org/opensearch/ingest/DropProcessor.java b/server/src/main/java/org/opensearch/ingest/DropProcessor.java index 8a9662a31d7c9..b3110755fa2d2 100644 --- a/server/src/main/java/org/opensearch/ingest/DropProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/DropProcessor.java @@ -37,6 +37,8 @@ /** * Drop processor only returns {@code null} for the execution result to indicate that any document * executed by it should not be indexed. + * + * @opensearch.internal */ public final class DropProcessor extends AbstractProcessor { diff --git a/server/src/main/java/org/opensearch/ingest/IngestDocument.java b/server/src/main/java/org/opensearch/ingest/IngestDocument.java index b18946486f8c6..e1759342da7ef 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestDocument.java +++ b/server/src/main/java/org/opensearch/ingest/IngestDocument.java @@ -59,6 +59,8 @@ /** * Represents a single document being captured before indexing and holds the source and metadata (like id, type and index). + * + * @opensearch.internal */ public final class IngestDocument { diff --git a/server/src/main/java/org/opensearch/ingest/IngestInfo.java b/server/src/main/java/org/opensearch/ingest/IngestInfo.java index e8d4e0dc0a73e..75c3202c6e14c 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestInfo.java +++ b/server/src/main/java/org/opensearch/ingest/IngestInfo.java @@ -43,6 +43,11 @@ import java.util.Set; import java.util.TreeSet; +/** + * Information about an ingest event + * + * @opensearch.internal + */ public class IngestInfo implements ReportingService.Info { private final Set processors; diff --git a/server/src/main/java/org/opensearch/ingest/IngestMetadata.java b/server/src/main/java/org/opensearch/ingest/IngestMetadata.java index 36fea51e2e2f2..f55ba28e9c304 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestMetadata.java +++ b/server/src/main/java/org/opensearch/ingest/IngestMetadata.java @@ -54,6 +54,8 @@ /** * Holds the ingest pipelines that are available in the cluster + * + * @opensearch.internal */ public final class IngestMetadata implements Metadata.Custom { diff --git a/server/src/main/java/org/opensearch/ingest/IngestMetric.java b/server/src/main/java/org/opensearch/ingest/IngestMetric.java index aac8c810f772a..2d4a1dc9cfdee 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestMetric.java +++ b/server/src/main/java/org/opensearch/ingest/IngestMetric.java @@ -43,6 +43,8 @@ * The scope is determined by the calling code. For example you can use this class to count all documents across all pipeline, * or you can use this class to count documents for a given pipeline or a specific processor. * This class does not make assumptions about it's given scope. + * + * @opensearch.internal */ class IngestMetric { diff --git a/server/src/main/java/org/opensearch/ingest/IngestProcessorException.java b/server/src/main/java/org/opensearch/ingest/IngestProcessorException.java index 72e1cde5cac69..eccc81cf62459 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestProcessorException.java +++ b/server/src/main/java/org/opensearch/ingest/IngestProcessorException.java @@ -41,6 +41,8 @@ /** * A dedicated wrapper for exceptions encountered executing an ingest processor. The wrapper is needed as we currently only unwrap causes * for instances of {@link OpenSearchWrapperException}. + * + * @opensearch.internal */ public class IngestProcessorException extends OpenSearchException implements OpenSearchWrapperException { diff --git a/server/src/main/java/org/opensearch/ingest/IngestService.java b/server/src/main/java/org/opensearch/ingest/IngestService.java index cbd5fa71b27de..b8256fe896da4 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestService.java +++ b/server/src/main/java/org/opensearch/ingest/IngestService.java @@ -92,6 +92,8 @@ /** * Holder class for several ingest related services. + * + * @opensearch.internal */ public class IngestService implements ClusterStateApplier, ReportingService { diff --git a/server/src/main/java/org/opensearch/ingest/IngestStats.java b/server/src/main/java/org/opensearch/ingest/IngestStats.java index c1b08cb7e62f9..115ae66113462 100644 --- a/server/src/main/java/org/opensearch/ingest/IngestStats.java +++ b/server/src/main/java/org/opensearch/ingest/IngestStats.java @@ -49,6 +49,11 @@ import java.util.Objects; import java.util.concurrent.TimeUnit; +/** + * Stats for an ingest processor pipeline + * + * @opensearch.internal + */ public class IngestStats implements Writeable, ToXContentFragment { private final Stats totalStats; private final List pipelineStats; diff --git a/server/src/main/java/org/opensearch/ingest/Pipeline.java b/server/src/main/java/org/opensearch/ingest/Pipeline.java index 7447213257c24..9b3725fd65d9d 100644 --- a/server/src/main/java/org/opensearch/ingest/Pipeline.java +++ b/server/src/main/java/org/opensearch/ingest/Pipeline.java @@ -47,6 +47,8 @@ /** * A pipeline is a list of {@link Processor} instances grouped under a unique id. + * + * @opensearch.internal */ public final class Pipeline { diff --git a/server/src/main/java/org/opensearch/ingest/PipelineConfiguration.java b/server/src/main/java/org/opensearch/ingest/PipelineConfiguration.java index 0e58cea3c9904..5bc4abd83d6b2 100644 --- a/server/src/main/java/org/opensearch/ingest/PipelineConfiguration.java +++ b/server/src/main/java/org/opensearch/ingest/PipelineConfiguration.java @@ -52,6 +52,8 @@ /** * Encapsulates a pipeline's id and configuration as a blob + * + * @opensearch.internal */ public final class PipelineConfiguration extends AbstractDiffable implements ToXContentObject { diff --git a/server/src/main/java/org/opensearch/ingest/PipelineProcessor.java b/server/src/main/java/org/opensearch/ingest/PipelineProcessor.java index 5bb651e84bc0b..62226ef7682cb 100644 --- a/server/src/main/java/org/opensearch/ingest/PipelineProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/PipelineProcessor.java @@ -37,6 +37,11 @@ import java.util.Map; import java.util.function.BiConsumer; +/** + * Processes an ingest pipeline + * + * @opensearch.internal + */ public class PipelineProcessor extends AbstractProcessor { public static final String TYPE = "pipeline"; diff --git a/server/src/main/java/org/opensearch/ingest/Processor.java b/server/src/main/java/org/opensearch/ingest/Processor.java index 84fa0e9496bd7..e0f196dfcb115 100644 --- a/server/src/main/java/org/opensearch/ingest/Processor.java +++ b/server/src/main/java/org/opensearch/ingest/Processor.java @@ -50,6 +50,8 @@ * Whether changes are made and what exactly is modified is up to the implementation. * * Processors may get called concurrently and thus need to be thread-safe. + * + * @opensearch.internal */ public interface Processor { diff --git a/server/src/main/java/org/opensearch/ingest/ProcessorInfo.java b/server/src/main/java/org/opensearch/ingest/ProcessorInfo.java index b4ea371f8e3ba..eb8add867c2ac 100644 --- a/server/src/main/java/org/opensearch/ingest/ProcessorInfo.java +++ b/server/src/main/java/org/opensearch/ingest/ProcessorInfo.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Information about an ingest processor + * + * @opensearch.internal + */ public class ProcessorInfo implements Writeable, ToXContentObject, Comparable { private final String type; diff --git a/server/src/main/java/org/opensearch/ingest/TrackingResultProcessor.java b/server/src/main/java/org/opensearch/ingest/TrackingResultProcessor.java index efcb3b8d9840f..0362922617eee 100644 --- a/server/src/main/java/org/opensearch/ingest/TrackingResultProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/TrackingResultProcessor.java @@ -44,6 +44,8 @@ /** * Processor to be used within Simulate API to keep track of processors executed in pipeline. + * + * @opensearch.internal */ public final class TrackingResultProcessor implements Processor { diff --git a/server/src/main/java/org/opensearch/ingest/ValueSource.java b/server/src/main/java/org/opensearch/ingest/ValueSource.java index c5936b0fa4a1a..fefa535797e27 100644 --- a/server/src/main/java/org/opensearch/ingest/ValueSource.java +++ b/server/src/main/java/org/opensearch/ingest/ValueSource.java @@ -49,6 +49,8 @@ /** * Holds a value. If the value is requested a copy is made and optionally template snippets are resolved too. + * + * @opensearch.internal */ public interface ValueSource { diff --git a/server/src/main/java/org/opensearch/ingest/WrappingProcessor.java b/server/src/main/java/org/opensearch/ingest/WrappingProcessor.java index 33db293b510eb..b40ff7be3eb24 100644 --- a/server/src/main/java/org/opensearch/ingest/WrappingProcessor.java +++ b/server/src/main/java/org/opensearch/ingest/WrappingProcessor.java @@ -35,6 +35,8 @@ /** * A srapping processor is one that encapsulates an inner processor, or a processor that the wrapped processor enacts upon. All processors * that contain an "inner" processor should implement this interface, such that the actual processor can be obtained. + * + * @opensearch.internal */ public interface WrappingProcessor extends Processor { diff --git a/server/src/main/java/org/opensearch/lucene/queries/MinDocQuery.java b/server/src/main/java/org/opensearch/lucene/queries/MinDocQuery.java index a7dbadb32ccf2..2af0237e800c0 100644 --- a/server/src/main/java/org/opensearch/lucene/queries/MinDocQuery.java +++ b/server/src/main/java/org/opensearch/lucene/queries/MinDocQuery.java @@ -48,7 +48,10 @@ import java.util.Objects; /** A {@link Query} that only matches documents that are greater than or equal - * to a configured doc ID. */ + * to a configured doc ID. + * + * @opensearch.internal + */ public final class MinDocQuery extends Query { // Matching documents depend on the sequence of segments that the index reader diff --git a/server/src/main/java/org/opensearch/lucene/queries/SearchAfterSortedDocQuery.java b/server/src/main/java/org/opensearch/lucene/queries/SearchAfterSortedDocQuery.java index 70cc73d2108cc..e417a2eaa7cf4 100644 --- a/server/src/main/java/org/opensearch/lucene/queries/SearchAfterSortedDocQuery.java +++ b/server/src/main/java/org/opensearch/lucene/queries/SearchAfterSortedDocQuery.java @@ -56,6 +56,7 @@ /** * A {@link Query} that only matches documents that are greater than the provided {@link FieldDoc}. * This works only if the index is sorted according to the given search {@link Sort}. + * @opensearch.internal */ public class SearchAfterSortedDocQuery extends Query { private final Sort sort; diff --git a/server/src/main/java/org/opensearch/node/AdaptiveSelectionStats.java b/server/src/main/java/org/opensearch/node/AdaptiveSelectionStats.java index 5102d78523abe..8501987e5bb8d 100644 --- a/server/src/main/java/org/opensearch/node/AdaptiveSelectionStats.java +++ b/server/src/main/java/org/opensearch/node/AdaptiveSelectionStats.java @@ -52,6 +52,8 @@ * Class representing statistics about adaptive replica selection. This includes * EWMA of queue size, service time, and response time, as well as outgoing * searches to each node and the "rank" based on the ARS formula. + * + * @opensearch.internal */ public class AdaptiveSelectionStats implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/node/InternalSettingsPreparer.java b/server/src/main/java/org/opensearch/node/InternalSettingsPreparer.java index 9d10cd139c741..4038ae56d6ffe 100644 --- a/server/src/main/java/org/opensearch/node/InternalSettingsPreparer.java +++ b/server/src/main/java/org/opensearch/node/InternalSettingsPreparer.java @@ -48,6 +48,11 @@ import org.opensearch.common.settings.SettingsException; import org.opensearch.env.Environment; +/** + * Prepares internal settings + * + * @opensearch.internal + */ public class InternalSettingsPreparer { private static final String SECRET_PROMPT_VALUE = "${prompt.secret}"; diff --git a/server/src/main/java/org/opensearch/node/Node.java b/server/src/main/java/org/opensearch/node/Node.java index c1152afd6fe44..c09bdc11693c4 100644 --- a/server/src/main/java/org/opensearch/node/Node.java +++ b/server/src/main/java/org/opensearch/node/Node.java @@ -224,6 +224,8 @@ /** * A node represent a node within a cluster ({@code cluster.name}). The {@link #client()} can be used * in order to use a {@link Client} to perform actions/operations against the cluster. + * + * @opensearch.internal */ public class Node implements Closeable { public static final Setting WRITE_PORTS_FILE_SETTING = Setting.boolSetting("node.portsfile", false, Property.NodeScope); diff --git a/server/src/main/java/org/opensearch/node/NodeClosedException.java b/server/src/main/java/org/opensearch/node/NodeClosedException.java index f2b15cf301525..a62a8a4a23684 100644 --- a/server/src/main/java/org/opensearch/node/NodeClosedException.java +++ b/server/src/main/java/org/opensearch/node/NodeClosedException.java @@ -41,7 +41,7 @@ /** * An exception indicating that node is closed. * - * + * @opensearch.internal */ public class NodeClosedException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/node/NodeRoleSettings.java b/server/src/main/java/org/opensearch/node/NodeRoleSettings.java index d690cfa4caa69..6caf859ee6bd3 100644 --- a/server/src/main/java/org/opensearch/node/NodeRoleSettings.java +++ b/server/src/main/java/org/opensearch/node/NodeRoleSettings.java @@ -40,6 +40,11 @@ import java.util.List; import java.util.stream.Collectors; +/** + * Settings for a node role + * + * @opensearch.internal + */ public class NodeRoleSettings { public static final Setting> NODE_ROLES_SETTING = Setting.listSetting( diff --git a/server/src/main/java/org/opensearch/node/NodeService.java b/server/src/main/java/org/opensearch/node/NodeService.java index cf79b1e1ebe22..ab98b47c7287b 100644 --- a/server/src/main/java/org/opensearch/node/NodeService.java +++ b/server/src/main/java/org/opensearch/node/NodeService.java @@ -60,6 +60,11 @@ import java.io.IOException; import java.util.concurrent.TimeUnit; +/** + * Services exposed to nodes + * + * @opensearch.internal + */ public class NodeService implements Closeable { private final Settings settings; private final ThreadPool threadPool; diff --git a/server/src/main/java/org/opensearch/node/NodeValidationException.java b/server/src/main/java/org/opensearch/node/NodeValidationException.java index a50c52176ea02..ef1500f1e4ede 100644 --- a/server/src/main/java/org/opensearch/node/NodeValidationException.java +++ b/server/src/main/java/org/opensearch/node/NodeValidationException.java @@ -41,6 +41,8 @@ * begins accepting network requests in * {@link Node#validateNodeBeforeAcceptingRequests(org.opensearch.bootstrap.BootstrapContext, BoundTransportAddress, List)}. * This exception is a checked exception that is declared as thrown from this method for the purpose of bubbling up to the user. + * + * @opensearch.internal */ public class NodeValidationException extends Exception { diff --git a/server/src/main/java/org/opensearch/node/ReportingService.java b/server/src/main/java/org/opensearch/node/ReportingService.java index 3d81a0f8976a5..97d4b2a1bafaa 100644 --- a/server/src/main/java/org/opensearch/node/ReportingService.java +++ b/server/src/main/java/org/opensearch/node/ReportingService.java @@ -35,6 +35,11 @@ import org.opensearch.common.io.stream.Writeable; import org.opensearch.common.xcontent.ToXContent; +/** + * Node reporting service + * + * @opensearch.internal + */ public interface ReportingService { I info(); diff --git a/server/src/main/java/org/opensearch/node/ResponseCollectorService.java b/server/src/main/java/org/opensearch/node/ResponseCollectorService.java index 869d84bc6e6b4..fd246a4ccb25e 100644 --- a/server/src/main/java/org/opensearch/node/ResponseCollectorService.java +++ b/server/src/main/java/org/opensearch/node/ResponseCollectorService.java @@ -53,6 +53,8 @@ * Collects statistics about queue size, response time, and service time of * tasks executed on each node, making the EWMA of the values available to the * coordinating node. + * + * @opensearch.internal */ public final class ResponseCollectorService implements ClusterStateListener {