True if the plugin is configured to add the Relay connection capabilities to the field marked by the @RelayConnection directive.

If so, the plugin reads the provided GraphQL schema file(s), and enriches them with the interfaces and types needed to respect the Relay Connection specification. The entry point for that is the @RelayConnection directive.

You'll find all the information on the plugin web site. Please check the server Relay capability page.

Flag to enable copy sources for graphql-java-runtime library to target source code directory. It allows to control whether the runtime code is embedded in the generated code or not.

The default behavior is the old one, that is: the runtime code is embedded. This means that when you upgrade the plugin version, just build the project and everything is coherent.

If you set this parameter to false, the runtime is no more copied with the generated code. You then have to add the runtime dependency in the pom dependencies: it's the com.graphql-java-generator:graphql-java-runtime dependency, with the exact same version as the plugin version.

This also allows you to create your own runtime, and change the "standard" behavior. But of course, you'll have to check the compatibility with all the next versions.

This parameter contains the list of custom scalars implementations. One such implementation must be provided for each custom scalar defined in the GraphQL implemented by the project for its GraphQL schema. It's a list, where the key is the scalar name, as defined in the GraphQL schema, and the value is the full class name of the implementation of GraphQLScalarType.

This parameter is a list of customScalars. For each one, you must define the name, the javaType and exactly one of these fields: graphQLScalarTypeClass, graphQLScalarTypeStaticField or graphQLScalarTypeGetter.

Here is the detail:

• graphQLTypeName: The type name, as defined in the GraphQL schema, for instance Date
• javaType: The full class name for the java type that contains the data for this type, once in the Java code, for instance java.util.Date
• graphQLScalarTypeClass: The full class name for the GraphQLScalarType that will manage this Custom Scalar. This class must be a subtype of GraphQLScalarType. Bu the constructor of GraphQLScalarType has been deprecated, so you'll find no sample for that in this project
• graphQLScalarTypeStaticField: The full class name followed by the static field name that contains the GraphQLScalarType that will manage this Custom Scalar. For instance, the graphql-java package provides several custom scalars like graphql.Scalars.GraphQLLong. You can also use the graphql-java-extended-scalars project, that provides other custom scalars like graphql.scalars.ExtendedScalars.NonNegativeInt.
• graphQLScalarTypeGetter: The full class name followed by the static method name that returns the GraphQLScalarType that will manage this Custom Scalar. For instance: org.mycompany.MyScalars.getGraphQLLong() or com.graphql_java_generator.customscalars.GraphQLScalarTypeDate. This call may contain parameters, provided that this a valid java command.

Please have a look at the allGraphQLCases (both client and server) samples for more information. The allGraphQLCases client pom is a good sample.

(only for server mode) Indicates if the plugin should generate add the BatchLoaderEnvironment parameter to the batchLoader methods, in DataFetchersDelegate. This parameter allows to get the context of the Batch Loader, including the context associated to the id, when using the id has been added by the DataLoader.load() method.

For instance, if you have the method below, for a field named oneWithIdSubType in a DataFetcherDelegate:

@Override
public CompletableFuture<AllFieldCasesWithIdSubtype> oneWithIdSubType(
                DataFetchingEnvironment dataFetchingEnvironment, DataLoader<UUID, AllFieldCasesWithIdSubtype> dataLoader,
                AllFieldCases source, Boolean uppercase) {
        return dataLoader.load(UUID.randomUUID());
}

then, in the AllFieldCasesWithIdSubtype DataFetcherDelegate, you can retrieve the uppercase this way:

@Override
public List<AllFieldCasesWithIdSubtype> batchLoader(List<UUID> keys, BatchLoaderEnvironment environment) {
        List<AllFieldCasesWithIdSubtype> list = new ArrayList<>(keys.size());
        for (UUID id : keys) {
                // Let's manage the uppercase parameter, that was associated with this key
                Boolean uppercase = (Boolean) environment.getKeyContexts().get(id);
                if (uppercase != null && uppercase) {
                        item.setName(item.getName().toUpperCase());
                }

                // Do something with the id and the uppercase value
        }
        return list;
}

For more complex cases, you can store a Map with all the needed values, instead of just the parameter value.

Default value is false

(only for server mode) Defines how the methods in the data fetchers delegates are generated. The detailed information is available in the Wiki server page

When generateDataLoaderForLists is false (default mode), the data loaders are used only for fields that don't return a list. In other words, for fields which type is a sub-object with an id, two methods are generated: one which returns a CompletableFuture, and one which returns a none CompletableFuture result (that is used by the generated code only if no data loader is available).

When generateDataLoaderForLists is true, the above behavior is extended to fields that are a list.

Note: if set to true, this plugin parameter make the use of data loader mandatory for every field which type is a list of GraphQL objects, which have an id. This may not be suitable, for instance when your data is stored in a relational database, where you would need a first query to retrieve the ids and push them into the data loader, then another one to retrieve the associated values. If you want to use data loader for only some of particular fields, you should consider using the generateDataLoaderForLists. You'll find more information on the Wiki server page.

This parameter is available since version 1.18.4

Since 1.7.1 version

Generates a XxxxResponse class for each query/mutation/subscription, and (if separateUtilityClasses is true) Xxxx classes in the util subpackage. This allows to keep compatibility with code Developed with the 1.x versions of the plugin.

The best way to use the plugin is to directly use the Xxxx query/mutation/subscription classes, where Xxxx is the query/mutation/subscription name defined in the GraphQL schema.

(only for server mode) Indicates whether the plugin should generate the JPA annotations, for generated objects.

Default value is false

The Jackson annotations are necessary to properly deserialize the json, that is incoming from the GraphQL Server. Setting this property to false allows to not generate them.

If this property is set to true, the Jackson annotations are added in the generated GraphQL objects. The Jackson dependencies must then be added to the target project, so that the project compiles.

The default value is:

• true when in client mode.
• false when in server mode.

The javaTypeForIDType is the java class that is used in the generated code for GraphQL fields that are of the GraphQL ID type. The default value is java.util.UUID. Valid values are: java.lang.String, java.lang.Long and java.util.UUID.

This parameter is only valid for the server mode. When generating the client code, the ID is always generated as a String type, as recommended in the GraphQL doc.

In other words: when in server mode and javaTypeForIDType is not set, all GraphQL ID fields are UUID attributes in java. When in server mode and javaTypeForIDType is set to the X type, all GraphQL ID fields are X attributes in java.

Note: you can override this, by using the schema personalization capability. For more information, please have a look at the Schema Personalization doc page.

(only for server mode) A comma separated list of package names, without double quotes, that will also be parsed by Spring, to discover Spring beans, Spring repositories and JPA entities when the server starts. You should use this parameter only for packages that are not subpackage of the package defined in the _packageName_ parameter and not subpackage of com.graphql_java_generator

This allows for instance, to set packageName to your.app.package.graphql, and to define your Spring beans, like the DataFetcherDelegates or your Spring data repositories in any other folder, by setting for instance scanBasePackages to your.app.package.impl, your.app.package.graphql, or just your.app.package

The pattern to find the graphql schema file(s). The default value is "/*.graphqls" meaning that the maven plugin will search all graphqls files in the "/src/main/resources" folder (please check also the schemaFileFolder plugin parameter).

You can put the star (*) joker in the filename, to retrieve several files at ones, for instance /myschema*.graphqls will retrieve the /src/main/resources/myschema.graphqls and /src/main/resources/myschema_extend.graphqls files.

schemaPersonalizationFile is the file name where the GraphQL maven plugin will find personalization that it must apply before generating the code. This applies to the server mode only. See the doc on the plugin web site for more details.

The standard file would be something like /src/main/graphql/schemaPersonalizationFile.json, which avoids to embed this compile time file within your maven artifact (as it is not in the /src/main/java nor in the /src/main/resources folders).

Indicates whether the utility classes (that is: the classes that are not match an item in the GraphQL schema) are generated in the same package than the classes that matches the GraphQL schema.

That is: internal technical classes, java classes that contain the method to execute the queries/mutations/subscriptions, Jackson deserializer for custom scalars...

The default value is false, to maintain the previous behavior. In this case, all classes are generated in the packageName, or the default package if this parameter is not defined.

If true, the GraphQL classes are generated in the package defined in the packageName plugin parameter. And all the utility classes are generated in the util subpackage of this package.

This parameter is now deprecated: it's value used in the plugin is always true, that is: if the generated sources or resources are older than the GraphQL schema file(s), then there is no source or resource generation. In clear, the source and resource generation is executed only if the provided input (GraphQL schema...) has been updated since the last plugin execution.

Map of the code templates to be used: this allows to override the default templates, and control exactly what code is generated by the plugin.

You can override any of the Velocity templates of the project. The list of templates is defined in the enum CodeTemplate, that you can check here.

You can find a sample in the CustomTemplates client sample.

Important notice: Please note that the default templates may change in the future. And some of these modifications would need to be reported into the custom templates. We'll try to better expose a stable public API in the future.