Package graphql.kickstart.servlet

Class GraphQLWebsocketServlet

java.lang.Object
jakarta.websocket.Endpoint
graphql.kickstart.servlet.GraphQLWebsocketServlet
public class GraphQLWebsocketServlet extends jakarta.websocket.Endpoint
Must be used with modifyHandshake(ServerEndpointConfig, HandshakeRequest, HandshakeResponse)

  • Constructor Summary

    Constructors
    Constructor
    Description
    GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper)
     
    GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper, Collection<graphql.kickstart.execution.subscriptions.SubscriptionConnectionListener> connectionListeners)
     
    GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper, List<graphql.kickstart.execution.subscriptions.SubscriptionProtocolFactory> subscriptionProtocolFactory, graphql.kickstart.execution.subscriptions.SubscriptionProtocolFactory fallbackSubscriptionProtocolFactory)
     
    GraphQLWebsocketServlet(GraphQLConfiguration configuration)
     
    GraphQLWebsocketServlet(GraphQLConfiguration configuration, Collection<graphql.kickstart.execution.subscriptions.SubscriptionConnectionListener> connectionListeners)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginShutDown()
    Stops accepting connections and closes all existing connections
    int
    getSessionCount()
     
    int
    getSubscriptionCount()
     
    boolean
    isShutDown()
     
    void
    modifyHandshake(jakarta.websocket.server.ServerEndpointConfig sec, jakarta.websocket.server.HandshakeRequest request, jakarta.websocket.HandshakeResponse response)
     
    void
    onClose(jakarta.websocket.Session session, jakarta.websocket.CloseReason closeReason)
     
    void
    onError(jakarta.websocket.Session session, Throwable thr)
     
    void
    onOpen(jakarta.websocket.Session session, jakarta.websocket.EndpointConfig endpointConfig)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GraphQLWebsocketServlet

      public GraphQLWebsocketServlet(GraphQLConfiguration configuration)

    • GraphQLWebsocketServlet

      public GraphQLWebsocketServlet(GraphQLConfiguration configuration, Collection<graphql.kickstart.execution.subscriptions.SubscriptionConnectionListener> connectionListeners)

    • GraphQLWebsocketServlet

      public GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper)

    • GraphQLWebsocketServlet

      public GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper, Collection<graphql.kickstart.execution.subscriptions.SubscriptionConnectionListener> connectionListeners)

    • GraphQLWebsocketServlet

      public GraphQLWebsocketServlet(graphql.kickstart.execution.GraphQLInvoker graphQLInvoker, graphql.kickstart.execution.subscriptions.GraphQLSubscriptionInvocationInputFactory invocationInputFactory, graphql.kickstart.execution.GraphQLObjectMapper graphQLObjectMapper, List<graphql.kickstart.execution.subscriptions.SubscriptionProtocolFactory> subscriptionProtocolFactory, graphql.kickstart.execution.subscriptions.SubscriptionProtocolFactory fallbackSubscriptionProtocolFactory)

  • Method Details

    • onOpen

      public void onOpen(jakarta.websocket.Session session, jakarta.websocket.EndpointConfig endpointConfig)
      Specified by:
      onOpen in class jakarta.websocket.Endpoint

    • onClose

      public void onClose(jakarta.websocket.Session session, jakarta.websocket.CloseReason closeReason)
      Overrides:
      onClose in class jakarta.websocket.Endpoint

    • onError

      public void onError(jakarta.websocket.Session session, Throwable thr)
      Overrides:
      onError in class jakarta.websocket.Endpoint

    • modifyHandshake

      public void modifyHandshake(jakarta.websocket.server.ServerEndpointConfig sec, jakarta.websocket.server.HandshakeRequest request, jakarta.websocket.HandshakeResponse response)

    • beginShutDown

      public void beginShutDown()
      Stops accepting connections and closes all existing connections

    • isShutDown

      public boolean isShutDown()
      Returns:
      true when shutdown is complete

    • getSessionCount

      public int getSessionCount()

    • getSubscriptionCount

      public int getSubscriptionCount()