Package org.springframework.graphql.support

Class DefaultGraphQlRequest

java.lang.Object

org.springframework.graphql.support.DefaultGraphQlRequest

All Implemented Interfaces:

GraphQlRequest

Direct Known Subclasses:

DefaultExecutionGraphQlRequest

public class DefaultGraphQlRequest
extends Object
implements GraphQlRequest

Default implementation of GraphQlRequest.

Since:

1.0.0

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EXTENSIONS_KEY
protected static final String	OPERATION_NAME_KEY
protected static final String	QUERY_KEY
protected static final String	VARIABLES_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultGraphQlRequest(String document)	Create a request.
DefaultGraphQlRequest(String document, String operationName, Map<String,Object> variables, Map<String,Object> extensions)	Create a request with a complete set of inputs.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDocument()	Return the GraphQL document which is the textual representation of an operation (or operations) to perform, including any selection sets and fragments.
Map<String,Object>	getExtensions()	Return implementor specific, protocol extensions, if any.
String	getOperationName()	Return the name of the operation in the document to execute, if the document contains multiple operations.
Map<String,Object>	getVariables()	Return values for variable defined by the operation.
int	hashCode()
Map<String,Object>	toMap()	Convert the request to a Map as defined in GraphQL over HTTP and GraphQL over WebSocket.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

QUERY_KEY

protected static final String QUERY_KEY

See Also:

• Constant Field Values

OPERATION_NAME_KEY

protected static final String OPERATION_NAME_KEY

See Also:

• Constant Field Values

VARIABLES_KEY

protected static final String VARIABLES_KEY

See Also:

• Constant Field Values

EXTENSIONS_KEY

protected static final String EXTENSIONS_KEY

See Also:

• Constant Field Values

Constructor Details

DefaultGraphQlRequest

public DefaultGraphQlRequest(String document)

Create a request.

Parameters:

document - textual representation of the operation(s)

DefaultGraphQlRequest

public DefaultGraphQlRequest(String document,
 @Nullable
 String operationName,
 @Nullable
 Map<String,Object> variables,
 @Nullable
 Map<String,Object> extensions)

Create a request with a complete set of inputs.

Parameters:

document - textual representation of the operation(s)

operationName - optionally, the name of the operation to execute

variables - variables by which the operation is parameterized

extensions - implementor specific, protocol extensions

Method Details

getDocument

public String getDocument()

Description copied from interface: GraphQlRequest

Return the GraphQL document which is the textual representation of an operation (or operations) to perform, including any selection sets and fragments.

Specified by:

getDocument in interface GraphQlRequest

getOperationName

@Nullable
public String getOperationName()

Description copied from interface: GraphQlRequest

Return the name of the operation in the document to execute, if the document contains multiple operations.

Specified by:

getOperationName in interface GraphQlRequest

getVariables

public Map<String,Object> getVariables()

Description copied from interface: GraphQlRequest

Return values for variable defined by the operation.

Specified by:

getVariables in interface GraphQlRequest

getExtensions

public Map<String,Object> getExtensions()

Description copied from interface: GraphQlRequest

Return implementor specific, protocol extensions, if any.

Specified by:

getExtensions in interface GraphQlRequest

toMap

public Map<String,Object> toMap()

Description copied from interface: GraphQlRequest

Convert the request to a Map as defined in GraphQL over HTTP and GraphQL over WebSocket.

Key	Value
query	document
operationName	operationName
variables	variables

Specified by:

toMap in interface GraphQlRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object