Move from readme to documentation

oliemansm · oliemansm · commit 4f18d90b2e88 · 2020-05-16T10:52:35.000+02:00
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ This project wraps the Java implementation of GraphQL provided by [GraphQL Java]
 See [GraphQL Java documentation](https://www.graphql-java.com/documentation/latest/) for more in depth details
 regarding GraphQL Java itself. 
 
-We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 11.0**.
+We try to stay up to date with GraphQL Java as much as possible. The current version supports **GraphQL Java 14.0**.
  
 This project requires at least Java 8.
 
@@ -103,67 +103,13 @@ The servlet supports the following request formats:
 * POST multipart parts named "query", "operationName" (optional), and "variables" (optional)
 * POST with Content Type "application/graphql" will treat the HTTP POST body contents as the GraphQL query string
 
-## Servlet Listeners
-
-You can also add [servlet listeners](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLServletListener.java) to an existing servlet.
-These listeners provide hooks into query execution (before, success, failure, and finally) and servlet execution (before, success, error, and finally):
-```java
-servlet.addListener(new GraphQLServletListener() {
-    @Override
-    GraphQLServletListener.RequestCallback onRequest(HttpServletRequest request, HttpServletResponse response) {
-
-        return new GraphQLServletListener.RequestCallback() {
-            @Override
-            void onSuccess(HttpServletRequest request, HttpServletResponse response) {
-
-            }
-
-            @Override
-            void onError(HttpServletRequest request, HttpServletResponse response, Throwable throwable) {
-
-            }
-
-            @Override
-            void onFinally(HttpServletRequest request, HttpServletResponse response) {
-
-            }
-        }
-    }
-
-    @Override
-    GraphQLServletListener.OperationCallback onOperation(GraphQLContext context, String operationName, String query, Map<String, Object> variables) {
-
-        return new GraphQLServletListener.OperationCallback() {
-            @Override
-            void onSuccess(GraphQLContext context, String operationName, String query, Map<String, Object> variables, Object data) {
-
-            }
-
-            @Override
-            void onError(GraphQLContext context, String operationName, String query, Map<String, Object> variables, Object data, List<GraphQLError> errors) {
-
-            }
-
-            @Override
-            void onFinally(GraphQLContext context, String operationName, String query, Map<String, Object> variables, Object data) {
-
-            }
-        }
-    }
-})
-```
-
 ## Relay.js support
 
 Relay.js support is provided by the [EnhancedExecutionStrategy](https://github.com/graphql-java/graphql-java-annotations/blob/master/src/main/java/graphql/annotations/EnhancedExecutionStrategy.java) of [graphql-java-annotations](https://github.com/graphql-java/graphql-java-annotations).
 You **MUST** pass this execution strategy to the servlet for Relay.js support.
 
 This is the default execution strategy for the `OsgiGraphQLHttpServlet`, and must be added as a dependency when using that servlet.
 
-## Apollo support
-
-Query batching is supported, no configuration required.
-
 ## Spring Framework support
 
 To use the servlet with Spring Framework, either use the [Spring Boot starter](https://github.com/graphql-java/graphql-spring-boot) or simply define a `ServletRegistrationBean` in a web app:
@@ -173,121 +119,3 @@ ServletRegistrationBean graphQLServletRegistrationBean(GraphQLSchema schema, Exe
     return new ServletRegistrationBean(new SimpleGraphQLServlet(schema, executionStrategy, operationListeners), "/graphql");
 }
 ```
-
-## OSGI support
-
-The [OsgiGraphQLHttpServlet](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/OsgiGraphQLHttpServlet.java) uses a "provider" model to supply the servlet with the required objects:
-* [GraphQLQueryProvider](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLQueryProvider.java): Provides query fields to the GraphQL schema.
-* [GraphQLMutationProvider](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLMutationProvider.java): Provides mutation fields to the GraphQL schema.
-* [GraphQLTypesProvider](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLTypesProvider.java): Provides type information to the GraphQL schema.
-* [ExecutionStrategyProvider](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/ExecutionStrategyProvider.java): Provides an execution strategy for running each query.
-* [GraphQLContextBuilder](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/GraphQLContextBuilder.java): Builds a context for running each query.
-
-## Examples
-
-You can now find some example on how to use graphql-java-servlet.
-
-### OSGi Examples
-
-#### Requirements
-
-The OSGi examples use Maven as a build tool because it requires plugins that are not (yet) available for Gradle.
-Therefore you will need Maven 3.2+.
-
-#### Building & running the OSGi examples
-
-You can build the OSGi examples sub-projects by simply executing the following command from the examples/osgi directory:
-
-    mvn clean install
-     
-This will generate a complete Apache Karaf distribution in the following files:
-     
-     examples/osgi/apache-karaf-package/target/graphql-java-servlet-osgi-examples-apache-karaf-package-VERSION.tar.gz(.zip)
-     
-You can simply uncompress this file and launch the OSGi server using the command from the uncompressed directory:
-
-    bin/karaf
-    
-You should then be able to access the GraphQL endpoint at the following URL once the server is started:
-
-    http://localhost:8181/graphql/schema.json
-    
-If you see the JSON result of an introspection query, then all is ok. If not, check the data/log/karaf.log file for 
-any errors.
-    
-We also provide a script file to do all of the building and running at once (only for Linux / MacOS ):
-
-    ./buildAndRun.sh
-
-#### Deploying inside Apache Karaf server
-
-You can use the graphql-java-servlet as part of an Apache Karaf feature, as you can see in the example project here:
-* [pom.xml](examples/osgi/apache-karaf-feature/pom.xml)
-
-And here is a sample src/main/feature/feature.xml file to add some dependencies on other features:
-* [feature.xml](examples/osgi/apache-karaf-feature/src/main/feature/feature.xml)
-
-#### Example GraphQL provider implementation
-
-Here's an example of a GraphQL provider that implements three interfaces at the same time.
-
-* [ExampleGraphQLProvider](examples/osgi/providers/src/main/java/graphql/servlet/examples/osgi/ExampleGraphQLProvider.java)
-
-## Context and DataLoader settings
-
-It is possible to create context, and consequently dataloaders, in both a request scope and a per query scope by customizing [GraphQLContextBuilder](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/context/GraphQLContextBuilder.java) and selecting the appropriate [ContextSetting](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/context/ContextSetting.java) with the provided [GraphQLConfiguration](https://github.com/graphql-java-kickstart/graphql-java-servlet/blob/master/src/main/java/graphql/servlet/config/GraphQLConfiguration.java).
-A new [DataLoaderRegistry](https://github.com/graphql-java/java-dataloader/blob/master/src/main/java/org/dataloader/DataLoaderRegistry.java) should be created in each call to the GraphQLContextBuilder, and the servlet will call the builder at the appropriate times.
-For eg:
-```java
-public class CustomGraphQLContextBuilder implements GraphQLContextBuilder {
-
-    private final DataLoader userDataLoader;
-
-    public CustomGraphQLContextBuilder(DataLoader userDataLoader) {
-        this.userDataLoader = userDataLoader;
-    }
-
-
-    public GraphQLContext build() {
-        return new DefaultGraphQLContext();
-    }
-
-    public GraphQLContext build(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) {
-        return DefaultGraphQLServletContext.createServletContext()
-                .with(httpServletRequest)
-                .with(httpServletResponse)
-                .with(buildDataLoaderRegistry())
-                .build();
-    }
-
-    public GraphQLContext build(Session session, HandshakeRequest handshakeRequest) {
-        return DefaultGraphQLWebSocketContext.createWebSocketContext()
-                .with(session)
-                .with(handshakeRequest)
-                .with(buildDataLoaderRegistry())
-                .build();
-    }
-
-    private DataLoaderRegistry buildDataLoaderRegistry() {
-        DataLoaderRegistry registry = new DataLoaderRegistry();
-        for (BatchLoader batchLoader: this.batchLoaders) {
-            registry.register(batchLoader.getClass().getSimpleName(), DataLoader.newDataLoader(batchLoader));
-        }
-        return registry;
-    }
-}
-```
- It is then possible to access the [DataLoader](https://github.com/graphql-java/java-dataloader/blob/master/src/main/java/org/dataloader/DataLoader.java) in the resolvers by accessing the [DataLoaderRegistry] from context. For eg:
- ```java
- public CompletableFuture<String> getEmailAddress(User user, DataFetchingEnvironment dfe) { // User is the graphQL type
-         final DataLoader<String, UserDetail> userDataloader =
-                dfe.getContext().getDataLoaderRegistry().get().getDataLoader("userDataLoader"); // UserDetail is the data that is loaded
-
-         return userDataloader.load(User.getName())
-                 .thenApply(userDetail -> userDetail != null ? userDetail.getEmailAddress() : null);
-     }
-
- ```
- If per request is selected this will cause all queries within the http request, if using a batch, to share dataloader caches and batch together load calls as efficently as possible. The dataloaders are dispatched using instrumentation and the correct instrumentation will be selected according to the ContextSetting. The default context setting in GraphQLConfiguration is per query.
- 
- Two additional context settings are provided, one for each of the previous settings but without the addition of the Dataloader dispatching instrumentation. This is useful for those not using Dataloaders or wanting to supply their own dispatching instrumentation though the instrumentation supplier within the GraphQLQueryInvoker.
