graphql.schema.visibility

Class NoIntrospectionGraphqlFieldVisibility

java.lang.Object

graphql.schema.visibility.NoIntrospectionGraphqlFieldVisibility

All Implemented Interfaces:

GraphqlFieldVisibility

@PublicApi
public class NoIntrospectionGraphqlFieldVisibility
extends java.lang.Object
implements GraphqlFieldVisibility

This field visibility will prevent Introspection queries from being performed. Technically this puts your system in contravention of the specification - http://facebook.github.io/graphql/#sec-Introspection but some production systems want this lock down in place.

Field Summary

Fields

Modifier and Type	Field and Description
static NoIntrospectionGraphqlFieldVisibility	NO_INTROSPECTION_FIELD_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
NoIntrospectionGraphqlFieldVisibility()

Method Summary

Modifier and Type	Method and Description
GraphQLFieldDefinition	getFieldDefinition(GraphQLFieldsContainer fieldsContainer, java.lang.String fieldName) Called to get a named field from an object type or interface
java.util.List<GraphQLFieldDefinition>	getFieldDefinitions(GraphQLFieldsContainer fieldsContainer) Called to get the list of fields from an object type or interface

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.schema.visibility.GraphqlFieldVisibility

getFieldDefinition, getFieldDefinitions

Field Detail

NO_INTROSPECTION_FIELD_VISIBILITY

public static NoIntrospectionGraphqlFieldVisibility NO_INTROSPECTION_FIELD_VISIBILITY

Constructor Detail

NoIntrospectionGraphqlFieldVisibility

public NoIntrospectionGraphqlFieldVisibility()

Method Detail

getFieldDefinitions

public java.util.List<GraphQLFieldDefinition> getFieldDefinitions(GraphQLFieldsContainer fieldsContainer)

Description copied from interface: GraphqlFieldVisibility

Called to get the list of fields from an object type or interface

Specified by:

getFieldDefinitions in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

Returns:

a non null list of GraphQLFieldDefinitions

getFieldDefinition

public GraphQLFieldDefinition getFieldDefinition(GraphQLFieldsContainer fieldsContainer,
                                                 java.lang.String fieldName)

Description copied from interface: GraphqlFieldVisibility

Called to get a named field from an object type or interface

Specified by:

getFieldDefinition in interface GraphqlFieldVisibility

Parameters:

fieldsContainer - the type in play

fieldName - the name of the desired field

Returns:

a GraphQLFieldDefinition or null if it's not visible