some javadoc

Author: jmccaull

src/main/java/graphql/servlet/context/ContextSetting.java

@@ -21,11 +21,28 @@
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
+/**
+ * An enum representing possible context settings. These are modeled after Apollo's link settings.
+ */
 public enum ContextSetting {
 
+    /**
+     * A context object, and therefor dataloader registry and subject, should be shared between all GraphQL executions in a http request.
+     */
     PER_REQUEST,
+    /**
+     * Each GraphQL execution should always have its own context.
+     */
     PER_QUERY;
 
+    /**
+     * Creates a set of inputs with the correct context based on the setting.
+     * @param requests the GraphQL requests to execute.
+     * @param schema the GraphQL schema to execute the requests against.
+     * @param contextSupplier method that returns the context to use for each execution or for the request as a whole.
+     * @param root the root object to use for each execution.
+     * @return a configured batch input.
+     */
     public GraphQLBatchedInvocationInput getBatch(List<GraphQLRequest> requests, GraphQLSchema schema, Supplier<GraphQLContext> contextSupplier, Object root) {
         switch (this) {
             case PER_QUERY:
@@ -37,6 +54,13 @@ public GraphQLBatchedInvocationInput getBatch(List<GraphQLRequest> requests, Gra
         }
     }
 
+    /**
+     * Augments the provided instrumentation supplier to also supply the correct dispatching instrumentation.
+     * @param instrumentation the instrumentation supplier to augment
+     * @param executionInputs the inputs that will be dispatched by the instrumentation
+     * @param options the DataLoader dispatching instrumentation options that will be used.
+     * @return augmented instrumentation supplier.
+     */
     public Supplier<Instrumentation> configureInstrumentationForContext(Supplier<Instrumentation> instrumentation, List<ExecutionInput> executionInputs,
                                                                         DataLoaderDispatcherInstrumentationOptions options) {
         ConfigurableDispatchInstrumentation dispatchInstrumentation;

src/main/java/graphql/servlet/context/DefaultGraphQLContextBuilder.java

@@ -5,6 +5,9 @@
 import javax.websocket.Session;
 import javax.websocket.server.HandshakeRequest;
 
+/**
+ * Returns an empty context.
+ */
 public class DefaultGraphQLContextBuilder implements GraphQLContextBuilder {
 
     @Override

src/main/java/graphql/servlet/context/DefaultGraphQLServletContext.java

@@ -5,6 +5,9 @@
 import javax.security.auth.Subject;
 import java.util.Optional;
 
+/**
+ * An object for the DefaultGraphQLContextBuilder to return. Can be extended to include more context.
+ */
 public class DefaultGraphQLServletContext implements GraphQLContext{
 
     private final Subject subject;

src/main/java/graphql/servlet/context/GraphQLContext.java

@@ -5,9 +5,18 @@
 import javax.security.auth.Subject;
 import java.util.Optional;
 
+/**
+ * Represents the context required by the servlet to execute a GraphQL request.
+ */
 public interface GraphQLContext {
 
+    /**
+     * @return the subject to execute the query as.
+     */
     Optional<Subject> getSubject();
 
+    /**
+     * @return the Dataloader registry to use for the execution.
+     */
     Optional<DataLoaderRegistry> getDataLoaderRegistry();
 }

src/main/java/graphql/servlet/input/BatchInputPreProcessResult.java

@@ -1,5 +1,8 @@
 package graphql.servlet.input;
 
+/**
+ * Wraps the result of pre processing a batch. Allows customization of the response code and message if the batch  isn't to be executed.
+ */
 public class BatchInputPreProcessResult {
 
     private final GraphQLBatchedInvocationInput batchedInvocationInput;
@@ -24,18 +27,30 @@ public BatchInputPreProcessResult(int statusCode, String messsage) {
         this.messsage = messsage;
    }
 
+    /**
+     * @return If the servlet should try executing this batched input
+     */
    public boolean isExecutable() {
         return executable;
    }
 
+    /**
+     * @return the batched input the servlet will try to execute.
+     */
    public GraphQLBatchedInvocationInput getBatchedInvocationInput() {
         return batchedInvocationInput;
    }
 
+    /**
+     * @return status message the servlet will use if isExecutable is false.
+     */
    public String getStatusMessage() {
         return messsage;
    }
 
+    /**
+     * @returnstatus code the servlet will use if if isExecutable is false.
+     */
    public int getStatusCode() {
         return statusCode;
    }

src/main/java/graphql/servlet/input/BatchInputPreProcessor.java

@@ -6,7 +6,7 @@
 public interface BatchInputPreProcessor {
 
     /**
-     * An injectable object that allows clients to manipulate a batch before executing, or abort altogether. If the returned result is not to be exeuted
+     * An injectable object that allows clients to manipulate a batch before executing, or abort altogether.
      * @param batchedInvocationInput  the input to process
      * @param request the servlet request
      * @param response the servlet response

src/main/java/graphql/servlet/input/GraphQLBatchedInvocationInput.java

@@ -2,7 +2,13 @@
 
 import java.util.List;
 
+/**
+ * Interface representing a batched input.
+ */
 public interface GraphQLBatchedInvocationInput {
 
+    /**
+     * @return each individual input in the batch, configured with a context.
+     */
     List<GraphQLSingleInvocationInput> getExecutionInputs();
 }

src/main/java/graphql/servlet/input/GraphQLSingleInvocationInput.java

@@ -11,7 +11,7 @@
 import java.util.Optional;
 
 /**
- * @author Andrew Potter
+ *  Represents a single GraphQL execution.
  */
 public class GraphQLSingleInvocationInput {
 
@@ -27,15 +27,21 @@ public GraphQLSingleInvocationInput(GraphQLRequest request, GraphQLSchema schema
         subject = context.getSubject();
     }
 
+    /**
+     * @return the schema to use to execute this query.
+     */
     public GraphQLSchema getSchema() {
         return schema;
     }
 
+    /**
+     * @return a subject to execute the query as.
+     */
     public Optional<Subject> getSubject() {
         return subject;
     }
 
-    protected ExecutionInput createExecutionInput(GraphQLRequest graphQLRequest, GraphQLContext context, Object root) {
+    private ExecutionInput createExecutionInput(GraphQLRequest graphQLRequest, GraphQLContext context, Object root) {
         return ExecutionInput.newExecutionInput()
             .query(graphQLRequest.getQuery())
             .operationName(graphQLRequest.getOperationName())

src/main/java/graphql/servlet/input/NoOpBatchInputPreProcessor.java

@@ -3,6 +3,9 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
+/**
+ * A default BatchInputPreProcessor that returns the input.
+ */
 public class NoOpBatchInputPreProcessor implements BatchInputPreProcessor {
 
     @Override

src/main/java/graphql/servlet/input/PerQueryBatchedInvocationInput.java

@@ -9,7 +9,7 @@
 import java.util.stream.Collectors;
 
 /**
- * @author Andrew Potter
+ * A Collection of GraphQLSingleInvocationInput that each have a unique context object.
  */
 public class PerQueryBatchedInvocationInput implements GraphQLBatchedInvocationInput {
     private final List<GraphQLSingleInvocationInput> inputs;
@@ -19,6 +19,7 @@ public PerQueryBatchedInvocationInput(List<GraphQLRequest> requests, GraphQLSche
             .map(request -> new GraphQLSingleInvocationInput(request, schema, contextSupplier.get(), root)).collect(Collectors.toList());
     }
 
+    @Override
     public List<GraphQLSingleInvocationInput> getExecutionInputs() {
         return inputs;
     }