Class ResourceDocumentSource

java.lang.Object

org.springframework.graphql.support.ResourceDocumentSource

All Implemented Interfaces:

DocumentSource

public class ResourceDocumentSource
extends Object
implements DocumentSource

DocumentSource that searches for document Resources across multiple locations while trying different file extensions.

Since:

1.0.0

Author:

Rossen Stoyanchev, Marco Schäck

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	FILE_EXTENSIONS	The default file extensions, ".graphql" and ".gql".

Constructor Summary

Constructors

Constructor	Description
ResourceDocumentSource()	Default constructor that sets the location to "classpath:graphql/" and the extensions to ".graphql" and ".gql".
ResourceDocumentSource(List<Resource> locations, List<String> extensions)	Constructor with given locations and extensions.
ResourceDocumentSource(Resource location)	Constructor with a single location and the default file extensions.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<String>	getDocument(String name)	Return the document that matches the given name.
List<String>	getExtensions()	Return a read-only list with the file extensions to try when checking for documents by name.
List<Resource>	getLocations()	Return a read-only list with the configured locations where to check for documents.

Methods inherited from class java.lang.Object

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

Field Details

FILE_EXTENSIONS

public static final List<String> FILE_EXTENSIONS

The default file extensions, ".graphql" and ".gql".

Constructor Details

ResourceDocumentSource

public ResourceDocumentSource()

Default constructor that sets the location to "classpath:graphql/" and the extensions to ".graphql" and ".gql".

ResourceDocumentSource

public ResourceDocumentSource(Resource location)

Constructor with a single location and the default file extensions.

Parameters:

location - the resource location

Since:

2.0.0

ResourceDocumentSource

public ResourceDocumentSource(List<Resource> locations,
 List<String> extensions)

Constructor with given locations and extensions.

Parameters:

locations - the resource locations

extensions - the file extensions for document sources

Method Details

getLocations

public List<Resource> getLocations()

Return a read-only list with the configured locations where to check for documents.

getExtensions

public List<String> getExtensions()

Return a read-only list with the file extensions to try when checking for documents by name.

getDocument

public reactor.core.publisher.Mono<String> getDocument(String name)

Description copied from interface: DocumentSource

Return the document that matches the given name.

Specified by:

getDocument in interface DocumentSource

Parameters:

name - the name to use for the lookup

Returns:

Mono that completes either with the document content or with an error, but never empty.