graphql.servlet.GraphQLSchemaProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphql-java-servlet Show documentation

relay.js-compatible GraphQL servlet

There is a newer version: 6.1.3

package graphql.servlet;

import graphql.schema.GraphQLSchema;

import javax.servlet.http.HttpServletRequest;
import javax.websocket.server.HandshakeRequest;

public interface GraphQLSchemaProvider {

    static GraphQLSchema copyReadOnly(GraphQLSchema schema) {
        return GraphQLSchema.newSchema().query(schema.getQueryType()).build(schema.getAdditionalTypes());
    }

    /**
     * @param request the http request
     * @return a schema based on the request (auth, etc).
     */
    GraphQLSchema getSchema(HttpServletRequest request);

    /**
     * @param request the http request used to create a websocket
     * @return a schema based on the request (auth, etc).
     */
    GraphQLSchema getSchema(HandshakeRequest request);

    /**
     * @return a schema for handling mbean calls.
     */
    GraphQLSchema getSchema();

    /**
     * @param request the http request
     * @return a read-only schema based on the request (auth, etc).  Should return the same schema (query-only version) as {@link #getSchema(HttpServletRequest)} for a given request.
     */
    GraphQLSchema getReadOnlySchema(HttpServletRequest request);
}