From a7715ab6cedebc8c86ad620f6a250a2994eae4c8 Mon Sep 17 00:00:00 2001 From: Nick Knize Date: Fri, 6 May 2022 08:36:04 -0500 Subject: [PATCH] [Javadocs] add to o.o.transport (#3220) Adds javadocs to the org.opensearch.transport package. Signed-off-by: Nicholas Walter Knize --- .../transport/ActionNotFoundTransportException.java | 2 +- .../org/opensearch/transport/ActionTransportException.java | 2 +- .../org/opensearch/transport/BindTransportException.java | 5 +++++ .../java/org/opensearch/transport/BytesTransportRequest.java | 2 ++ .../java/org/opensearch/transport/CloseableConnection.java | 2 ++ .../org/opensearch/transport/ClusterConnectionManager.java | 2 ++ .../opensearch/transport/CompressibleBytesOutputStream.java | 2 ++ .../org/opensearch/transport/ConnectTransportException.java | 5 +++++ .../java/org/opensearch/transport/ConnectionManager.java | 5 +++++ .../java/org/opensearch/transport/ConnectionProfile.java | 2 ++ .../opensearch/transport/EmptyTransportResponseHandler.java | 5 +++++ .../opensearch/transport/FutureTransportResponseHandler.java | 2 ++ server/src/main/java/org/opensearch/transport/Header.java | 5 +++++ .../java/org/opensearch/transport/InboundAggregator.java | 5 +++++ .../main/java/org/opensearch/transport/InboundDecoder.java | 5 +++++ .../main/java/org/opensearch/transport/InboundHandler.java | 5 +++++ .../main/java/org/opensearch/transport/InboundMessage.java | 5 +++++ .../main/java/org/opensearch/transport/InboundPipeline.java | 5 +++++ .../main/java/org/opensearch/transport/NetworkMessage.java | 2 ++ .../org/opensearch/transport/NoSeedNodeLeftException.java | 2 ++ .../opensearch/transport/NoSuchRemoteClusterException.java | 2 ++ .../org/opensearch/transport/NodeDisconnectedException.java | 5 +++++ .../org/opensearch/transport/NodeNotConnectedException.java | 2 +- .../opensearch/transport/NodeShouldNotConnectException.java | 5 +++++ .../transport/NotSerializableTransportException.java | 5 +++++ .../main/java/org/opensearch/transport/OutboundHandler.java | 5 +++++ .../main/java/org/opensearch/transport/OutboundMessage.java | 5 +++++ .../java/org/opensearch/transport/PlainTransportFuture.java | 5 +++++ .../org/opensearch/transport/ProxyConnectionStrategy.java | 5 +++++ .../transport/ReceiveTimeoutTransportException.java | 5 +++++ .../java/org/opensearch/transport/RemoteClusterAware.java | 2 ++ .../org/opensearch/transport/RemoteClusterAwareClient.java | 5 +++++ .../org/opensearch/transport/RemoteClusterAwareRequest.java | 5 +++++ .../org/opensearch/transport/RemoteClusterConnection.java | 2 ++ .../java/org/opensearch/transport/RemoteClusterService.java | 2 ++ .../java/org/opensearch/transport/RemoteConnectionInfo.java | 2 ++ .../org/opensearch/transport/RemoteConnectionManager.java | 5 +++++ .../org/opensearch/transport/RemoteConnectionStrategy.java | 5 +++++ .../org/opensearch/transport/RemoteTransportException.java | 2 +- .../transport/ResponseHandlerFailureTransportException.java | 2 ++ .../opensearch/transport/SendRequestTransportException.java | 5 +++++ .../org/opensearch/transport/SniffConnectionStrategy.java | 5 +++++ .../java/org/opensearch/transport/TaskTransportChannel.java | 5 +++++ .../src/main/java/org/opensearch/transport/TcpChannel.java | 2 ++ server/src/main/java/org/opensearch/transport/TcpHeader.java | 5 +++++ .../main/java/org/opensearch/transport/TcpServerChannel.java | 2 ++ .../src/main/java/org/opensearch/transport/TcpTransport.java | 5 +++++ .../java/org/opensearch/transport/TcpTransportChannel.java | 5 +++++ server/src/main/java/org/opensearch/transport/Transport.java | 5 +++++ .../java/org/opensearch/transport/TransportActionProxy.java | 2 ++ .../main/java/org/opensearch/transport/TransportChannel.java | 2 ++ .../opensearch/transport/TransportConnectionListener.java | 2 ++ .../java/org/opensearch/transport/TransportDecompressor.java | 5 +++++ .../java/org/opensearch/transport/TransportException.java | 5 +++++ .../main/java/org/opensearch/transport/TransportFuture.java | 5 +++++ .../java/org/opensearch/transport/TransportHandshaker.java | 2 ++ .../main/java/org/opensearch/transport/TransportInfo.java | 5 +++++ .../java/org/opensearch/transport/TransportInterceptor.java | 2 ++ .../java/org/opensearch/transport/TransportKeepAlive.java | 2 ++ .../main/java/org/opensearch/transport/TransportLogger.java | 5 +++++ .../main/java/org/opensearch/transport/TransportMessage.java | 5 +++++ .../org/opensearch/transport/TransportMessageListener.java | 5 +++++ .../main/java/org/opensearch/transport/TransportRequest.java | 5 +++++ .../opensearch/transport/TransportRequestDeduplicator.java | 2 ++ .../org/opensearch/transport/TransportRequestHandler.java | 5 +++++ .../org/opensearch/transport/TransportRequestOptions.java | 5 +++++ .../java/org/opensearch/transport/TransportResponse.java | 5 +++++ .../org/opensearch/transport/TransportResponseHandler.java | 5 +++++ .../transport/TransportSerializationException.java | 5 +++++ .../main/java/org/opensearch/transport/TransportService.java | 5 +++++ .../java/org/opensearch/transport/TransportSettings.java | 5 +++++ .../main/java/org/opensearch/transport/TransportStats.java | 5 +++++ .../main/java/org/opensearch/transport/TransportStatus.java | 5 +++++ .../src/main/java/org/opensearch/transport/Transports.java | 5 +++++ 74 files changed, 285 insertions(+), 4 deletions(-) diff --git a/server/src/main/java/org/opensearch/transport/ActionNotFoundTransportException.java b/server/src/main/java/org/opensearch/transport/ActionNotFoundTransportException.java index c9d064261cc30..0f12c63a1b58e 100644 --- a/server/src/main/java/org/opensearch/transport/ActionNotFoundTransportException.java +++ b/server/src/main/java/org/opensearch/transport/ActionNotFoundTransportException.java @@ -40,7 +40,7 @@ /** * An exception indicating that a transport action was not found. * - * + * @opensearch.internal */ public class ActionNotFoundTransportException extends TransportException { diff --git a/server/src/main/java/org/opensearch/transport/ActionTransportException.java b/server/src/main/java/org/opensearch/transport/ActionTransportException.java index 387f150710645..c9fbddec941b3 100644 --- a/server/src/main/java/org/opensearch/transport/ActionTransportException.java +++ b/server/src/main/java/org/opensearch/transport/ActionTransportException.java @@ -41,7 +41,7 @@ /** * An action invocation failure. * - * + * @opensearch.internal */ public class ActionTransportException extends TransportException { diff --git a/server/src/main/java/org/opensearch/transport/BindTransportException.java b/server/src/main/java/org/opensearch/transport/BindTransportException.java index 827a45ba0161d..918906e2b4759 100644 --- a/server/src/main/java/org/opensearch/transport/BindTransportException.java +++ b/server/src/main/java/org/opensearch/transport/BindTransportException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * A transport binding failure. + * + * @opensearch.internal + */ public class BindTransportException extends TransportException { public BindTransportException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/transport/BytesTransportRequest.java b/server/src/main/java/org/opensearch/transport/BytesTransportRequest.java index 75e35a1cdcce2..cb623adf1c26b 100644 --- a/server/src/main/java/org/opensearch/transport/BytesTransportRequest.java +++ b/server/src/main/java/org/opensearch/transport/BytesTransportRequest.java @@ -42,6 +42,8 @@ /** * A specialized, bytes only request, that can potentially be optimized on the network * layer, specifically for the same large buffer send to several nodes. + * + * @opensearch.internal */ public class BytesTransportRequest extends TransportRequest { diff --git a/server/src/main/java/org/opensearch/transport/CloseableConnection.java b/server/src/main/java/org/opensearch/transport/CloseableConnection.java index 7d59279e1bac7..b612f2bd17e0f 100644 --- a/server/src/main/java/org/opensearch/transport/CloseableConnection.java +++ b/server/src/main/java/org/opensearch/transport/CloseableConnection.java @@ -37,6 +37,8 @@ /** * Abstract Transport.Connection that provides common close logic. + * + * @opensearch.internal */ public abstract class CloseableConnection implements Transport.Connection { diff --git a/server/src/main/java/org/opensearch/transport/ClusterConnectionManager.java b/server/src/main/java/org/opensearch/transport/ClusterConnectionManager.java index c44b3cf11c14d..5616980254adf 100644 --- a/server/src/main/java/org/opensearch/transport/ClusterConnectionManager.java +++ b/server/src/main/java/org/opensearch/transport/ClusterConnectionManager.java @@ -55,6 +55,8 @@ * This class manages node connections within a cluster. The connection is opened by the underlying transport. * Once the connection is opened, this class manages the connection. This includes closing the connection when * the connection manager is closed. + * + * @opensearch.internal */ public class ClusterConnectionManager implements ConnectionManager { diff --git a/server/src/main/java/org/opensearch/transport/CompressibleBytesOutputStream.java b/server/src/main/java/org/opensearch/transport/CompressibleBytesOutputStream.java index 3d2af65127362..5c11694431fc5 100644 --- a/server/src/main/java/org/opensearch/transport/CompressibleBytesOutputStream.java +++ b/server/src/main/java/org/opensearch/transport/CompressibleBytesOutputStream.java @@ -55,6 +55,8 @@ * * {@link CompressibleBytesOutputStream#close()} will NOT close the underlying stream. The byte stream passed * in the constructor must be closed individually. + * + * @opensearch.internal */ final class CompressibleBytesOutputStream extends StreamOutput { diff --git a/server/src/main/java/org/opensearch/transport/ConnectTransportException.java b/server/src/main/java/org/opensearch/transport/ConnectTransportException.java index 5c5ce933647c6..0267cab686264 100644 --- a/server/src/main/java/org/opensearch/transport/ConnectTransportException.java +++ b/server/src/main/java/org/opensearch/transport/ConnectTransportException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Transport connection exception + * + * @opensearch.internal + */ public class ConnectTransportException extends ActionTransportException { private final DiscoveryNode node; diff --git a/server/src/main/java/org/opensearch/transport/ConnectionManager.java b/server/src/main/java/org/opensearch/transport/ConnectionManager.java index dfac5acfc9230..3fcd05029a4c9 100644 --- a/server/src/main/java/org/opensearch/transport/ConnectionManager.java +++ b/server/src/main/java/org/opensearch/transport/ConnectionManager.java @@ -39,6 +39,11 @@ import java.util.Set; import java.util.concurrent.CopyOnWriteArrayList; +/** + * Transport connection manager. + * + * @opensearch.internal + */ public interface ConnectionManager extends Closeable { void addListener(TransportConnectionListener listener); diff --git a/server/src/main/java/org/opensearch/transport/ConnectionProfile.java b/server/src/main/java/org/opensearch/transport/ConnectionProfile.java index 61129565b23f3..5b657efcabd3e 100644 --- a/server/src/main/java/org/opensearch/transport/ConnectionProfile.java +++ b/server/src/main/java/org/opensearch/transport/ConnectionProfile.java @@ -48,6 +48,8 @@ /** * A connection profile describes how many connection are established to specific node for each of the available request types. * ({@link org.opensearch.transport.TransportRequestOptions.Type}). This allows to tailor a connection towards a specific usage. + * + * @opensearch.internal */ public final class ConnectionProfile { diff --git a/server/src/main/java/org/opensearch/transport/EmptyTransportResponseHandler.java b/server/src/main/java/org/opensearch/transport/EmptyTransportResponseHandler.java index b76ede361cada..c4fd78fd72ef4 100644 --- a/server/src/main/java/org/opensearch/transport/EmptyTransportResponseHandler.java +++ b/server/src/main/java/org/opensearch/transport/EmptyTransportResponseHandler.java @@ -35,6 +35,11 @@ import org.opensearch.common.io.stream.StreamInput; import org.opensearch.threadpool.ThreadPool; +/** + * Handler for empty transport response + * + * @opensearch.internal + */ public class EmptyTransportResponseHandler implements TransportResponseHandler { public static final EmptyTransportResponseHandler INSTANCE_SAME = new EmptyTransportResponseHandler(ThreadPool.Names.SAME); diff --git a/server/src/main/java/org/opensearch/transport/FutureTransportResponseHandler.java b/server/src/main/java/org/opensearch/transport/FutureTransportResponseHandler.java index 4d8bca6d99a9a..71651274ede40 100644 --- a/server/src/main/java/org/opensearch/transport/FutureTransportResponseHandler.java +++ b/server/src/main/java/org/opensearch/transport/FutureTransportResponseHandler.java @@ -36,6 +36,8 @@ /** * A response handler to be used when all interaction will be done through the {@link TransportFuture}. + * + * @opensearch.internal */ public abstract class FutureTransportResponseHandler implements TransportResponseHandler { diff --git a/server/src/main/java/org/opensearch/transport/Header.java b/server/src/main/java/org/opensearch/transport/Header.java index 009a362527e9c..f73d3fcc74e72 100644 --- a/server/src/main/java/org/opensearch/transport/Header.java +++ b/server/src/main/java/org/opensearch/transport/Header.java @@ -44,6 +44,11 @@ import java.util.Set; import java.util.TreeSet; +/** + * Transport Header + * + * @opensearch.internal + */ public class Header { private static final String RESPONSE_NAME = "NO_ACTION_NAME_FOR_RESPONSES"; diff --git a/server/src/main/java/org/opensearch/transport/InboundAggregator.java b/server/src/main/java/org/opensearch/transport/InboundAggregator.java index a6e8ce6e14aa7..321db13751906 100644 --- a/server/src/main/java/org/opensearch/transport/InboundAggregator.java +++ b/server/src/main/java/org/opensearch/transport/InboundAggregator.java @@ -48,6 +48,11 @@ import java.util.function.Predicate; import java.util.function.Supplier; +/** + * Aggregates inbound data + * + * @opensearch.internal + */ public class InboundAggregator implements Releasable { private final Supplier circuitBreaker; diff --git a/server/src/main/java/org/opensearch/transport/InboundDecoder.java b/server/src/main/java/org/opensearch/transport/InboundDecoder.java index 342a076774896..57673d16aa8dc 100644 --- a/server/src/main/java/org/opensearch/transport/InboundDecoder.java +++ b/server/src/main/java/org/opensearch/transport/InboundDecoder.java @@ -43,6 +43,11 @@ import java.io.IOException; import java.util.function.Consumer; +/** + * Decodes inbound data off the wire + * + * @opensearch.internal + */ public class InboundDecoder implements Releasable { static final Object PING = new Object(); diff --git a/server/src/main/java/org/opensearch/transport/InboundHandler.java b/server/src/main/java/org/opensearch/transport/InboundHandler.java index 6aa319934b478..21a23461c1b8a 100644 --- a/server/src/main/java/org/opensearch/transport/InboundHandler.java +++ b/server/src/main/java/org/opensearch/transport/InboundHandler.java @@ -52,6 +52,11 @@ import java.net.InetSocketAddress; import java.nio.ByteBuffer; +/** + * Handler for inbound data + * + * @opensearch.internal + */ public class InboundHandler { private static final Logger logger = LogManager.getLogger(InboundHandler.class); diff --git a/server/src/main/java/org/opensearch/transport/InboundMessage.java b/server/src/main/java/org/opensearch/transport/InboundMessage.java index 7835771ec4d8e..815f77779d139 100644 --- a/server/src/main/java/org/opensearch/transport/InboundMessage.java +++ b/server/src/main/java/org/opensearch/transport/InboundMessage.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Inbound data as a message + * + * @opensearch.internal + */ public class InboundMessage implements Releasable { private final Header header; diff --git a/server/src/main/java/org/opensearch/transport/InboundPipeline.java b/server/src/main/java/org/opensearch/transport/InboundPipeline.java index 924b9f995eccf..aeb2e228d125c 100644 --- a/server/src/main/java/org/opensearch/transport/InboundPipeline.java +++ b/server/src/main/java/org/opensearch/transport/InboundPipeline.java @@ -48,6 +48,11 @@ import java.util.function.LongSupplier; import java.util.function.Supplier; +/** + * Pipeline for receiving inbound messages + * + * @opensearch.internal + */ public class InboundPipeline implements Releasable { private static final ThreadLocal> fragmentList = ThreadLocal.withInitial(ArrayList::new); diff --git a/server/src/main/java/org/opensearch/transport/NetworkMessage.java b/server/src/main/java/org/opensearch/transport/NetworkMessage.java index 8dd6c740d72e4..6b53935a863dd 100644 --- a/server/src/main/java/org/opensearch/transport/NetworkMessage.java +++ b/server/src/main/java/org/opensearch/transport/NetworkMessage.java @@ -38,6 +38,8 @@ /** * Represents a transport message sent over the network. Subclasses implement serialization and * deserialization. + * + * @opensearch.internal */ public abstract class NetworkMessage { diff --git a/server/src/main/java/org/opensearch/transport/NoSeedNodeLeftException.java b/server/src/main/java/org/opensearch/transport/NoSeedNodeLeftException.java index fb3978b346275..4a75889d08e17 100644 --- a/server/src/main/java/org/opensearch/transport/NoSeedNodeLeftException.java +++ b/server/src/main/java/org/opensearch/transport/NoSeedNodeLeftException.java @@ -39,6 +39,8 @@ /** * Thrown after failed to connect to all seed nodes of the remote cluster. + * + * @opensearch.internal */ public class NoSeedNodeLeftException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/transport/NoSuchRemoteClusterException.java b/server/src/main/java/org/opensearch/transport/NoSuchRemoteClusterException.java index 9a91d19d70f5d..cc6c349191b8f 100644 --- a/server/src/main/java/org/opensearch/transport/NoSuchRemoteClusterException.java +++ b/server/src/main/java/org/opensearch/transport/NoSuchRemoteClusterException.java @@ -40,6 +40,8 @@ /** * An exception that remote cluster is missing or * connectivity to the remote connection is failing + * + * @opensearch.internal */ public final class NoSuchRemoteClusterException extends ResourceNotFoundException { diff --git a/server/src/main/java/org/opensearch/transport/NodeDisconnectedException.java b/server/src/main/java/org/opensearch/transport/NodeDisconnectedException.java index d43fe105dcd43..e12f84a5de70c 100644 --- a/server/src/main/java/org/opensearch/transport/NodeDisconnectedException.java +++ b/server/src/main/java/org/opensearch/transport/NodeDisconnectedException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if a node disconnects + * + * @opensearch.internal + */ public class NodeDisconnectedException extends ConnectTransportException { public NodeDisconnectedException(DiscoveryNode node, String action) { diff --git a/server/src/main/java/org/opensearch/transport/NodeNotConnectedException.java b/server/src/main/java/org/opensearch/transport/NodeNotConnectedException.java index 134c1f7c08a3c..a94adb0ec5678 100644 --- a/server/src/main/java/org/opensearch/transport/NodeNotConnectedException.java +++ b/server/src/main/java/org/opensearch/transport/NodeNotConnectedException.java @@ -40,7 +40,7 @@ /** * An exception indicating that a message is sent to a node that is not connected. * - * + * @opensearch.internal */ public class NodeNotConnectedException extends ConnectTransportException { diff --git a/server/src/main/java/org/opensearch/transport/NodeShouldNotConnectException.java b/server/src/main/java/org/opensearch/transport/NodeShouldNotConnectException.java index 263f4311b399f..7f6521716411b 100644 --- a/server/src/main/java/org/opensearch/transport/NodeShouldNotConnectException.java +++ b/server/src/main/java/org/opensearch/transport/NodeShouldNotConnectException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if a node should not disconnect + * + * @opensearch.internal + */ public class NodeShouldNotConnectException extends NodeNotConnectedException { public NodeShouldNotConnectException(DiscoveryNode fromNode, DiscoveryNode node) { diff --git a/server/src/main/java/org/opensearch/transport/NotSerializableTransportException.java b/server/src/main/java/org/opensearch/transport/NotSerializableTransportException.java index 91003dc07059e..6cec3da191a49 100644 --- a/server/src/main/java/org/opensearch/transport/NotSerializableTransportException.java +++ b/server/src/main/java/org/opensearch/transport/NotSerializableTransportException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if data is not serializable + * + * @opensearch.internal + */ public class NotSerializableTransportException extends TransportException { public NotSerializableTransportException(Throwable t) { diff --git a/server/src/main/java/org/opensearch/transport/OutboundHandler.java b/server/src/main/java/org/opensearch/transport/OutboundHandler.java index 4b9ce7eabb6ce..726fb940ee3e0 100644 --- a/server/src/main/java/org/opensearch/transport/OutboundHandler.java +++ b/server/src/main/java/org/opensearch/transport/OutboundHandler.java @@ -55,6 +55,11 @@ import java.io.IOException; import java.util.Set; +/** + * Outbound data handler + * + * @opensearch.internal + */ final class OutboundHandler { private static final Logger logger = LogManager.getLogger(OutboundHandler.class); diff --git a/server/src/main/java/org/opensearch/transport/OutboundMessage.java b/server/src/main/java/org/opensearch/transport/OutboundMessage.java index 51d0da2c25439..2747a93420282 100644 --- a/server/src/main/java/org/opensearch/transport/OutboundMessage.java +++ b/server/src/main/java/org/opensearch/transport/OutboundMessage.java @@ -43,6 +43,11 @@ import java.io.IOException; import java.util.Set; +/** + * Outbound data as a message + * + * @opensearch.internal + */ abstract class OutboundMessage extends NetworkMessage { private final Writeable message; diff --git a/server/src/main/java/org/opensearch/transport/PlainTransportFuture.java b/server/src/main/java/org/opensearch/transport/PlainTransportFuture.java index 097b5bd7dd573..f09cbc1c89eee 100644 --- a/server/src/main/java/org/opensearch/transport/PlainTransportFuture.java +++ b/server/src/main/java/org/opensearch/transport/PlainTransportFuture.java @@ -42,6 +42,11 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; +/** + * Future for transporting data + * + * @opensearch.internal + */ public class PlainTransportFuture extends BaseFuture implements TransportFuture, diff --git a/server/src/main/java/org/opensearch/transport/ProxyConnectionStrategy.java b/server/src/main/java/org/opensearch/transport/ProxyConnectionStrategy.java index 46ae93b62ebd6..c1b35ca00a92b 100644 --- a/server/src/main/java/org/opensearch/transport/ProxyConnectionStrategy.java +++ b/server/src/main/java/org/opensearch/transport/ProxyConnectionStrategy.java @@ -60,6 +60,11 @@ import static org.opensearch.common.settings.Setting.intSetting; +/** + * Connect through a proxy + * + * @opensearch.internal + */ public class ProxyConnectionStrategy extends RemoteConnectionStrategy { /** diff --git a/server/src/main/java/org/opensearch/transport/ReceiveTimeoutTransportException.java b/server/src/main/java/org/opensearch/transport/ReceiveTimeoutTransportException.java index eb14434c951b3..a8985d2175024 100644 --- a/server/src/main/java/org/opensearch/transport/ReceiveTimeoutTransportException.java +++ b/server/src/main/java/org/opensearch/transport/ReceiveTimeoutTransportException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Thrown when receiving a timeout + * + * @opensearch.internal + */ public class ReceiveTimeoutTransportException extends ActionTransportException { public ReceiveTimeoutTransportException(DiscoveryNode node, String action, String msg) { diff --git a/server/src/main/java/org/opensearch/transport/RemoteClusterAware.java b/server/src/main/java/org/opensearch/transport/RemoteClusterAware.java index d8641bc6f536d..ad8f59f7af6aa 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteClusterAware.java +++ b/server/src/main/java/org/opensearch/transport/RemoteClusterAware.java @@ -47,6 +47,8 @@ /** * Base class for all services and components that need up-to-date information about the registered remote clusters + * + * @opensearch.internal */ public abstract class RemoteClusterAware { diff --git a/server/src/main/java/org/opensearch/transport/RemoteClusterAwareClient.java b/server/src/main/java/org/opensearch/transport/RemoteClusterAwareClient.java index 17dfad6a1b9ac..ac79b21d73f69 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteClusterAwareClient.java +++ b/server/src/main/java/org/opensearch/transport/RemoteClusterAwareClient.java @@ -42,6 +42,11 @@ import org.opensearch.common.settings.Settings; import org.opensearch.threadpool.ThreadPool; +/** + * Client that is aware of remote clusters + * + * @opensearch.internal + */ final class RemoteClusterAwareClient extends AbstractClient { private final TransportService service; diff --git a/server/src/main/java/org/opensearch/transport/RemoteClusterAwareRequest.java b/server/src/main/java/org/opensearch/transport/RemoteClusterAwareRequest.java index aa2da7ac5c288..727519f6ba9e5 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteClusterAwareRequest.java +++ b/server/src/main/java/org/opensearch/transport/RemoteClusterAwareRequest.java @@ -34,6 +34,11 @@ import org.opensearch.cluster.node.DiscoveryNode; +/** + * Request for remote clusters + * + * @opensearch.internal + */ public interface RemoteClusterAwareRequest { /** diff --git a/server/src/main/java/org/opensearch/transport/RemoteClusterConnection.java b/server/src/main/java/org/opensearch/transport/RemoteClusterConnection.java index ff4a2cd7701f8..906513ca62249 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteClusterConnection.java +++ b/server/src/main/java/org/opensearch/transport/RemoteClusterConnection.java @@ -61,6 +61,8 @@ * In the case of a disconnection, this class will issue a re-connect task to establish at most * {@link SniffConnectionStrategy#REMOTE_CONNECTIONS_PER_CLUSTER} until either all eligible nodes are exhausted or the maximum number of * connections per cluster has been reached. + * + * @opensearch.internal */ final class RemoteClusterConnection implements Closeable { diff --git a/server/src/main/java/org/opensearch/transport/RemoteClusterService.java b/server/src/main/java/org/opensearch/transport/RemoteClusterService.java index 8791a322b2c59..fcdeec36f865c 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteClusterService.java +++ b/server/src/main/java/org/opensearch/transport/RemoteClusterService.java @@ -74,6 +74,8 @@ /** * Basic service for accessing remote clusters via gateway nodes + * + * @opensearch.internal */ public final class RemoteClusterService extends RemoteClusterAware implements Closeable { diff --git a/server/src/main/java/org/opensearch/transport/RemoteConnectionInfo.java b/server/src/main/java/org/opensearch/transport/RemoteConnectionInfo.java index c23287de4e444..7ca1d646a9507 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteConnectionInfo.java +++ b/server/src/main/java/org/opensearch/transport/RemoteConnectionInfo.java @@ -54,6 +54,8 @@ /** * This class encapsulates all remote cluster information to be rendered on * {@code _remote/info} requests. + * + * @opensearch.internal */ public final class RemoteConnectionInfo implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/transport/RemoteConnectionManager.java b/server/src/main/java/org/opensearch/transport/RemoteConnectionManager.java index 67ca7e9c753ce..4da23175c4a0e 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteConnectionManager.java +++ b/server/src/main/java/org/opensearch/transport/RemoteConnectionManager.java @@ -42,6 +42,11 @@ import java.util.Set; import java.util.concurrent.atomic.AtomicLong; +/** + * Manager for connecting to remote nodes + * + * @opensearch.internal + */ public class RemoteConnectionManager implements ConnectionManager { private final String clusterAlias; diff --git a/server/src/main/java/org/opensearch/transport/RemoteConnectionStrategy.java b/server/src/main/java/org/opensearch/transport/RemoteConnectionStrategy.java index 3903baff3a9bb..8d5727858ec6f 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteConnectionStrategy.java +++ b/server/src/main/java/org/opensearch/transport/RemoteConnectionStrategy.java @@ -68,6 +68,11 @@ import java.util.stream.Collectors; import java.util.stream.Stream; +/** + * Strategy to connect to remote nodes + * + * @opensearch.internal + */ public abstract class RemoteConnectionStrategy implements TransportConnectionListener, Closeable { enum ConnectionStrategy { diff --git a/server/src/main/java/org/opensearch/transport/RemoteTransportException.java b/server/src/main/java/org/opensearch/transport/RemoteTransportException.java index b07cada0edb1b..a02f470c3a4ae 100644 --- a/server/src/main/java/org/opensearch/transport/RemoteTransportException.java +++ b/server/src/main/java/org/opensearch/transport/RemoteTransportException.java @@ -42,7 +42,7 @@ * A remote exception for an action. A wrapper exception around the actual remote cause and does not fill the * stack trace. * - * + * @opensearch.internal */ public class RemoteTransportException extends ActionTransportException implements OpenSearchWrapperException { diff --git a/server/src/main/java/org/opensearch/transport/ResponseHandlerFailureTransportException.java b/server/src/main/java/org/opensearch/transport/ResponseHandlerFailureTransportException.java index 984235738a45d..9de4ad04d6ed0 100644 --- a/server/src/main/java/org/opensearch/transport/ResponseHandlerFailureTransportException.java +++ b/server/src/main/java/org/opensearch/transport/ResponseHandlerFailureTransportException.java @@ -38,6 +38,8 @@ /** * A failure to handle the response of a transaction action. + * + * @opensearch.internal */ public class ResponseHandlerFailureTransportException extends TransportException { diff --git a/server/src/main/java/org/opensearch/transport/SendRequestTransportException.java b/server/src/main/java/org/opensearch/transport/SendRequestTransportException.java index 5cf079ea9872c..929292a2cea58 100644 --- a/server/src/main/java/org/opensearch/transport/SendRequestTransportException.java +++ b/server/src/main/java/org/opensearch/transport/SendRequestTransportException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Thrown when an error occurs while sending a request + * + * @opensearch.internal + */ public class SendRequestTransportException extends ActionTransportException implements OpenSearchWrapperException { public SendRequestTransportException(DiscoveryNode node, String action, Throwable cause) { diff --git a/server/src/main/java/org/opensearch/transport/SniffConnectionStrategy.java b/server/src/main/java/org/opensearch/transport/SniffConnectionStrategy.java index 5d2b2d3ac684f..c84c5599bb746 100644 --- a/server/src/main/java/org/opensearch/transport/SniffConnectionStrategy.java +++ b/server/src/main/java/org/opensearch/transport/SniffConnectionStrategy.java @@ -74,6 +74,11 @@ import static org.opensearch.common.settings.Setting.intSetting; +/** + * Sniff for initial seed nodes + * + * @opensearch.internal + */ public class SniffConnectionStrategy extends RemoteConnectionStrategy { /** diff --git a/server/src/main/java/org/opensearch/transport/TaskTransportChannel.java b/server/src/main/java/org/opensearch/transport/TaskTransportChannel.java index 5faf12c3b991f..4dceee4c48d4d 100644 --- a/server/src/main/java/org/opensearch/transport/TaskTransportChannel.java +++ b/server/src/main/java/org/opensearch/transport/TaskTransportChannel.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Transport channel for tasks + * + * @opensearch.internal + */ public class TaskTransportChannel implements TransportChannel { private final TransportChannel channel; diff --git a/server/src/main/java/org/opensearch/transport/TcpChannel.java b/server/src/main/java/org/opensearch/transport/TcpChannel.java index 1b07c963890d6..4202b906ce161 100644 --- a/server/src/main/java/org/opensearch/transport/TcpChannel.java +++ b/server/src/main/java/org/opensearch/transport/TcpChannel.java @@ -43,6 +43,8 @@ * This is a tcp channel representing a single channel connection to another node. It is the base channel * abstraction used by the {@link TcpTransport} and {@link TransportService}. All tcp transport * implementations must return channels that adhere to the required method contracts. + * + * @opensearch.internal */ public interface TcpChannel extends CloseableChannel { diff --git a/server/src/main/java/org/opensearch/transport/TcpHeader.java b/server/src/main/java/org/opensearch/transport/TcpHeader.java index 514ebfff6f8f6..747968ffc8fef 100644 --- a/server/src/main/java/org/opensearch/transport/TcpHeader.java +++ b/server/src/main/java/org/opensearch/transport/TcpHeader.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Header for TCP messages + * + * @opensearch.internal + */ public class TcpHeader { public static final Version VERSION_WITH_HEADER_SIZE = LegacyESVersion.V_7_6_0; diff --git a/server/src/main/java/org/opensearch/transport/TcpServerChannel.java b/server/src/main/java/org/opensearch/transport/TcpServerChannel.java index fa3d6499d7d62..7d61b8c7d699c 100644 --- a/server/src/main/java/org/opensearch/transport/TcpServerChannel.java +++ b/server/src/main/java/org/opensearch/transport/TcpServerChannel.java @@ -40,6 +40,8 @@ * This is a tcp channel representing a server channel listening for new connections. It is the server * channel abstraction used by the {@link TcpTransport} and {@link TransportService}. All tcp transport * implementations must return server channels that adhere to the required method contracts. + * + * @opensearch.internal */ public interface TcpServerChannel extends CloseableChannel { diff --git a/server/src/main/java/org/opensearch/transport/TcpTransport.java b/server/src/main/java/org/opensearch/transport/TcpTransport.java index c2a0584721148..76a0671a40c3e 100644 --- a/server/src/main/java/org/opensearch/transport/TcpTransport.java +++ b/server/src/main/java/org/opensearch/transport/TcpTransport.java @@ -109,6 +109,11 @@ import static org.opensearch.common.transport.NetworkExceptionHelper.isConnectException; import static org.opensearch.common.util.concurrent.ConcurrentCollections.newConcurrentMap; +/** + * The TCP Transport layer + * + * @opensearch.internal + */ public abstract class TcpTransport extends AbstractLifecycleComponent implements Transport { private static final Logger logger = LogManager.getLogger(TcpTransport.class); diff --git a/server/src/main/java/org/opensearch/transport/TcpTransportChannel.java b/server/src/main/java/org/opensearch/transport/TcpTransportChannel.java index 9c91cd3df8c89..e25003648794d 100644 --- a/server/src/main/java/org/opensearch/transport/TcpTransportChannel.java +++ b/server/src/main/java/org/opensearch/transport/TcpTransportChannel.java @@ -40,6 +40,11 @@ import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; +/** + * Channel for a TCP connection + * + * @opensearch.internal + */ public final class TcpTransportChannel implements TransportChannel { private final AtomicBoolean released = new AtomicBoolean(); diff --git a/server/src/main/java/org/opensearch/transport/Transport.java b/server/src/main/java/org/opensearch/transport/Transport.java index 0946d9c8ec626..cf917d2a532dc 100644 --- a/server/src/main/java/org/opensearch/transport/Transport.java +++ b/server/src/main/java/org/opensearch/transport/Transport.java @@ -53,6 +53,11 @@ import java.util.concurrent.atomic.AtomicLong; import java.util.function.Predicate; +/** + * OpenSearch Transport Interface + * + * @opensearch.internal + */ public interface Transport extends LifecycleComponent { /** diff --git a/server/src/main/java/org/opensearch/transport/TransportActionProxy.java b/server/src/main/java/org/opensearch/transport/TransportActionProxy.java index 1776ab24d465c..b7cf18e88d924 100644 --- a/server/src/main/java/org/opensearch/transport/TransportActionProxy.java +++ b/server/src/main/java/org/opensearch/transport/TransportActionProxy.java @@ -46,6 +46,8 @@ * TransportActionProxy allows an arbitrary action to be executed on a defined target node while the initial request is sent to a second * node that acts as a request proxy to the target node. This is useful if a node is not directly connected to a target node but is * connected to an intermediate node that establishes a transitive connection. + * + * @opensearch.internal */ public final class TransportActionProxy { diff --git a/server/src/main/java/org/opensearch/transport/TransportChannel.java b/server/src/main/java/org/opensearch/transport/TransportChannel.java index 92d1d07865e52..b660db029c0b2 100644 --- a/server/src/main/java/org/opensearch/transport/TransportChannel.java +++ b/server/src/main/java/org/opensearch/transport/TransportChannel.java @@ -41,6 +41,8 @@ /** * A transport channel allows to send a response to a request on the channel. + * + * @opensearch.internal */ public interface TransportChannel { diff --git a/server/src/main/java/org/opensearch/transport/TransportConnectionListener.java b/server/src/main/java/org/opensearch/transport/TransportConnectionListener.java index 43bfd3f6d0be0..7acb1e9ae09e9 100644 --- a/server/src/main/java/org/opensearch/transport/TransportConnectionListener.java +++ b/server/src/main/java/org/opensearch/transport/TransportConnectionListener.java @@ -38,6 +38,8 @@ * A listener interface that allows to react on transport events. All methods may be * executed on network threads. Consumers must fork in the case of long running or blocking * operations. + * + * @opensearch.internal */ public interface TransportConnectionListener { diff --git a/server/src/main/java/org/opensearch/transport/TransportDecompressor.java b/server/src/main/java/org/opensearch/transport/TransportDecompressor.java index 262438ed75463..7690bfdf35d8a 100644 --- a/server/src/main/java/org/opensearch/transport/TransportDecompressor.java +++ b/server/src/main/java/org/opensearch/transport/TransportDecompressor.java @@ -47,6 +47,11 @@ import java.util.zip.DataFormatException; import java.util.zip.Inflater; +/** + * Decompresses data over the transport wire + * + * @opensearch.internal + */ public class TransportDecompressor implements Closeable { private final Inflater inflater; diff --git a/server/src/main/java/org/opensearch/transport/TransportException.java b/server/src/main/java/org/opensearch/transport/TransportException.java index 00efe52e06ed2..38d1d5d76c644 100644 --- a/server/src/main/java/org/opensearch/transport/TransportException.java +++ b/server/src/main/java/org/opensearch/transport/TransportException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Thrown for any transport errors + * + * @opensearch.internal + */ public class TransportException extends OpenSearchException { public TransportException(Throwable cause) { super(cause); diff --git a/server/src/main/java/org/opensearch/transport/TransportFuture.java b/server/src/main/java/org/opensearch/transport/TransportFuture.java index 09759c498fc89..d2abf8c20d34e 100644 --- a/server/src/main/java/org/opensearch/transport/TransportFuture.java +++ b/server/src/main/java/org/opensearch/transport/TransportFuture.java @@ -35,6 +35,11 @@ import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; +/** + * Future for transport operations + * + * @opensearch.internal + */ public interface TransportFuture extends Future { /** diff --git a/server/src/main/java/org/opensearch/transport/TransportHandshaker.java b/server/src/main/java/org/opensearch/transport/TransportHandshaker.java index 1b6a2580fcf77..501aefa9da68f 100644 --- a/server/src/main/java/org/opensearch/transport/TransportHandshaker.java +++ b/server/src/main/java/org/opensearch/transport/TransportHandshaker.java @@ -52,6 +52,8 @@ /** * Sends and receives transport-level connection handshakes. This class will send the initial handshake, * manage state/timeouts while the handshake is in transit, and handle the eventual response. + * + * @opensearch.internal */ final class TransportHandshaker { diff --git a/server/src/main/java/org/opensearch/transport/TransportInfo.java b/server/src/main/java/org/opensearch/transport/TransportInfo.java index a65b95661bbf1..dcf745039fbf0 100644 --- a/server/src/main/java/org/opensearch/transport/TransportInfo.java +++ b/server/src/main/java/org/opensearch/transport/TransportInfo.java @@ -48,6 +48,11 @@ import static org.opensearch.common.Booleans.parseBoolean; +/** + * Transport information + * + * @opensearch.internal + */ public class TransportInfo implements ReportingService.Info { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(TransportInfo.class); diff --git a/server/src/main/java/org/opensearch/transport/TransportInterceptor.java b/server/src/main/java/org/opensearch/transport/TransportInterceptor.java index ae76bd4899127..755f307f64bb8 100644 --- a/server/src/main/java/org/opensearch/transport/TransportInterceptor.java +++ b/server/src/main/java/org/opensearch/transport/TransportInterceptor.java @@ -37,6 +37,8 @@ /** * This interface allows plugins to intercept requests on both the sender and the receiver side. + * + * @opensearch.internal */ public interface TransportInterceptor { /** diff --git a/server/src/main/java/org/opensearch/transport/TransportKeepAlive.java b/server/src/main/java/org/opensearch/transport/TransportKeepAlive.java index 1874b0f803b78..b90355cf5e775 100644 --- a/server/src/main/java/org/opensearch/transport/TransportKeepAlive.java +++ b/server/src/main/java/org/opensearch/transport/TransportKeepAlive.java @@ -56,6 +56,8 @@ * Implements the scheduling and sending of keep alive pings. Client channels send keep alive pings to the * server and server channels respond. Pings are only sent at the scheduled time if the channel did not send * and receive a message since the last ping. + * + * @opensearch.internal */ final class TransportKeepAlive implements Closeable { diff --git a/server/src/main/java/org/opensearch/transport/TransportLogger.java b/server/src/main/java/org/opensearch/transport/TransportLogger.java index 6de285473c73a..d7eca7e6bc5b0 100644 --- a/server/src/main/java/org/opensearch/transport/TransportLogger.java +++ b/server/src/main/java/org/opensearch/transport/TransportLogger.java @@ -43,6 +43,11 @@ import java.io.IOException; +/** + * Logs transport activity + * + * @opensearch.internal + */ public final class TransportLogger { private static final Logger logger = LogManager.getLogger(TransportLogger.class); diff --git a/server/src/main/java/org/opensearch/transport/TransportMessage.java b/server/src/main/java/org/opensearch/transport/TransportMessage.java index 0862e25205261..f40d8526df818 100644 --- a/server/src/main/java/org/opensearch/transport/TransportMessage.java +++ b/server/src/main/java/org/opensearch/transport/TransportMessage.java @@ -36,6 +36,11 @@ import org.opensearch.common.io.stream.Writeable; import org.opensearch.common.transport.TransportAddress; +/** + * Message over the transport interface + * + * @opensearch.internal + */ public abstract class TransportMessage implements Writeable { private TransportAddress remoteAddress; diff --git a/server/src/main/java/org/opensearch/transport/TransportMessageListener.java b/server/src/main/java/org/opensearch/transport/TransportMessageListener.java index fd5ca057ba9bb..8a7612d3bd99a 100644 --- a/server/src/main/java/org/opensearch/transport/TransportMessageListener.java +++ b/server/src/main/java/org/opensearch/transport/TransportMessageListener.java @@ -33,6 +33,11 @@ import org.opensearch.cluster.node.DiscoveryNode; +/** + * Listens for transport messages + * + * @opensearch.internal + */ public interface TransportMessageListener { TransportMessageListener NOOP_LISTENER = new TransportMessageListener() { diff --git a/server/src/main/java/org/opensearch/transport/TransportRequest.java b/server/src/main/java/org/opensearch/transport/TransportRequest.java index 4dd18102e4c06..6d599f9faf927 100644 --- a/server/src/main/java/org/opensearch/transport/TransportRequest.java +++ b/server/src/main/java/org/opensearch/transport/TransportRequest.java @@ -39,6 +39,11 @@ import java.io.IOException; +/** + * A transport request + * + * @opensearch.internal + */ public abstract class TransportRequest extends TransportMessage implements TaskAwareRequest { public static class Empty extends TransportRequest { public static final Empty INSTANCE = new Empty(); diff --git a/server/src/main/java/org/opensearch/transport/TransportRequestDeduplicator.java b/server/src/main/java/org/opensearch/transport/TransportRequestDeduplicator.java index ba58bb37d8d48..eec0310557690 100644 --- a/server/src/main/java/org/opensearch/transport/TransportRequestDeduplicator.java +++ b/server/src/main/java/org/opensearch/transport/TransportRequestDeduplicator.java @@ -44,6 +44,8 @@ * Deduplicator for {@link TransportRequest}s that keeps track of {@link TransportRequest}s that should * not be sent in parallel. * @param Transport Request Class + * + * @opensearch.internal */ public final class TransportRequestDeduplicator { diff --git a/server/src/main/java/org/opensearch/transport/TransportRequestHandler.java b/server/src/main/java/org/opensearch/transport/TransportRequestHandler.java index 5e6cb1e6c4007..54ee1b68fc9aa 100644 --- a/server/src/main/java/org/opensearch/transport/TransportRequestHandler.java +++ b/server/src/main/java/org/opensearch/transport/TransportRequestHandler.java @@ -34,6 +34,11 @@ import org.opensearch.tasks.Task; +/** + * Handles transport requests + * + * @opensearch.internal + */ public interface TransportRequestHandler { void messageReceived(T request, TransportChannel channel, Task task) throws Exception; diff --git a/server/src/main/java/org/opensearch/transport/TransportRequestOptions.java b/server/src/main/java/org/opensearch/transport/TransportRequestOptions.java index 8b8638da6c524..082d4dc3dd8a5 100644 --- a/server/src/main/java/org/opensearch/transport/TransportRequestOptions.java +++ b/server/src/main/java/org/opensearch/transport/TransportRequestOptions.java @@ -34,6 +34,11 @@ import org.opensearch.common.unit.TimeValue; +/** + * Options for transport requests + * + * @opensearch.internal + */ public class TransportRequestOptions { private final TimeValue timeout; diff --git a/server/src/main/java/org/opensearch/transport/TransportResponse.java b/server/src/main/java/org/opensearch/transport/TransportResponse.java index 7369f5475926b..aeef9c71499fb 100644 --- a/server/src/main/java/org/opensearch/transport/TransportResponse.java +++ b/server/src/main/java/org/opensearch/transport/TransportResponse.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Response over the transport interface + * + * @opensearch.internal + */ public abstract class TransportResponse extends TransportMessage { /** diff --git a/server/src/main/java/org/opensearch/transport/TransportResponseHandler.java b/server/src/main/java/org/opensearch/transport/TransportResponseHandler.java index 8d6129b98390b..40bac6fb8440e 100644 --- a/server/src/main/java/org/opensearch/transport/TransportResponseHandler.java +++ b/server/src/main/java/org/opensearch/transport/TransportResponseHandler.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.function.Function; +/** + * Handles transport responses + * + * @opensearch.internal + */ public interface TransportResponseHandler extends Writeable.Reader { void handleResponse(T response); diff --git a/server/src/main/java/org/opensearch/transport/TransportSerializationException.java b/server/src/main/java/org/opensearch/transport/TransportSerializationException.java index 964d24adc11f4..5ce651a5030c8 100644 --- a/server/src/main/java/org/opensearch/transport/TransportSerializationException.java +++ b/server/src/main/java/org/opensearch/transport/TransportSerializationException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Thrown if there is an error serializing data for transport + * + * @opensearch.internal + */ public class TransportSerializationException extends TransportException { public TransportSerializationException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/transport/TransportService.java b/server/src/main/java/org/opensearch/transport/TransportService.java index ad46ed742c806..4d8773dcfbf9f 100644 --- a/server/src/main/java/org/opensearch/transport/TransportService.java +++ b/server/src/main/java/org/opensearch/transport/TransportService.java @@ -87,6 +87,11 @@ import java.util.function.Predicate; import java.util.function.Supplier; +/** + * The main OpenSearch transport service + * + * @opensearch.internal + */ public class TransportService extends AbstractLifecycleComponent implements ReportingService, diff --git a/server/src/main/java/org/opensearch/transport/TransportSettings.java b/server/src/main/java/org/opensearch/transport/TransportSettings.java index cacdbce60c365..b4d72ab40409b 100644 --- a/server/src/main/java/org/opensearch/transport/TransportSettings.java +++ b/server/src/main/java/org/opensearch/transport/TransportSettings.java @@ -49,6 +49,11 @@ import static org.opensearch.common.settings.Setting.listSetting; import static org.opensearch.common.settings.Setting.timeSetting; +/** + * Settings for transport config + * + * @opensearch.internal + */ public final class TransportSettings { public static final String DEFAULT_PROFILE = "default"; diff --git a/server/src/main/java/org/opensearch/transport/TransportStats.java b/server/src/main/java/org/opensearch/transport/TransportStats.java index e83de2f599b37..9c708a8fdc65a 100644 --- a/server/src/main/java/org/opensearch/transport/TransportStats.java +++ b/server/src/main/java/org/opensearch/transport/TransportStats.java @@ -42,6 +42,11 @@ import java.io.IOException; +/** + * Stats for transport activity + * + * @opensearch.internal + */ public class TransportStats implements Writeable, ToXContentFragment { private final long serverOpen; diff --git a/server/src/main/java/org/opensearch/transport/TransportStatus.java b/server/src/main/java/org/opensearch/transport/TransportStatus.java index 2622b1d67b458..dab572949e688 100644 --- a/server/src/main/java/org/opensearch/transport/TransportStatus.java +++ b/server/src/main/java/org/opensearch/transport/TransportStatus.java @@ -32,6 +32,11 @@ package org.opensearch.transport; +/** + * Status for transport activity + * + * @opensearch.internal + */ public final class TransportStatus { private static final byte STATUS_REQRES = 1 << 0; diff --git a/server/src/main/java/org/opensearch/transport/Transports.java b/server/src/main/java/org/opensearch/transport/Transports.java index 7d9f013db5338..e6e9b7e5edb7e 100644 --- a/server/src/main/java/org/opensearch/transport/Transports.java +++ b/server/src/main/java/org/opensearch/transport/Transports.java @@ -38,6 +38,11 @@ import java.util.Arrays; +/** + * Utility class for transport + * + * @opensearch.internal + */ public enum Transports { ;