graphql.introspection.Introspection Maven / Gradle / Ivy
package graphql.introspection;
import graphql.schema.*;
import java.util.ArrayList;
import java.util.List;
import static graphql.Scalars.GraphQLBoolean;
import static graphql.Scalars.GraphQLString;
import static graphql.schema.GraphQLArgument.newArgument;
import static graphql.schema.GraphQLFieldDefinition.newFieldDefinition;
import static graphql.schema.GraphQLObjectType.newObject;
public class Introspection {
public enum TypeKind {
SCALAR,
OBJECT,
INTERFACE,
UNION,
ENUM,
INPUT_OBJECT,
LIST,
NON_NULL
}
public static GraphQLEnumType __TypeKind = GraphQLEnumType.newEnum()
.name("__TypeKind")
.description("An enum describing what kind of type a given __Type is")
.value("SCALAR", TypeKind.SCALAR, "Indicates this type is a scalar.")
.value("OBJECT", TypeKind.OBJECT, "Indicates this type is an object. `fields` and `interfaces` are valid fields.")
.value("INTERFACE", TypeKind.INTERFACE, "Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.")
.value("UNION", TypeKind.UNION, "Indicates this type is a union. `possibleTypes` is a valid field.")
.value("ENUM", TypeKind.ENUM, "Indicates this type is an enum. `enumValues` is a valid field.")
.value("INPUT_OBJECT", TypeKind.INPUT_OBJECT, "Indicates this type is an input object. `inputFields` is a valid field.")
.value("LIST", TypeKind.LIST, "Indicates this type is a list. `ofType` is a valid field.")
.value("NON_NULL", TypeKind.NON_NULL, "Indicates this type is a non-null. `ofType` is a valid field.")
.build();
public static DataFetcher kindDataFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
if (type instanceof GraphQLScalarType) {
return TypeKind.SCALAR;
} else if (type instanceof GraphQLObjectType) {
return TypeKind.OBJECT;
} else if (type instanceof GraphQLInterfaceType) {
return TypeKind.INTERFACE;
} else if (type instanceof GraphQLUnionType) {
return TypeKind.UNION;
} else if (type instanceof GraphQLEnumType) {
return TypeKind.ENUM;
} else if (type instanceof GraphQLInputObjectType) {
return TypeKind.INPUT_OBJECT;
} else if (type instanceof GraphQLList) {
return TypeKind.LIST;
} else if (type instanceof GraphQLNonNull) {
return TypeKind.NON_NULL;
} else {
throw new RuntimeException("Unknown kind of type: " + type);
}
}
};
public static GraphQLObjectType __InputValue = newObject()
.name("__InputValue")
.field(newFieldDefinition()
.name("name")
.type(new GraphQLNonNull(GraphQLString))
.build())
.field(newFieldDefinition()
.name("description")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("type")
.type(new GraphQLNonNull(new GraphQLTypeReference("__Type")))
.build())
.field(newFieldDefinition()
.name("defaultValue")
.type(GraphQLString)
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
if (environment.getSource() instanceof GraphQLArgument) {
GraphQLArgument inputField = (GraphQLArgument) environment.getSource();
return inputField.getDefaultValue() != null ? inputField.getDefaultValue().toString() : null;
} else if (environment.getSource() instanceof GraphQLInputObjectField) {
GraphQLInputObjectField inputField = (GraphQLInputObjectField) environment.getSource();
return inputField.getDefaultValue() != null ? inputField.getDefaultValue().toString() : null;
}
return null;
}
})
.build())
.build();
public static GraphQLObjectType __Field = newObject()
.name("__Field")
.field(newFieldDefinition()
.name("name")
.type(new GraphQLNonNull(GraphQLString))
.build())
.field(newFieldDefinition()
.name("description")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("args")
.type(new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(__InputValue))))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
return ((GraphQLFieldDefinition) type).getArguments();
}
})
.build())
.field(newFieldDefinition()
.name("type")
.type(new GraphQLNonNull(new GraphQLTypeReference("__Type")))
.build())
.field(newFieldDefinition()
.name("isDeprecated")
.type(new GraphQLNonNull(GraphQLBoolean))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
return ((GraphQLFieldDefinition) type).isDeprecated();
}
})
.build())
.field(newFieldDefinition()
.name("deprecationReason")
.type(GraphQLString)
.build())
.build();
public static GraphQLObjectType __EnumValue = newObject()
.name("__EnumValue")
.field(newFieldDefinition()
.name("name")
.type(new GraphQLNonNull(GraphQLString))
.build())
.field(newFieldDefinition()
.name("description")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("isDeprecated")
.type(new GraphQLNonNull(GraphQLBoolean))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
GraphQLEnumValueDefinition enumValue = (GraphQLEnumValueDefinition) environment.getSource();
return enumValue.isDeprecated();
}
})
.build())
.field(newFieldDefinition()
.name("deprecationReason")
.type(GraphQLString)
.build())
.build();
public static DataFetcher fieldsFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
Boolean includeDeprecated = environment.getArgument("includeDeprecated");
if (type instanceof GraphQLFieldsContainer) {
GraphQLFieldsContainer fieldsContainer = (GraphQLFieldsContainer) type;
List fieldDefinitions = fieldsContainer.getFieldDefinitions();
if (includeDeprecated) return fieldDefinitions;
List filtered = new ArrayList(fieldDefinitions);
for (GraphQLFieldDefinition fieldDefinition : fieldDefinitions) {
if (fieldDefinition.isDeprecated()) filtered.remove(fieldDefinition);
}
return filtered;
}
return null;
}
};
public static DataFetcher interfacesFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
if (type instanceof GraphQLObjectType) {
return ((GraphQLObjectType) type).getInterfaces();
}
return null;
}
};
public static DataFetcher possibleTypesFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
if (type instanceof GraphQLInterfaceType) {
return new SchemaUtil().findImplementations(environment.getGraphQLSchema(), (GraphQLInterfaceType) type);
}
if (type instanceof GraphQLUnionType) {
return ((GraphQLUnionType) type).getTypes();
}
return null;
}
};
public static DataFetcher enumValuesTypesFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
Boolean includeDeprecated = environment.getArgument("includeDeprecated");
if (type instanceof GraphQLEnumType) {
List values = ((GraphQLEnumType) type).getValues();
if (includeDeprecated) return values;
List filtered = new ArrayList(values);
for (GraphQLEnumValueDefinition valueDefinition : values) {
if (valueDefinition.isDeprecated()) filtered.remove(valueDefinition);
}
return filtered;
}
return null;
}
};
public static DataFetcher inputFieldsFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
if (type instanceof GraphQLInputObjectType) {
return ((GraphQLInputObjectType) type).getFields();
}
return null;
}
};
public static DataFetcher OfTypeFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
Object type = environment.getSource();
if (type instanceof GraphQLList) {
return ((GraphQLList) type).getWrappedType();
}
if (type instanceof GraphQLNonNull) {
return ((GraphQLNonNull) type).getWrappedType();
}
return null;
}
};
public static GraphQLObjectType __Type = newObject()
.name("__Type")
.field(newFieldDefinition()
.name("kind")
.type(new GraphQLNonNull(__TypeKind))
.dataFetcher(kindDataFetcher)
.build())
.field(newFieldDefinition()
.name("name")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("description")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("fields")
.type(new GraphQLList(new GraphQLNonNull(__Field)))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.defaultValue(false)
.build())
.dataFetcher(fieldsFetcher)
.build())
.field(newFieldDefinition()
.name("interfaces")
.type(new GraphQLList(new GraphQLNonNull(new GraphQLTypeReference("__Type"))))
.dataFetcher(interfacesFetcher)
.build())
.field(newFieldDefinition()
.name("possibleTypes")
.type(new GraphQLList(new GraphQLNonNull(new GraphQLTypeReference("__Type"))))
.dataFetcher(possibleTypesFetcher)
.build())
.field(newFieldDefinition()
.name("enumValues")
.type(new GraphQLList(new GraphQLNonNull(__EnumValue)))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.defaultValue(false)
.build())
.dataFetcher(enumValuesTypesFetcher)
.build())
.field(newFieldDefinition()
.name("inputFields")
.type(new GraphQLList(new GraphQLNonNull(__InputValue)))
.dataFetcher(inputFieldsFetcher)
.build())
.field(newFieldDefinition()
.name("ofType")
.type(new GraphQLTypeReference("__Type"))
.dataFetcher(OfTypeFetcher)
.build())
.build();
public enum DirectiveLocation {
QUERY,
MUTATION,
FIELD,
FRAGMENT_DEFINITION,
FRAGMENT_SPREAD,
INLINE_FRAGMENT
}
public static GraphQLEnumType __DirectiveLocation = GraphQLEnumType.newEnum()
.name("__DirectiveLocation")
.description("An enum describing valid locations where a directive can be placed")
.value("QUERY", DirectiveLocation.QUERY, "Indicates the directive is valid on queries.")
.value("MUTATION", DirectiveLocation.MUTATION, "Indicates the directive is valid on mutations.")
.value("FIELD", DirectiveLocation.FIELD, "Indicates the directive is valid on fields.")
.value("FRAGMENT_DEFINITION", DirectiveLocation.FRAGMENT_DEFINITION, "Indicates the directive is valid on fragment definitions.")
.value("FRAGMENT_SPREAD", DirectiveLocation.FRAGMENT_SPREAD, "Indicates the directive is valid on fragment spreads.")
.value("INLINE_FRAGMENT", DirectiveLocation.INLINE_FRAGMENT, "Indicates the directive is valid on inline fragments.")
.build();
public static GraphQLObjectType __Directive = newObject()
.name("__Directive")
.field(newFieldDefinition()
.name("name")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("description")
.type(GraphQLString)
.build())
.field(newFieldDefinition()
.name("locations")
.type(new GraphQLList(new GraphQLNonNull(__DirectiveLocation)))
.build())
.field(newFieldDefinition()
.name("args")
.type(new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(__InputValue))))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
GraphQLDirective directive = (GraphQLDirective) environment.getSource();
return directive.getArguments();
}
})
.build())
.field(newFieldDefinition()
.name("onOperation")
.type(GraphQLBoolean)
.deprecate("Use `locations`.")
.build())
.field(newFieldDefinition()
.name("onFragment")
.type(GraphQLBoolean)
.deprecate("Use `locations`.")
.build())
.field(newFieldDefinition()
.name("onField")
.type(GraphQLBoolean)
.deprecate("Use `locations`.")
.build())
.build();
public static GraphQLObjectType __Schema = newObject()
.name("__Schema")
.description("A GraphQL Introspection defines the capabilities" +
" of a GraphQL server. It exposes all available types and directives on " +
"the server, the entry points for query, mutation, and subscription operations.")
.field(newFieldDefinition()
.name("types")
.description("A list of all types supported by this server.")
.type(new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(__Type))))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
GraphQLSchema schema = (GraphQLSchema) environment.getSource();
return schema.getAllTypesAsList();
}
})
.build())
.field(newFieldDefinition()
.name("queryType")
.description("The type that query operations will be rooted at.")
.type(new GraphQLNonNull(__Type))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
GraphQLSchema schema = (GraphQLSchema) environment.getSource();
return schema.getQueryType();
}
})
.build())
.field(newFieldDefinition()
.name("mutationType")
.description("If this server supports mutation, the type that mutation operations will be rooted at.")
.type(__Type)
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
GraphQLSchema schema = (GraphQLSchema) environment.getSource();
return schema.getMutationType();
}
})
.build())
.field(newFieldDefinition()
.name("directives")
.description("'A list of all directives supported by this server.")
.type(new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(__Directive))))
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
return environment.getGraphQLSchema().getDirectives();
}
})
.build())
.field(newFieldDefinition()
.name("subscriptionType")
.description("'If this server support subscription, the type that subscription operations will be rooted at.")
.type(__Type)
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
// Not yet supported
return null;
}
})
.build())
.build();
public static GraphQLFieldDefinition SchemaMetaFieldDef = newFieldDefinition()
.name("__schema")
.type(new GraphQLNonNull(__Schema))
.description("Access the current type schema of this server.")
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
return environment.getGraphQLSchema();
}
})
.build();
public static GraphQLFieldDefinition TypeMetaFieldDef = newFieldDefinition()
.name("__type")
.type(__Type)
.description("Request the type information of a single type.")
.argument(newArgument()
.name("name")
.type(new GraphQLNonNull(GraphQLString))
.build())
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
String name = environment.getArgument("name");
return environment.getGraphQLSchema().getType(name);
}
})
.build();
public static GraphQLFieldDefinition TypeNameMetaFieldDef = newFieldDefinition()
.name("__typename")
.type(new GraphQLNonNull(GraphQLString))
.description("The name of the current Object type at runtime.")
.dataFetcher(new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
return environment.getParentType().getName();
}
})
.build();
static {
// make sure all TypeReferences are resolved
GraphQLSchema.newSchema()
.query(GraphQLObjectType.newObject()
.name("dummySchema")
.field(SchemaMetaFieldDef)
.field(TypeMetaFieldDef)
.field(TypeNameMetaFieldDef)
.build())
.build();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy