org.springframework.graphql.data.method

Class InvocableHandlerMethod

java.lang.Object

org.springframework.graphql.data.method.HandlerMethod

org.springframework.graphql.data.method.InvocableHandlerMethod

public class InvocableHandlerMethod
extends HandlerMethod

Extension of HandlerMethod that can resolve method arguments from a DataFetchingEnvironment and invoke the method.

Since:

1.0.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.graphql.data.method.HandlerMethod

HandlerMethod.HandlerMethodParameter

Field Summary

Fields inherited from class org.springframework.graphql.data.method.HandlerMethod

logger

Constructor Summary

Constructors

Constructor and Description
InvocableHandlerMethod(HandlerMethod handlerMethod, HandlerMethodArgumentResolverComposite resolvers)

Method Summary

Modifier and Type	Method and Description
protected Object	doInvoke(Object... args) Invoke the handler method with the given argument values.
protected Object[]	getMethodArgumentValues(DataFetchingEnvironment environment, Object... providedArgs) Get the method argument values for the current request, checking the provided argument values and falling back to the configured argument resolvers.
HandlerMethodArgumentResolverComposite	getResolvers() Return the configured argument resolvers.
Object	invoke(DataFetchingEnvironment environment) Invoke the method after resolving its argument values in the context of the given environment.

Methods inherited from class org.springframework.graphql.data.method.HandlerMethod

assertTargetBean, createWithResolvedBean, equals, findProvidedArgument, formatArgumentError, formatInvokeError, getBean, getBeanType, getBridgedMethod, getMethod, getMethodAnnotation, getMethodParameters, getReturnType, getReturnValueType, getShortLogMessage, hashCode, hasMethodAnnotation, isVoid, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvocableHandlerMethod

public InvocableHandlerMethod(HandlerMethod handlerMethod,
                              HandlerMethodArgumentResolverComposite resolvers)

Method Detail

getResolvers

public HandlerMethodArgumentResolverComposite getResolvers()

Return the configured argument resolvers.

invoke

@Nullable
public Object invoke(DataFetchingEnvironment environment)
                        throws Exception

Invoke the method after resolving its argument values in the context of the given environment.

Argument values are commonly resolved through HandlerMethodArgumentResolvers. The providedArgs parameter however may supply argument values to be used directly, i.e. without argument resolution. Provided argument values are checked before argument resolvers.

Parameters:

environment - the GraphQL DataFetchingEnvironment

Returns:

the raw value returned by the invoked method

Throws:

Exception - raised if no suitable argument resolver can be found, or if the method raised an exception

See Also:

getMethodArgumentValues(graphql.schema.DataFetchingEnvironment, java.lang.Object...), doInvoke(java.lang.Object...)

getMethodArgumentValues

protected Object[] getMethodArgumentValues(DataFetchingEnvironment environment,
                                           Object... providedArgs)
                                    throws Exception

Get the method argument values for the current request, checking the provided argument values and falling back to the configured argument resolvers.

The resulting array will be passed into doInvoke(java.lang.Object...).

Throws:

Exception

doInvoke

@Nullable
protected Object doInvoke(Object... args)
                             throws Exception

Invoke the handler method with the given argument values.

Throws:

Exception