com.contentgrid.spring.boot.autoconfigure.data.pagination.WebPaginationAutoConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of contentgrid-spring-boot-autoconfigure Show documentation
Module with Spring Boot AutoConfiguration for ContentGrid applications
The newest version!
package com.contentgrid.spring.boot.autoconfigure.data.pagination;

import com.contentgrid.spring.data.pagination.cursor.ContentGridSpringDataPaginationCursorConfiguration;
import com.contentgrid.spring.data.pagination.cursor.CursorCodec;
import com.contentgrid.spring.data.pagination.cursor.RequestIntegrityCheckCursorCodec;
import com.contentgrid.spring.data.pagination.cursor.SimplePageBasedCursorCodec;
import com.contentgrid.spring.data.pagination.web.ContentGridSpringDataPaginationWebConfiguration;
import com.contentgrid.spring.data.pagination.web.ItemCountPageMetadata;
import com.contentgrid.spring.data.pagination.web.ItemCountPageMetadataOmitLegacyPropertiesMixin;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
import org.springframework.data.rest.webmvc.ContentGridRestProperties;
import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer;
import org.springframework.data.web.PagedResourcesAssembler;
import org.springframework.data.web.config.PageableHandlerMethodArgumentResolverCustomizer;


@AutoConfiguration
@Import(
        {
                ContentGridSpringDataPaginationWebConfiguration.class,
                ContentGridSpringDataPaginationCursorConfiguration.class
        }
)
@ConditionalOnClass({
        ContentGridSpringDataPaginationWebConfiguration.class,
        PagedResourcesAssembler.class
})
@ConditionalOnWebApplication
public class WebPaginationAutoConfiguration {

    @Bean
    Jackson2ObjectMapperBuilderCustomizer contentGridSpringDataPaginationOmitLegacyPropertiesObjectMapperBuilderCustomizer(
            ContentGridRestProperties restProperties
    ) {
        return jacksonObjectMapperBuilder -> {
            if (!restProperties.isExposeLegacyPageInfo()) {
                jacksonObjectMapperBuilder.mixIn(ItemCountPageMetadata.class,
                        ItemCountPageMetadataOmitLegacyPropertiesMixin.class);
            }
        };
    }

    @Configuration(proxyBeanMethods = false)
    @ConditionalOnClass({RepositoryRestConfiguration.class})
    static class WebmvcPaginationConfiguration {

        @Bean
        @Order(Ordered.HIGHEST_PRECEDENCE)
            // This needs to run first, so it can be overridden
        PageableHandlerMethodArgumentResolverCustomizer contentGridPageableHandlerMethodArgumentResolverParametersCustomizer(
                RepositoryRestConfiguration repositoryRestConfiguration
        ) {
            return pageableResolver -> {
                pageableResolver.setPageParameterName(repositoryRestConfiguration.getPageParamName());
                pageableResolver.setSizeParameterName(repositoryRestConfiguration.getLimitParamName());
                pageableResolver.setFallbackPageable(
                        PageRequest.ofSize(repositoryRestConfiguration.getDefaultPageSize()));
                pageableResolver.setMaxPageSize(repositoryRestConfiguration.getMaxPageSize());
            };
        }
    }

    @Configuration(proxyBeanMethods = false)
    @ConditionalOnMissingBean(CursorCodec.class)
    static class CursorCodecConfiguration {

        @Bean
        CursorCodec contentGridCursorCodec(
                ContentGridRestProperties restProperties
        ) {
            return switch (restProperties.getPagination()) {
                case PAGE_NUMBER -> new SimplePageBasedCursorCodec();
                case PAGE_CURSOR -> new RequestIntegrityCheckCursorCodec(new SimplePageBasedCursorCodec());
            };
        }

        @Bean
        @Order(Ordered.HIGHEST_PRECEDENCE)
        RepositoryRestConfigurer contentGridCursorBasedPaginationDefaultsRepositoryRestConfigurer(
                ContentGridRestProperties restProperties
        ) {
            // For cursor-based pagination, switch the default page parameter to _cursor
            // Note that the SpringBootRepositoryRestConfigurer (which configures the repository from properties)
            // has a lower priority, so it runs _after_ this configurer.
            // This means that the default provided here can be overridden with the property spring.data.rest.page-param-name
            return RepositoryRestConfigurer.withConfig(config -> {
                if (restProperties.getPagination().isCursorBased()) {
                    config.setPageParamName("_cursor");
                }
            });
        }

    }
}