javadoc

Signed-off-by: Peter Nied <[email protected]>

src/main/java/org/opensearch/security/filter/OpenSearchRequest.java

@@ -13,6 +13,9 @@
 
 import io.netty.handler.ssl.SslHandler;
 
+/**
+ * Wraps the functionality of RestRequest for use in the security plugin
+ */
 public class OpenSearchRequest implements SecurityRequest {
 
     protected final RestRequest underlyingRequest;
@@ -68,6 +71,7 @@ public Map<String, String> params() {
         return underlyingRequest.params();
     }
 
+    /** Gets access to the underlying request object */
     public RestRequest breakEncapsulationForRequest() {
         return underlyingRequest;
     }

src/main/java/org/opensearch/security/filter/OpenSearchRequestChannel.java

@@ -33,6 +33,10 @@ public boolean completeWithResponse(int statusCode, Map<String, String> headers,
             throw new UnsupportedOperationException("Channel was not defined");
         }
 
+        if (hasCompleted()) {
+            throw new UnsupportedOperationException("This channel has already completed");
+        }
+
         try {
             final BytesRestResponse restResponse = new BytesRestResponse(RestStatus.fromCode(statusCode), body);
             if (headers != null) {
@@ -54,6 +58,7 @@ public void markCompleted() {
         hasCompleted.set(true);
     }
 
+    /** Gets access to the underlying channel object */
     public RestChannel breakEncapsulationForChannel() {
         return underlyingChannel;
     }

src/main/java/org/opensearch/security/filter/SecurityRequest.java

@@ -10,23 +10,33 @@
 
 import org.opensearch.rest.RestRequest.Method;
 
+/** How the security plugin interacts with requests */
 public interface SecurityRequest {
+
+    /** Collection of headers associated with the request */
     public Map<String, List<String>> getHeaders();
 
+    /** The SSLEngine associated with the request */
     public SSLEngine getSSLEngine();
 
+    /** The path of the request */
     public String path();
 
+    /** The method type of this request */
     public Method method();
 
+    /** The remote address of the request, possible null */
     public Optional<InetSocketAddress> getRemoteAddress();
 
+    /** The full uri of the request */
     public String uri();
 
+    /** Finds the first value of the matching header or null */
     default public String header(final String headerName) {
         final Optional<Map<String, List<String>>> headersMap = Optional.ofNullable(getHeaders());
         return headersMap.map(headers -> headers.get(headerName)).map(List::stream).flatMap(Stream::findFirst).orElse(null);
     }
 
+    /** The parameters associated with this request */
     public Map<String, String> params();
 }

src/main/java/org/opensearch/security/filter/SecurityRequestChannel.java

@@ -7,7 +7,11 @@
  */
 public interface SecurityRequestChannel extends SecurityRequest {
 
+    /**
+     * If this channel has been been used to send a response
+     */
     public boolean hasCompleted();
 
+    /** Use this channel to send a response */
     public boolean completeWithResponse(final int statusCode, final Map<String, String> headers, final String body);
 }

src/main/java/org/opensearch/security/filter/SecurityRequestFactory.java

@@ -3,16 +3,17 @@
 import org.opensearch.rest.RestChannel;
 import org.opensearch.rest.RestRequest;
 
+/**
+ * Generates wrapped versions of requests for use in the security plugin
+ */
 public class SecurityRequestFactory {
 
-    public static SecurityRequestChannel from() {
-        return null;
-    }
-
+    /** Creates a security requset from a RestRequest */
     public static SecurityRequest from(final RestRequest request) {
         return new OpenSearchRequest(request);
     }
 
+    /** Creates a security request channel from a RestRequest & RestChannel */
     public static SecurityRequestChannel from(final RestRequest request, final RestChannel channel) {
         return new OpenSearchRequestChannel(request, channel);
     }