Spring Boot

The configuration for Elide Spring Boot is implemented using auto-configuration classes which reads configuration properties that can be configured using Spring Boot’s externalized configuration feature.

The configuration properties do not expose all the settings that can be customized. Some require overriding of the beans being generated by the auto-configuration classes or by defining customizer beans that can make specific changes to the auto-configured defaults. Where more than one customizer is defined they will be applied following the @Order annotation.

Elide

Elide uses ElideSettings for configuring various aspect of how Elide runs. This is auto-configured in ElideAutoConfiguration.

This can be customized by defining a ElideSettingsBuilderCustomizer.

@Configuration
public class ElideConfiguration {
    @Bean
    ElideSettingsBuilderCustomizer elideSettingsBuilderCustomizer() {
        return builder -> builder.auditLogger(new MyCustomAuditLogger());
    }
}

Custom Serializers and Deserializers

By default serdes for the following are added to the auto-configured SerdesBuilder.

This can be customized by defining a SerdesBuilderCustomizer. If the defaults are not required the existing serdes can be cleared.

@Configuration
public class ElideConfiguration {
    @Bean
    SerdesBuilderCustomizer serdesBuilderCustomizer() {
        return builder -> builder.clear().entry(Address.class, new AddressSerde());
    }
}

This can also be customized by defining a ElideSettingsBuilderCustomizer.

@Configuration
public class ElideConfiguration {
    @Bean
    ElideSettingsBuilderCustomizer elideSettingsBuilderCustomizer() {
        return builder -> builder.serdes(serdes -> serdes.entry(Address.class, new AddressSerde()));
    }
}

JSON API

Elide uses JsonApiSettings for configuring JSON-API. This is auto-configured in ElideAutoConfiguration.

This can be customized by defining a JsonApiSettingsBuilderCustomizer. The following configures the use of JSON-API links in results.

@Configuration
public class ElideConfiguration {
    @Bean
    JsonApiSettingsBuilderCustomizer jsonApiSettingsBuilderCustomizer() {
        return builder -> builder.links(links -> links.enabled(true).jsonApiLinks(new MyCustomJsonApiLinks()));
    }
}

The following configures the filter dialect. Note that by default a RSQLFilterDialect using a CaseSensitivityStrategy of UseColumnCollation and addDefaultArguments of true are already defined as a joinFilterDialect and subqueryFilterDialect so when defining another RSQLFilterDialect this default filter dialect would need to be removed.

@Configuration
public class ElideConfiguration {
    @Bean
    JsonApiSettingsBuilderCustomizer jsonApiSettingsBuilderCustomizer(EntityDictionary entityDictionary) {
        return builder -> builder.joinFilterDialects(joinFilterDialects -> {
            joinFilterDialects.clear();
            joinFilterDialects.add(RSQLFilterDialect.builder()
                    .dictionary(entityDictionary)
                    .caseSensitivityStrategy(new CaseSensitivityStrategy.FIQLCompliant())
                    .addDefaultArguments(true)
                    .build());
        }).subqueryFilterDialects(subqueryFilterDialects -> {
            subqueryFilterDialects.clear();
            subqueryFilterDialects.add(RSQLFilterDialect.builder()
                    .dictionary(entityDictionary)
                    .caseSensitivityStrategy(new CaseSensitivityStrategy.FIQLCompliant())
                    .addDefaultArguments(true)
                    .build());
        });
    }
}

Controller

Elide auto-configures a JsonApiController in ElideAutoConfiguration. This can be overridden by defining a bean with the name jsonApiController. The custom controller does not need to extend JsonApiController.

@Configuration
public class ElideConfiguration {
    @Bean
    MyCustomJsonApiController jsonApiController() {
        return new MyCustomJsonApiController();
    }
}

GraphQL

Elide uses GraphQLSettings for configuring GraphQL. This is auto-configured in ElideAutoConfiguration.

This can be customized by defining a GraphQLSettingsBuilderCustomizer. The following configures the use of Federation.

@Configuration
public class ElideConfiguration {
    @Bean
    GraphQLSettingsBuilderCustomizer graphqlSettingsBuilderCustomizer() {
        return builder -> builder.federation(federation -> federation.enabled(true));
    }
}

Controller

Elide auto-configures a GraphQLController in ElideAutoConfiguration. This can be overridden by defining a bean with the name graphqlController. The custom controller does not need to extend GraphQLController.

@Configuration
public class ElideConfiguration {
    @Bean
    MyCustomGraphQLController graphqlController() {
        return new MyCustomGraphQLController();
    }
}

Async

Elide uses AsyncSettings for configuring Async. This is auto-configured in ElideAutoConfiguration.

This can be customized by defining a AsyncSettingsBuilderCustomizer. The following configures export.

@Configuration
public class ElideConfiguration {
    @Bean
    AsyncSettingsBuilderCustomizer asyncSettingsBuilderCustomizer() {
        return builder -> builder.export(export -> export.enabled(true).path("/export"));
    }
}

API Docs

Controller

Elide auto-configures a ApiDocsController in ElideAutoConfiguration. This can be overridden by defining a bean with the name graphqlController. The custom controller does not need to extend ApiDocsController.

@Configuration
public class ElideConfiguration {
    @Bean
    MyApiDocsController apiDocsController() {
        return new MyCustomApiDocsController();
    }
}

Core Properties

API Versioning Strategy Properties

JSON-API Properties

GraphQL Properties

API Docs Properties

Async Properties

Aggregation Store Properties

JPA Store Properties

Converting Durations

The properties indicating a duration are specified using java.time.Duration. For instance a configuration value of 7d indicates 7 days and 300s indicates 300 seconds.

The following are the supported units

• ns for nanoseconds
• us for microseconds
• ms for milliseconds
• s for seconds
• m for minutes
• h for hours
• d for days

Standalone

Settings

The configuration for the Elide Standalone is implemented using interfaces.