Class GraphiQLHandler
- java.lang.Object
-
- io.vertx.reactivex.ext.web.handler.graphql.GraphiQLHandler
-
- All Implemented Interfaces:
Handler<RoutingContext>
public class GraphiQLHandler extends Object implements Handler<RoutingContext>
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<GraphiQLHandler>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description GraphiQLHandler(GraphiQLHandler delegate)
GraphiQLHandler(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GraphiQLHandler
create()
Create a newGraphiQLHandler
.static GraphiQLHandler
create(GraphiQLHandlerOptions options)
Create a newGraphiQLHandler
.boolean
equals(Object o)
GraphiQLHandler
getDelegate()
GraphiQLHandler
graphiQLRequestHeaders(Function<RoutingContext,MultiMap> factory)
Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface.void
handle(RoutingContext event)
Something has happened, so handle it.int
hashCode()
static GraphiQLHandler
newInstance(GraphiQLHandler arg)
String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<GraphiQLHandler> __TYPE_ARG
-
-
Constructor Detail
-
GraphiQLHandler
public GraphiQLHandler(GraphiQLHandler delegate)
-
GraphiQLHandler
public GraphiQLHandler(Object delegate)
-
-
Method Detail
-
getDelegate
public GraphiQLHandler getDelegate()
-
handle
public void handle(RoutingContext event)
Something has happened, so handle it.- Specified by:
handle
in interfaceHandler<RoutingContext>
- Parameters:
event
- the event to handle
-
create
public static GraphiQLHandler create()
Create a newGraphiQLHandler
.The handler will be configured with default
GraphiQLHandlerOptions
.- Returns:
-
create
public static GraphiQLHandler create(GraphiQLHandlerOptions options)
Create a newGraphiQLHandler
.The handler will be configured with the given
options
.- Parameters:
options
- options for configuring theGraphiQLHandler
- Returns:
-
graphiQLRequestHeaders
public GraphiQLHandler graphiQLRequestHeaders(Function<RoutingContext,MultiMap> factory)
Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface. The result will be applied on top of the fixed set of headers specified inGraphiQLHandlerOptions
.This can be useful if, for example, the server is protected by authentication.
- Parameters:
factory
-- Returns:
- a reference to this, so the API can be used fluently
-
newInstance
public static GraphiQLHandler newInstance(GraphiQLHandler arg)
-
-