Package graphql.kickstart.servlet.config

Interface GraphQLSchemaServletProvider

All Superinterfaces:
graphql.kickstart.execution.config.GraphQLSchemaProvider
All Known Implementing Classes:
DefaultGraphQLSchemaServletProvider
public interface GraphQLSchemaServletProvider extends graphql.kickstart.execution.config.GraphQLSchemaProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    graphql.schema.GraphQLSchema
    getReadOnlySchema(jakarta.servlet.http.HttpServletRequest request)
     
    graphql.schema.GraphQLSchema
    getSchema(jakarta.servlet.http.HttpServletRequest request)
     
    graphql.schema.GraphQLSchema
    getSchema(jakarta.websocket.server.HandshakeRequest request)
     

    Methods inherited from interface graphql.kickstart.execution.config.GraphQLSchemaProvider

    getReadOnlySchema, getSchema

  • Method Details

    • getSchema

      graphql.schema.GraphQLSchema getSchema(jakarta.servlet.http.HttpServletRequest request)
      Parameters:
      request - the http request
      Returns:
      a schema based on the request (auth, etc).

    • getSchema

      graphql.schema.GraphQLSchema getSchema(jakarta.websocket.server.HandshakeRequest request)
      Parameters:
      request - the http request used to create a websocket
      Returns:
      a schema based on the request (auth, etc).

    • getReadOnlySchema

      graphql.schema.GraphQLSchema getReadOnlySchema(jakarta.servlet.http.HttpServletRequest request)
      Parameters:
      request - the http request
      Returns:
      a read-only schema based on the request (auth, etc). Should return the same schema (query/subscription-only version) as getSchema(HttpServletRequest) for a given request.