Class FederationSchemaFactory

java.lang.Object

org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

org.springframework.graphql.data.federation.FederationSchemaFactory

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware

public final class FederationSchemaFactory
extends AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

Detects @EntityMapping handler methods on controllers declared in Spring configuration, and provides factory methods to create GraphQLSchema or SchemaTransformer.

This class is intended to be declared as a bean in Spring configuration, and plugged in via GraphQlSource.SchemaResourceBuilder.schemaFactory(BiFunction).

Since:

1.3.0

Author:

Rossen Stoyanchev

See Also:

• Federation.transform(TypeDefinitionRegistry, RuntimeWiring)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FederationSchemaFactory.EntityMappingInfo

Field Summary

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

logger, springSecurityPresent

Constructor Summary

Constructors

Constructor	Description
FederationSchemaFactory()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
graphql.schema.GraphQLSchema	createGraphQLSchema(graphql.schema.idl.TypeDefinitionRegistry registry, graphql.schema.idl.RuntimeWiring wiring)	Create GraphQLSchema via SchemaTransformer, setting up the "_entities" DataFetcher and TypeResolver for federated types.
com.apollographql.federation.graphqljava.SchemaTransformer	createSchemaTransformer(graphql.schema.idl.TypeDefinitionRegistry registry, graphql.schema.idl.RuntimeWiring wiring)	Alternative to createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) that allows calling additional methods on SchemaTransformer.
protected HandlerMethod	getHandlerMethod(FederationSchemaFactory.EntityMappingInfo mappingInfo)
protected @Nullable FederationSchemaFactory.EntityMappingInfo	getMappingInfo(Method method, Object handler, Class<?> handlerType)
protected HandlerMethodArgumentResolverComposite	initArgumentResolvers()
void	setTypeResolver(@Nullable graphql.schema.TypeResolver typeResolver)	Configure a resolver that helps to map Java to entity schema type names.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

FederationSchemaFactory

public FederationSchemaFactory()

Method Details

setTypeResolver

public void setTypeResolver(@Nullable graphql.schema.TypeResolver typeResolver)

Configure a resolver that helps to map Java to entity schema type names.

By default, this is ClassNameTypeResolver.

Parameters:

typeResolver - the custom type resolver to use

See Also:

• SchemaTransformer.resolveEntityType(TypeResolver)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

initArgumentResolvers

protected HandlerMethodArgumentResolverComposite initArgumentResolvers()

Specified by:

initArgumentResolvers in class AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

getMappingInfo

protected @Nullable FederationSchemaFactory.EntityMappingInfo getMappingInfo(Method method,
 Object handler,
 Class<?> handlerType)

Specified by:

getMappingInfo in class AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

getHandlerMethod

protected HandlerMethod getHandlerMethod(FederationSchemaFactory.EntityMappingInfo mappingInfo)

Specified by:

getHandlerMethod in class AnnotatedControllerDetectionSupport<FederationSchemaFactory.EntityMappingInfo>

createGraphQLSchema

public graphql.schema.GraphQLSchema createGraphQLSchema(graphql.schema.idl.TypeDefinitionRegistry registry,
 graphql.schema.idl.RuntimeWiring wiring)

Create GraphQLSchema via SchemaTransformer, setting up the "_entities" DataFetcher and TypeResolver for federated types.

Use this to supply a schemaFactory.

Parameters:

registry - the existing type definition registry

wiring - the existing runtime wiring

createSchemaTransformer

public com.apollographql.federation.graphqljava.SchemaTransformer createSchemaTransformer(graphql.schema.idl.TypeDefinitionRegistry registry,
 graphql.schema.idl.RuntimeWiring wiring)

Alternative to createGraphQLSchema(TypeDefinitionRegistry, RuntimeWiring) that allows calling additional methods on SchemaTransformer.

Parameters:

registry - the existing type definition registry

wiring - the existing runtime wiring