graphql.schema.GraphQLSchema Maven / Gradle / Ivy
package graphql.schema;
import graphql.Directives;
import graphql.Internal;
import graphql.PublicApi;
import graphql.schema.validation.InvalidSchemaException;
import graphql.schema.validation.SchemaValidationError;
import graphql.schema.validation.SchemaValidator;
import graphql.schema.visibility.GraphqlFieldVisibility;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.function.Consumer;
import static graphql.Assert.assertNotNull;
import static graphql.Assert.assertShouldNeverHappen;
import static graphql.Assert.assertTrue;
import static graphql.schema.GraphqlTypeComparators.byNameAsc;
import static graphql.schema.GraphqlTypeComparators.sortTypes;
import static java.lang.String.format;
import static java.util.Arrays.asList;
/**
* The schema represents the combined type system of the graphql engine. This is how the engine knows
* what graphql queries represent what data.
*
* See http://graphql.org/learn/schema/#type-language for more details
*/
@PublicApi
public class GraphQLSchema {
private final GraphQLObjectType queryType;
private final GraphQLObjectType mutationType;
private final GraphQLObjectType subscriptionType;
private final Map typeMap;
private final Set additionalTypes = new LinkedHashSet<>();
private final Set directives = new LinkedHashSet<>();
private final Map> byInterface;
private final GraphQLCodeRegistry codeRegistry;
/**
* @param queryType the query type
*
* @deprecated use the {@link #newSchema()} builder pattern instead, as this constructor will be made private in a future version.
*/
@Internal
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType) {
this(queryType, null, Collections.emptySet());
}
/**
* @param queryType the query type
* @param mutationType the mutation type
* @param additionalTypes additional types
*
* @deprecated use the {@link #newSchema()} builder pattern instead, as this constructor will be made private in a future version.
*/
@Internal
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, Set additionalTypes) {
this(queryType, mutationType, null, additionalTypes);
}
/**
* @param queryType the query type
* @param mutationType the mutation type
* @param subscriptionType the subscription type
* @param additionalTypes additional types
*
* @deprecated use the {@link #newSchema()} builder pattern instead, as this constructor will be made private in a future version.
*/
@Internal
@Deprecated
public GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, GraphQLObjectType subscriptionType, Set additionalTypes) {
this(queryType, mutationType, subscriptionType, additionalTypes, Collections.emptySet(), GraphQLCodeRegistry.newCodeRegistry().build());
}
@Internal
private GraphQLSchema(GraphQLObjectType queryType, GraphQLObjectType mutationType, GraphQLObjectType subscriptionType, Set additionalTypes, Set directives, GraphQLCodeRegistry codeRegistry) {
assertNotNull(additionalTypes, "additionalTypes can't be null");
assertNotNull(queryType, "queryType can't be null");
assertNotNull(directives, "directives can't be null");
assertNotNull(codeRegistry, "codeRegistry can't be null");
this.queryType = queryType;
this.mutationType = mutationType;
this.subscriptionType = subscriptionType;
this.additionalTypes.addAll(additionalTypes);
this.directives.addAll(directives);
// sorted by type name
SchemaUtil schemaUtil = new SchemaUtil();
this.typeMap = new TreeMap<>(schemaUtil.allTypes(this, additionalTypes));
this.byInterface = new TreeMap<>(schemaUtil.groupImplementations(this));
this.codeRegistry = codeRegistry;
}
// This can be removed once we no longer extract legacy code from types such as data fetchers but for now
// we need it to make an efficient copy that does not walk the types twice
@Internal
private GraphQLSchema(GraphQLSchema otherSchema, GraphQLCodeRegistry codeRegistry) {
this.queryType = otherSchema.queryType;
this.mutationType = otherSchema.mutationType;
this.subscriptionType = otherSchema.subscriptionType;
this.additionalTypes.addAll(otherSchema.additionalTypes);
this.directives.addAll(otherSchema.directives);
this.typeMap = otherSchema.typeMap;
this.byInterface = otherSchema.byInterface;
this.codeRegistry = codeRegistry;
}
public GraphQLCodeRegistry getCodeRegistry() {
return codeRegistry;
}
public Set getAdditionalTypes() {
return additionalTypes;
}
public GraphQLType getType(String typeName) {
return typeMap.get(typeName);
}
/**
* Called to return a named {@link graphql.schema.GraphQLObjectType} from the schema
*
* @param typeName the name of the type
*
* @return a graphql object type or null if there is one
*
* @throws graphql.GraphQLException if the type is NOT a object type
*/
public GraphQLObjectType getObjectType(String typeName) {
GraphQLType graphQLType = typeMap.get(typeName);
if (graphQLType != null) {
assertTrue(graphQLType instanceof GraphQLObjectType,
format("You have asked for named object type '%s' but its not an object type but rather a '%s'", typeName, graphQLType.getClass().getName()));
}
return (GraphQLObjectType) graphQLType;
}
public Map getTypeMap() {
return Collections.unmodifiableMap(typeMap);
}
public List getAllTypesAsList() {
return sortTypes(byNameAsc(), typeMap.values());
}
/**
* This will return the list of {@link graphql.schema.GraphQLObjectType} types that implement the given
* interface type.
*
* @param type interface type to obtain implementations of.
*
* @return list of types implementing provided interface
*/
public List getImplementations(GraphQLInterfaceType type) {
List implementations = byInterface.get(type.getName());
return (implementations == null)
? Collections.emptyList()
: Collections.unmodifiableList(sortTypes(byNameAsc(), implementations));
}
/**
* Returns true if a specified concrete type is a possible type of a provided abstract type.
* If the provided abstract type is:
* - an interface, it checks whether the concrete type is one of its implementations.
* - a union, it checks whether the concrete type is one of its possible types.
*
* @param abstractType abstract type either interface or union
* @param concreteType concrete type
*
* @return true if possible type, false otherwise.
*/
public boolean isPossibleType(GraphQLType abstractType, GraphQLObjectType concreteType) {
if (abstractType instanceof GraphQLInterfaceType) {
return getImplementations((GraphQLInterfaceType) abstractType).stream()
.map(GraphQLType::getName)
.anyMatch(name -> concreteType.getName().equals(name));
} else if (abstractType instanceof GraphQLUnionType) {
return ((GraphQLUnionType) abstractType).getTypes().stream()
.map(GraphQLType::getName)
.anyMatch(name -> concreteType.getName().equals(name));
}
return assertShouldNeverHappen("Unsupported abstract type %s. Abstract types supported are Union and Interface.", abstractType.getName());
}
public GraphQLObjectType getQueryType() {
return queryType;
}
public GraphQLObjectType getMutationType() {
return mutationType;
}
public GraphQLObjectType getSubscriptionType() {
return subscriptionType;
}
/**
* @return the field visibility
*
* @deprecated use {@link GraphQLCodeRegistry#getFieldVisibility()} instead
*/
@Deprecated
public GraphqlFieldVisibility getFieldVisibility() {
return codeRegistry.getFieldVisibility();
}
public List getDirectives() {
return new ArrayList<>(directives);
}
public GraphQLDirective getDirective(String name) {
for (GraphQLDirective directive : getDirectives()) {
if (directive.getName().equals(name)) {
return directive;
}
}
return null;
}
public boolean isSupportingMutations() {
return mutationType != null;
}
public boolean isSupportingSubscriptions() {
return subscriptionType != null;
}
/**
* This helps you transform the current GraphQLSchema object into another one by starting a builder with all
* the current values and allows you to transform it how you want.
*
* @param builderConsumer the consumer code that will be given a builder to transform
*
* @return a new GraphQLSchema object based on calling build on that builder
*/
public GraphQLSchema transform(Consumer builderConsumer) {
Builder builder = newSchema(this);
builderConsumer.accept(builder);
return builder.build();
}
/**
* @return a new schema builder
*/
public static Builder newSchema() {
return new Builder();
}
/**
* This allows you to build a schema from an existing schema. It copies everything from the existing
* schema and then allows you to replace them.
*
* @param existingSchema the existing schema
*
* @return a new schema builder
*/
public static Builder newSchema(GraphQLSchema existingSchema) {
return new Builder()
.query(existingSchema.getQueryType())
.mutation(existingSchema.getMutationType())
.subscription(existingSchema.getSubscriptionType())
.codeRegistry(existingSchema.getCodeRegistry())
.clearAdditionalTypes()
.clearDirectives()
.additionalDirectives(existingSchema.directives)
.additionalTypes(existingSchema.additionalTypes);
}
public static class Builder {
private GraphQLObjectType queryType;
private GraphQLObjectType mutationType;
private GraphQLObjectType subscriptionType;
private GraphQLCodeRegistry codeRegistry = GraphQLCodeRegistry.newCodeRegistry().build();
private Set additionalTypes = new LinkedHashSet<>();
// we default these in
private Set additionalDirectives = new LinkedHashSet<>(
asList(Directives.IncludeDirective, Directives.SkipDirective)
);
private SchemaUtil schemaUtil = new SchemaUtil();
public Builder query(GraphQLObjectType.Builder builder) {
return query(builder.build());
}
public Builder query(GraphQLObjectType queryType) {
this.queryType = queryType;
return this;
}
public Builder mutation(GraphQLObjectType.Builder builder) {
return mutation(builder.build());
}
public Builder mutation(GraphQLObjectType mutationType) {
this.mutationType = mutationType;
return this;
}
public Builder subscription(GraphQLObjectType.Builder builder) {
return subscription(builder.build());
}
public Builder subscription(GraphQLObjectType subscriptionType) {
this.subscriptionType = subscriptionType;
return this;
}
/**
* @param fieldVisibility the field visibility
*
* @return this builder
*
* @deprecated use {@link graphql.schema.GraphQLCodeRegistry.Builder#fieldVisibility(graphql.schema.visibility.GraphqlFieldVisibility)} instead
*/
@Deprecated
public Builder fieldVisibility(GraphqlFieldVisibility fieldVisibility) {
this.codeRegistry = this.codeRegistry.transform(builder -> builder.fieldVisibility(fieldVisibility));
return this;
}
public Builder codeRegistry(GraphQLCodeRegistry codeRegistry) {
this.codeRegistry = codeRegistry;
return this;
}
public Builder additionalTypes(Set additionalTypes) {
this.additionalTypes.addAll(additionalTypes);
return this;
}
public Builder additionalType(GraphQLType additionalType) {
this.additionalTypes.add(additionalType);
return this;
}
public Builder clearAdditionalTypes() {
this.additionalTypes.clear();
return this;
}
public Builder additionalDirectives(Set additionalDirectives) {
this.additionalDirectives.addAll(additionalDirectives);
return this;
}
public Builder additionalDirective(GraphQLDirective additionalDirective) {
this.additionalDirectives.add(additionalDirective);
return this;
}
public Builder clearDirectives() {
this.additionalDirectives.clear();
return this;
}
/**
* Builds the schema
*
* @param additionalTypes - please dont use this any more
*
* @return the built schema
*
* @deprecated - Use the {@link #additionalType(GraphQLType)} methods
*/
@Deprecated
public GraphQLSchema build(Set additionalTypes) {
return additionalTypes(additionalTypes).build();
}
/**
* Builds the schema
*
* @param additionalTypes - please don't use this any more
* @param additionalDirectives - please don't use this any more
*
* @return the built schema
*
* @deprecated - Use the {@link #additionalType(GraphQLType)} and {@link #additionalDirective(GraphQLDirective)} methods
*/
@Deprecated
public GraphQLSchema build(Set additionalTypes, Set additionalDirectives) {
return additionalTypes(additionalTypes).additionalDirectives(additionalDirectives).build();
}
/**
* Builds the schema
*
* @return the built schema
*/
public GraphQLSchema build() {
assertNotNull(additionalTypes, "additionalTypes can't be null");
assertNotNull(additionalDirectives, "additionalDirectives can't be null");
// grab the legacy code things from types
final GraphQLSchema tempSchema = new GraphQLSchema(queryType, mutationType, subscriptionType, additionalTypes, additionalDirectives, codeRegistry);
codeRegistry = codeRegistry.transform(codeRegistryBuilder -> schemaUtil.extractCodeFromTypes(codeRegistryBuilder, tempSchema));
GraphQLSchema graphQLSchema = new GraphQLSchema(tempSchema, codeRegistry);
schemaUtil.replaceTypeReferences(graphQLSchema);
Collection errors = new SchemaValidator().validateSchema(graphQLSchema);
if (errors.size() > 0) {
throw new InvalidSchemaException(errors);
}
return graphQLSchema;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy