Add the means to extract the contextual properties from HttpChannel, TcpChannel and TrasportChannel without excessive typecasting

CHANGELOG.md

@@ -138,6 +138,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [Remote Store] Add support to reload repository metadata inplace ([#9569](https://github.com/opensearch-project/OpenSearch/pull/9569))
 - [Metrics Framework] Add Metrics framework. ([#10241](https://github.com/opensearch-project/OpenSearch/pull/10241))
 - Updating the separator for RemoteStoreLockManager since underscore is allowed in base64UUID url charset ([#10379](https://github.com/opensearch-project/OpenSearch/pull/10379))
+- Add the means to extract the contextual properties from HttpChannel, TcpCChannel and TrasportChannel without excessive typecasting ([#10562](https://github.com/opensearch-project/OpenSearch/pull/10562))
 
 ### Deprecated
 

modules/transport-netty4/src/main/java/org/opensearch/http/netty4/Netty4HttpChannel.java

@@ -98,6 +98,22 @@ public Channel getNettyChannel() {
         return channel;
     }
 
+    @SuppressWarnings("unchecked")
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        Object handler = getNettyChannel().pipeline().get(name);
+
+        if (handler == null && inboundPipeline() != null) {
+            handler = inboundPipeline().get(name);
+        }
+
+        if (handler != null && clazz.isInstance(handler) == true) {
+            return (T) handler;
+        }
+
+        return null;
+    }
+
     @Override
     public String toString() {
         return "Netty4HttpChannel{" + "localAddress=" + getLocalAddress() + ", remoteAddress=" + getRemoteAddress() + '}';

modules/transport-netty4/src/main/java/org/opensearch/transport/netty4/Netty4TcpChannel.java

@@ -164,6 +164,18 @@ public void sendMessage(BytesReference reference, ActionListener<Void> listener)
         }
     }
 
+    @SuppressWarnings("unchecked")
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        final Object handler = getNettyChannel().pipeline().get(name);
+
+        if (handler != null && clazz.isInstance(handler) == true) {
+            return (T) handler;
+        }
+
+        return null;
+    }
+
     public Channel getNettyChannel() {
         return channel;
     }

server/src/main/java/org/opensearch/http/HttpChannel.java

@@ -72,4 +72,18 @@ default void handleException(Exception ex) {}
      */
     InetSocketAddress getRemoteAddress();
 
+    /**
+     * Returns the contextual property associated with this specific HTTP channel (the
+     * implementation of how such properties are managed depends on the the particular
+     * transport engine).
+     *
+     * @param name the name of the property
+     * @param clazz the expected type of the property
+     *
+     * @return the value of the property.
+     *         {@code null} if there's no such property or the expected type is not compatible.
+     */
+    default <T> T get(String name, Class<T> clazz) {
+        return null;
+    }
 }

server/src/main/java/org/opensearch/telemetry/tracing/channels/TraceableHttpChannel.java

@@ -92,4 +92,9 @@ public InetSocketAddress getLocalAddress() {
     public InetSocketAddress getRemoteAddress() {
         return delegate.getRemoteAddress();
     }
+
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        return delegate.get(name, clazz);
+    }
 }

server/src/main/java/org/opensearch/telemetry/tracing/channels/TraceableTcpTransportChannel.java

@@ -109,4 +109,9 @@ public void sendResponse(Exception exception) throws IOException {
     public Version getVersion() {
         return delegate.getVersion();
     }
+
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        return delegate.get(name, clazz);
+    }
 }

server/src/main/java/org/opensearch/transport/TaskTransportChannel.java

@@ -89,4 +89,9 @@ public Version getVersion() {
     public TransportChannel getChannel() {
         return channel;
     }
+
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        return getChannel().get(name, clazz);
+    }
 }

server/src/main/java/org/opensearch/transport/TcpChannel.java

@@ -96,6 +96,21 @@ public interface TcpChannel extends CloseableChannel {
      */
     ChannelStats getChannelStats();
 
+    /**
+     * Returns the contextual property associated with this specific TCP channel (the
+     * implementation of how such properties are managed depends on the the particular
+     * transport engine).
+     *
+     * @param name the name of the property
+     * @param clazz the expected type of the property
+     *
+     * @return the value of the property.
+     *         {@code null} if there's no such property or the expected type is not compatible.
+     */
+    default <T> T get(String name, Class<T> clazz) {
+        return null;
+    }
+
     /**
      * Channel statistics
      *

server/src/main/java/org/opensearch/transport/TcpTransportChannel.java

@@ -130,4 +130,8 @@ public Version getVersion() {
         return version;
     }
 
+    @Override
+    public <T> T get(String name, Class<T> clazz) {
+        return getChannel().get(name, clazz);
+    }
 }

server/src/main/java/org/opensearch/transport/TransportChannel.java

@@ -78,4 +78,19 @@ static void sendErrorResponse(TransportChannel channel, String actionName, Trans
             );
         }
     }
+
+    /**
+     * Returns the contextual property associated with this specific transport channel (the
+     * implementation of how such properties are managed depends on the the particular
+     * transport engine).
+     *
+     * @param name the name of the property
+     * @param clazz the expected type of the property
+     *
+     * @return the value of the property.
+     *         {@code null} if there's no such property or the expected type is not compatible.
+     */
+    default <T> T get(String name, Class<T> clazz) {
+        return null;
+    }
 }