Package org.springframework.graphql.data.method.annotation.support

Class AnnotatedControllerConfigurer

java.lang.Object

org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>

org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, RuntimeWiringConfigurer

public class AnnotatedControllerConfigurer
extends AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>
implements RuntimeWiringConfigurer

RuntimeWiringConfigurer that finds @SchemaMapping and @BatchMapping methods in @Controller classes, and registers them as DataFetchers.

This class detects the following strategies in Spring configuration, expecting to find a single, unique bean of that type:

• CursorStrategy -- if Spring Data is present, and the strategy supports ScrollPosition, then ScrollSubrangeMethodArgumentResolver is configured for use. If not, then SubrangeMethodArgumentResolver is added instead.
• SortStrategy -- if present, then SortMethodArgumentResolver is configured for use.

In addition to initializing a RuntimeWiring.Builder, this class, also provides an option to configure data fetchers on a GraphQLCodeRegistry.Builder.

Since:

1.0.0

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields inherited from class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

logger

Constructor Summary

Constructors

Constructor	Description
AnnotatedControllerConfigurer()

Method Summary

Modifier and Type	Method	Description
void	addCustomArgumentResolver(HandlerMethodArgumentResolver resolver)	Add a HandlerMethodArgumentResolver for custom controller method arguments.
void	afterPropertiesSet()
void	configure(GraphQLCodeRegistry.Builder codeRegistryBuilder)	Alternative to configure(RuntimeWiring.Builder) that registers data fetchers in a GraphQLCodeRegistry.Builder.
void	configure(RuntimeWiring.Builder runtimeWiringBuilder)	Apply changes to the RuntimeWiring.Builder such as registering DataFetchers, custom scalar types, and more.
protected static String	formatRegistrations(RuntimeWiring.Builder wiringBuilder)
protected HandlerMethod	getHandlerMethod(DataFetcherMappingInfo mappingInfo)
protected DataFetcherMappingInfo	getMappingInfo(Method method, Object handler, Class<?> handlerType)
protected HandlerMethodArgumentResolverComposite	initArgumentResolvers()
void	setDataBinderInitializer(Consumer<DataBinder> consumer)	Deprecated, for removal: This API element is subject to removal in a future version. this property is deprecated, ignored, and should not be necessary as a DataBinder is no longer used to bind arguments
void	setTypeDefinitionRegistry(TypeDefinitionRegistry registry)	Provides the configurer access to the TypeDefinitionRegistry.

Methods inherited from class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

addFormatterRegistrar, createHandlerMethod, detectHandlerMethods, getApplicationContext, getArgumentResolvers, getConversionService, getExceptionResolver, getExecutor, isFallBackOnDirectFieldAccess, obtainApplicationContext, setApplicationContext, setBlockingMethodPredicate, setExecutor, setFallBackOnDirectFieldAccess, shouldInvokeAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.graphql.execution.RuntimeWiringConfigurer

configure

Constructor Details

AnnotatedControllerConfigurer

public AnnotatedControllerConfigurer()

Method Details

addCustomArgumentResolver

public void addCustomArgumentResolver(HandlerMethodArgumentResolver resolver)

Add a HandlerMethodArgumentResolver for custom controller method arguments. Such custom resolvers are ordered after built-in resolvers except for SourceMethodArgumentResolver, which is always last.

Parameters:

resolver - the resolver to add.

Since:

1.2.0

setTypeDefinitionRegistry

public void setTypeDefinitionRegistry(TypeDefinitionRegistry registry)

Description copied from interface: RuntimeWiringConfigurer

Provides the configurer access to the TypeDefinitionRegistry.

Specified by:

setTypeDefinitionRegistry in interface RuntimeWiringConfigurer

Parameters:

registry - the registry

setDataBinderInitializer

@Deprecated(since="1.1.0",
            forRemoval=true)
public void setDataBinderInitializer(@Nullable
 Consumer<DataBinder> consumer)

Deprecated, for removal: This API element is subject to removal in a future version.

this property is deprecated, ignored, and should not be necessary as a DataBinder is no longer used to bind arguments

Configure an initializer that configures the DataBinder before the binding process.

Parameters:

consumer - the data binder initializer

Since:

1.0.1

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>

initArgumentResolvers

protected HandlerMethodArgumentResolverComposite initArgumentResolvers()

Specified by:

initArgumentResolvers in class AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>

configure

public void configure(RuntimeWiring.Builder runtimeWiringBuilder)

Description copied from interface: RuntimeWiringConfigurer

Apply changes to the RuntimeWiring.Builder such as registering DataFetchers, custom scalar types, and more.

Specified by:

configure in interface RuntimeWiringConfigurer

Parameters:

runtimeWiringBuilder - the builder to configure

getMappingInfo

protected DataFetcherMappingInfo getMappingInfo(Method method,
 Object handler,
 Class<?> handlerType)

Specified by:

getMappingInfo in class AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>

getHandlerMethod

protected HandlerMethod getHandlerMethod(DataFetcherMappingInfo mappingInfo)

Specified by:

getHandlerMethod in class AnnotatedControllerDetectionSupport<DataFetcherMappingInfo>

formatRegistrations

protected static String formatRegistrations(RuntimeWiring.Builder wiringBuilder)

configure

public void configure(GraphQLCodeRegistry.Builder codeRegistryBuilder)

Alternative to configure(RuntimeWiring.Builder) that registers data fetchers in a GraphQLCodeRegistry.Builder. This could be used with programmatic creation of GraphQLSchema.

Parameters:

codeRegistryBuilder - the code registry