io.vertx.ext.web.handler.graphql.ws.GraphQLWSHandler Maven / Gradle / Ivy
/*
* Copyright 2021 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.vertx.ext.web.handler.graphql.ws;
import graphql.GraphQL;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.ext.web.handler.ProtocolUpgradeHandler;
import io.vertx.ext.web.handler.graphql.ExecutionInputBuilderWithContext;
import io.vertx.ext.web.handler.graphql.impl.ws.GraphQLWSHandlerImpl;
import static io.vertx.codegen.annotations.GenIgnore.PERMITTED_TYPE;
/**
* A handler for the GraphQL over WebSocket Protocol.
*/
@VertxGen
public interface GraphQLWSHandler extends ProtocolUpgradeHandler {
/**
* Create a new {@link GraphQLWSHandler} that will use the provided {@code graphQL} object to execute requests.
*
* The handler will be configured with the default {@link GraphQLWSOptions}.
*/
@GenIgnore(PERMITTED_TYPE)
static GraphQLWSHandler create(GraphQL graphQL) {
return create(graphQL, new GraphQLWSOptions());
}
/**
* Create a new {@link GraphQLWSHandler} that will use the provided {@code graphQL} object to execute requests.
*
* The handler will be configured with the given {@code options}.
*
* @param options options for configuring the {@link GraphQLWSOptions}
*/
@GenIgnore(PERMITTED_TYPE)
static GraphQLWSHandler create(GraphQL graphQL, GraphQLWSOptions options) {
return new GraphQLWSHandlerImpl(graphQL, options);
}
/**
* Customize the connection init {@link Handler}.
* This handler will be called when the {@link MessageType#CONNECTION_INIT} message is received.
*
* @return a reference to this, so the API can be used fluently
*/
@Fluent
GraphQLWSHandler connectionInitHandler(Handler connectionInitHandler);
/**
* Set a callback to invoke before executing a GraphQL query.
*
* @param config the callback to invoke
* @return a reference to this, so the API can be used fluently
*/
@Fluent
GraphQLWSHandler beforeExecute(Handler> config);
/**
* Customize the message {@link Handler}.
* This handler will be called for each {@link Message} received.
*
* @return a reference to this, so the API can be used fluently
*/
@Fluent
GraphQLWSHandler messageHandler(Handler messageHandler);
}