org.springframework.graphql

Class RequestInput

java.lang.Object

org.springframework.graphql.RequestInput

Direct Known Subclasses:

WebInput

public class RequestInput
extends Object

Common representation for GraphQL request input. This can be converted to ExecutionInput via toExecutionInput() and the ExecutionInput further customized via configureExecutionInput(BiFunction).

Since:

1.0.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
RequestInput(Map<String,Object> body)
RequestInput(String query, String operationName, Map<String,Object> vars)

Method Summary

Modifier and Type	Method and Description
void	configureExecutionInput(BiFunction<ExecutionInput,ExecutionInput.Builder,ExecutionInput> configurer) Provide a consumer to configure the ExecutionInput used for input to GraphQL.executeAsync(ExecutionInput).
String	getOperationName() Return the operation name extracted from the request body or null if not provided.
String	getQuery() Return the query name extracted from the request body.
Map<String,Object>	getVariables() Return the variables that can be referenced via $syntax extracted from the request body or a null if not provided.
ExecutionInput	toExecutionInput() Create the ExecutionInput for request execution.
Map<String,Object>	toMap() Return a Map representation of the request input.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestInput

public RequestInput(String query,
                    @Nullable
                    String operationName,
                    @Nullable
                    Map<String,Object> vars)

RequestInput

public RequestInput(Map<String,Object> body)

Method Detail

getQuery

public String getQuery()

Return the query name extracted from the request body. This is guaranteed to be a non-empty string.

Returns:

the query name

getOperationName

@Nullable
public String getOperationName()

Return the operation name extracted from the request body or null if not provided.

Returns:

the operation name or null

getVariables

public Map<String,Object> getVariables()

Return the variables that can be referenced via $syntax extracted from the request body or a null if not provided.

Returns:

the request variables or null

configureExecutionInput

public void configureExecutionInput(BiFunction<ExecutionInput,ExecutionInput.Builder,ExecutionInput> configurer)

Provide a consumer to configure the ExecutionInput used for input to GraphQL.executeAsync(ExecutionInput). The builder is initially populated with the values from getQuery(), getOperationName(), and getVariables().

Parameters:

configurer - a BiFunction with the current ExecutionInput and a builder to modify it.

toExecutionInput

public ExecutionInput toExecutionInput()

Create the ExecutionInput for request execution. This is initially populated from getQuery(), getOperationName(), and getVariables(), and is then further customized through configureExecutionInput(BiFunction).

Returns:

the execution input

toMap

public Map<String,Object> toMap()

Return a Map representation of the request input.

Returns:

map representation of the input

toString

public String toString()

Overrides:

toString in class Object