Package graphql.introspection

Class Introspection

java.lang.Object

graphql.introspection.Introspection

@PublicApi
public class Introspection
extends java.lang.Object

GraphQl has a unique capability called Introspection that allow consumers to inspect the system and discover the fields and types available and makes the system self documented.

Some security recommendations such as OWASP recommend that introspection be disabled in production. The enabledJvmWide(boolean) method can be used to disable introspection for the whole JVM or you can place INTROSPECTION_DISABLED into the GraphQLContext of a request to disable introspection for that request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Introspection.DirectiveLocation
static class	Introspection.TypeKind

Field Summary

Fields

Modifier and Type	Field	Description
static GraphQLObjectType	__Directive
static GraphQLEnumType	__DirectiveLocation
static GraphQLObjectType	__EnumValue
static GraphQLObjectType	__Field
static GraphQLObjectType	__InputValue
static GraphQLObjectType	__Schema
static GraphQLObjectType	__Type
static GraphQLEnumType	__TypeKind
static java.lang.String	INTROSPECTION_DISABLED	Placing a boolean value under this key in the per request GraphQLContext will enable or disable Introspection on that request.
static java.util.Set<java.lang.String>	INTROSPECTION_SYSTEM_FIELDS
static GraphQLFieldDefinition	SchemaMetaFieldDef
static IntrospectionDataFetcher<?>	SchemaMetaFieldDefDataFetcher
static GraphQLFieldDefinition	TypeMetaFieldDef
static IntrospectionDataFetcher<?>	TypeMetaFieldDefDataFetcher
static GraphQLFieldDefinition	TypeNameMetaFieldDef
static IntrospectionDataFetcher<?>	TypeNameMetaFieldDefDataFetcher

Constructor Summary

Constructors

Constructor	Description
Introspection()

Method Summary

Modifier and Type	Method	Description
static void	addCodeForIntrospectionTypes(GraphQLCodeRegistry.Builder codeRegistry)
static GraphQLFieldDefinition	buildSchemaField(GraphQLObjectType introspectionSchemaType)
static GraphQLFieldDefinition	buildTypeField(GraphQLObjectType introspectionSchemaType)
static boolean	enabledJvmWide(boolean enabled)	This static method will enable / disable Introspection at a JVM wide level.
static GraphQLFieldDefinition	getFieldDef(GraphQLSchema schema, GraphQLCompositeType parentType, java.lang.String fieldName)	This will look up a field definition by name, and understand that fields like __typename and __schema are special and take precedence in field resolution.
static GraphQLFieldDefinition	getFieldDefinition(GraphQLSchema schema, GraphQLFieldsContainer parentType, java.lang.String fieldName)	This will look up a field definition by name, and understand that fields like __typename and __schema are special and take precedence in field resolution
static boolean	isEnabledJvmWide()
static java.util.Optional<ExecutionResult>	isIntrospectionSensible(MergedSelectionSet mergedSelectionSet, ExecutionContext executionContext)	This will look in to the field selection set and see if there are introspection fields, and if there is,it checks if introspection should run, and if not it will return an errored ExecutionResult that can be returned to the user.
static boolean	isIntrospectionTypes(GraphQLNamedType type)
static boolean	isIntrospectionTypes(java.lang.String typeName)

Methods inherited from class java.lang.Object

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

Field Detail

INTROSPECTION_DISABLED

public static final java.lang.String INTROSPECTION_DISABLED

Placing a boolean value under this key in the per request GraphQLContext will enable or disable Introspection on that request.

See Also:

Constant Field Values

__TypeKind

public static final GraphQLEnumType __TypeKind

__InputValue

public static final GraphQLObjectType __InputValue

__Field

public static final GraphQLObjectType __Field

__EnumValue

public static final GraphQLObjectType __EnumValue

__Type

public static final GraphQLObjectType __Type

__DirectiveLocation

public static final GraphQLEnumType __DirectiveLocation

__Directive

public static final GraphQLObjectType __Directive

__Schema

public static final GraphQLObjectType __Schema

SchemaMetaFieldDef

public static final GraphQLFieldDefinition SchemaMetaFieldDef

TypeMetaFieldDef

public static final GraphQLFieldDefinition TypeMetaFieldDef

TypeNameMetaFieldDef

public static final GraphQLFieldDefinition TypeNameMetaFieldDef

INTROSPECTION_SYSTEM_FIELDS

public static final java.util.Set<java.lang.String> INTROSPECTION_SYSTEM_FIELDS

SchemaMetaFieldDefDataFetcher

public static final IntrospectionDataFetcher<?> SchemaMetaFieldDefDataFetcher

TypeMetaFieldDefDataFetcher

public static final IntrospectionDataFetcher<?> TypeMetaFieldDefDataFetcher

TypeNameMetaFieldDefDataFetcher

public static final IntrospectionDataFetcher<?> TypeNameMetaFieldDefDataFetcher

Constructor Detail

Introspection

public Introspection()

Method Detail

enabledJvmWide

public static boolean enabledJvmWide(boolean enabled)

This static method will enable / disable Introspection at a JVM wide level.

Parameters:

enabled - the flag indicating the desired enabled state

Returns:

the previous state of enablement

isEnabledJvmWide

public static boolean isEnabledJvmWide()

Returns:

true if Introspection is enabled at a JVM wide level or false otherwise

isIntrospectionSensible

public static java.util.Optional<ExecutionResult> isIntrospectionSensible(MergedSelectionSet mergedSelectionSet,
                                                                          ExecutionContext executionContext)

This will look in to the field selection set and see if there are introspection fields, and if there is,it checks if introspection should run, and if not it will return an errored ExecutionResult that can be returned to the user.

Parameters:

mergedSelectionSet - the fields to be executed

executionContext - the execution context in play

Returns:

an optional error result

addCodeForIntrospectionTypes

public static void addCodeForIntrospectionTypes(GraphQLCodeRegistry.Builder codeRegistry)

buildSchemaField

public static GraphQLFieldDefinition buildSchemaField(GraphQLObjectType introspectionSchemaType)

buildTypeField

public static GraphQLFieldDefinition buildTypeField(GraphQLObjectType introspectionSchemaType)

isIntrospectionTypes

public static boolean isIntrospectionTypes(GraphQLNamedType type)

isIntrospectionTypes

public static boolean isIntrospectionTypes(java.lang.String typeName)

getFieldDef

public static GraphQLFieldDefinition getFieldDef(GraphQLSchema schema,
                                                 GraphQLCompositeType parentType,
                                                 java.lang.String fieldName)

This will look up a field definition by name, and understand that fields like __typename and __schema are special and take precedence in field resolution. If the parent type is a union type, then the only field allowed is `__typename`.

Parameters:

schema - the schema to use

parentType - the type of the parent object

fieldName - the field to look up

Returns:

a field definition otherwise throws an assertion exception if it's null

getFieldDefinition

public static GraphQLFieldDefinition getFieldDefinition(GraphQLSchema schema,
                                                        GraphQLFieldsContainer parentType,
                                                        java.lang.String fieldName)

This will look up a field definition by name, and understand that fields like __typename and __schema are special and take precedence in field resolution

Parameters:

schema - the schema to use

parentType - the type of the parent GraphQLFieldsContainer

fieldName - the field to look up

Returns:

a field definition otherwise throws an assertion exception if it's null