Update Subject interface to use CheckedRunnable (opensearch-project#18570)

* Update Subject interface to use CheckedRunnable

Signed-off-by: Craig Perkins <[email protected]>

* Add to CHANGELOG

Signed-off-by: Craig Perkins <[email protected]>

* Update more instances

Signed-off-by: Craig Perkins <[email protected]>

* Mark with PublicApi

Signed-off-by: Craig Perkins <[email protected]>

* Update javadoc

Signed-off-by: Craig Perkins <[email protected]>

---------

Signed-off-by: Craig Perkins <[email protected]>

Author: cwperks

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Introduce SecureHttpTransportParameters experimental API (to complement SecureTransportParameters counterpart) ([#18572](https://github.com/opensearch-project/OpenSearch/issues/18572))
 
 ### Changed
+- Update Subject interface to use CheckedRunnable ([#18570](https://github.com/opensearch-project/OpenSearch/issues/18570))
 
 ### Dependencies
 - Bump `stefanzweifel/git-auto-commit-action` from 5 to 6 ([#18524](https://github.com/opensearch-project/OpenSearch/pull/18524))

libs/common/src/main/java/org/opensearch/common/CheckedRunnable.java

@@ -32,11 +32,14 @@
 
 package org.opensearch.common;
 
+import org.opensearch.common.annotation.PublicApi;
+
 /**
  * A {@link Runnable}-like interface which allows throwing checked exceptions.
  *
  * @opensearch.api
  */
+@PublicApi(since = "3.2.0")
 @FunctionalInterface
 public interface CheckedRunnable<E extends Exception> {
     void run() throws E;

plugins/identity-shiro/src/main/java/org/opensearch/identity/shiro/ShiroPluginSubject.java

@@ -8,14 +8,14 @@
 
 package org.opensearch.identity.shiro;
 
+import org.opensearch.common.CheckedRunnable;
 import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.identity.NamedPrincipal;
 import org.opensearch.identity.PluginSubject;
 import org.opensearch.threadpool.ThreadPool;
 
 import java.security.Principal;
-import java.util.concurrent.Callable;
 
 /**
  * Implementation of subject that is always authenticated
@@ -41,9 +41,9 @@ public Principal getPrincipal() {
     }
 
     @Override
-    public <T> T runAs(Callable<T> callable) throws Exception {
+    public <E extends Exception> void runAs(CheckedRunnable<E> r) throws E {
         try (ThreadContext.StoredContext ctx = threadPool.getThreadContext().stashContext()) {
-            return callable.call();
+            r.run();
         }
     }
 }

server/src/main/java/org/opensearch/identity/Subject.java

@@ -5,10 +5,10 @@
 
 package org.opensearch.identity;
 
+import org.opensearch.common.CheckedRunnable;
 import org.opensearch.common.annotation.ExperimentalApi;
 
 import java.security.Principal;
-import java.util.concurrent.Callable;
 
 /**
  * An individual, process, or device that causes information to flow among objects or change to the system state.
@@ -24,9 +24,9 @@ public interface Subject {
     Principal getPrincipal();
 
     /**
-     * runAs allows the caller to run a callable function as this subject
+     * runAs allows the caller to run a {@link CheckedRunnable} as this subject
      */
-    default <T> T runAs(Callable<T> callable) throws Exception {
-        return callable.call();
+    default <E extends Exception> void runAs(CheckedRunnable<E> r) throws E {
+        r.run();
     };
 }

server/src/main/java/org/opensearch/identity/noop/NoopPluginSubject.java

@@ -8,14 +8,14 @@
 
 package org.opensearch.identity.noop;
 
+import org.opensearch.common.CheckedRunnable;
 import org.opensearch.common.annotation.InternalApi;
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.identity.NamedPrincipal;
 import org.opensearch.identity.PluginSubject;
 import org.opensearch.threadpool.ThreadPool;
 
 import java.security.Principal;
-import java.util.concurrent.Callable;
 
 /**
  * Implementation of subject that is always authenticated
@@ -41,9 +41,9 @@ public Principal getPrincipal() {
     }
 
     @Override
-    public <T> T runAs(Callable<T> callable) throws Exception {
+    public <E extends Exception> void runAs(CheckedRunnable<E> r) throws E {
         try (ThreadContext.StoredContext ctx = threadPool.getThreadContext().stashContext()) {
-            return callable.call();
+            r.run();
         }
     }
 }

server/src/test/java/org/opensearch/identity/noop/NoopPluginSubjectTests.java

@@ -48,10 +48,7 @@ public void testInitializeIdentityAwarePlugin() throws Exception {
         assertThat(testPluginSubject.getPrincipal().getName(), equalTo(NamedPrincipal.UNAUTHENTICATED.getName()));
         threadPool.getThreadContext().putHeader("test_header", "foo");
         assertThat(threadPool.getThreadContext().getHeader("test_header"), equalTo("foo"));
-        testPluginSubject.runAs(() -> {
-            assertNull(threadPool.getThreadContext().getHeader("test_header"));
-            return null;
-        });
+        testPluginSubject.runAs(() -> { assertNull(threadPool.getThreadContext().getHeader("test_header")); });
         assertThat(threadPool.getThreadContext().getHeader("test_header"), equalTo("foo"));
         terminate(threadPool);
     }