beadledom-pagination

Provides pagination query parameters and hypermedia links for paginated endpoints.

The following components are included:

OffsetPaginationModule

a Guice module that provides configurable pagination parameters and binds the OffsetPaginatedListLinksWriterInterceptor

Download

Download using Maven:

<dependencies>
    ...
    <dependency>
        <groupId>com.cerner.beadledom</groupId>
        <artifactId>beadledom-pagination</artifactId>
        <version>[Insert latest version]</version>
    </dependency>
    ...
</dependencies>

Usage

Getting started

To add pagination to your service install the OffsetPaginationModule in your own Guice module. To override configuration for the module, provide a binding for OffsetPaginationConfiguration. Then update your paginated resource to accept OffsetPaginationParameters and return an OffsetPaginatedList.

Guice Module:

public class ExampleModule extends AbstractModule {
  @Override
  protected void configure() {
    install(new ResteasyModule());

    // optionally, provide binding for configuration you want to override
    OffsetPaginationConfiguration paginationConfig = OffsetPaginationConfiguration.builder()
            .setMaxLimit(200)
            .build();
    OptionalBinder
            .newOptionalBinder(
                binder(),
                OffsetPaginationConfiguration.class)
            .setBinding().toInstance(paginationConfig);
    install(new OffsetPaginationModule());

    bind(ExampleResource.class);
  }
}

Example resource:

@Path("/example")
public interface ExampleResource {
  @GET
  @Produces("application/json")
  OffsetPaginatedList<ExampleDto> index(@BeanParam OffsetPaginationParameters paginationParams);
}

Configurable query parameters

By default the query parameters for pagination are offset and limit. When not provided by the caller offset defaults to 0 and limit defaults to 20. The default maximum value for limit is 100. The names, default values, and max limit are configurable. See OffsetPaginationConfiguration for details.