org.apache.sling.graphql.core.schema

Class DefaultSchemaProvider

java.lang.Object

org.apache.sling.graphql.core.schema.DefaultSchemaProvider

All Implemented Interfaces:

SchemaProvider

public class DefaultSchemaProvider
extends Object
implements SchemaProvider

Provides a Resource-specific GraphQL Schema, as text

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SCHEMA
static String	SCHEMA_EXTENSION
static int	SERVICE_RANKING

Constructor Summary

Constructors

Constructor and Description
DefaultSchemaProvider()

Method Summary

Modifier and Type	Method and Description
String	getSchema(org.apache.sling.api.resource.Resource r, String[] selectors) Get a GraphQL Schema definition for the given resource and optional selectors

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_RANKING

public static final int SERVICE_RANKING

See Also:

Constant Field Values

SCHEMA_EXTENSION

public static final String SCHEMA_EXTENSION

See Also:

Constant Field Values

DEFAULT_SCHEMA

public static final String DEFAULT_SCHEMA

See Also:

Constant Field Values

Constructor Detail

DefaultSchemaProvider

public DefaultSchemaProvider()

Method Detail

getSchema

public String getSchema(org.apache.sling.api.resource.Resource r,
                        String[] selectors)
                 throws IOException

Description copied from interface: SchemaProvider

Get a GraphQL Schema definition for the given resource and optional selectors

Specified by:

getSchema in interface SchemaProvider

Parameters:

r - The Resource to which the schema applies

selectors - Optional set of Request Selectors that can influence the schema selection

Returns:

a GraphQL schema that can be annotated to define the data fetchers to use, see this module's documentation. Can return null if a schema cannot be provided, in which case a different provider should be used.

Throws:

IOException - if the schema cannot be retrieved