package org.springframework.data.web;
import static org.springframework.hateoas.TemplateVariable.VariableType.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.core.MethodParameter;
import org.springframework.data.domain.Pageable;
import org.springframework.hateoas.TemplateVariable;
import org.springframework.hateoas.TemplateVariable.VariableType;
import org.springframework.hateoas.TemplateVariables;
import org.springframework.hateoas.server.mvc.UriComponentsContributor;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.MultiValueMap;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;
@SuppressWarnings("null")
public class HateoasPageableHandlerMethodArgumentResolver extends PageableHandlerMethodArgumentResolver
implements UriComponentsContributor {
private static final HateoasSortHandlerMethodArgumentResolver DEFAULT_SORT_RESOLVER = new HateoasSortHandlerMethodArgumentResolver();
private final HateoasSortHandlerMethodArgumentResolver sortResolver;
public HateoasPageableHandlerMethodArgumentResolver() {
this(null);
}
public HateoasPageableHandlerMethodArgumentResolver(@Nullable HateoasSortHandlerMethodArgumentResolver sortResolver) {
super(getDefaultedSortResolver(sortResolver));
this.sortResolver = getDefaultedSortResolver(sortResolver);
}
public TemplateVariables getPaginationTemplateVariables(MethodParameter parameter, UriComponents template) {
String pagePropertyName = getParameterNameToUse(getPageParameterName(), parameter);
String sizePropertyName = getParameterNameToUse(getSizeParameterName(), parameter);
List<TemplateVariable> names = new ArrayList<>();
MultiValueMap<String, String> queryParameters = template.getQueryParams();
boolean append = !queryParameters.isEmpty();
for (String propertyName : Arrays.asList(pagePropertyName, sizePropertyName)) {
if (!queryParameters.containsKey(propertyName)) {
VariableType type = append ? REQUEST_PARAM_CONTINUED : REQUEST_PARAM;
String description = String.format("pagination.%s.description", propertyName);
names.add(new TemplateVariable(propertyName, type, description));
}
}
TemplateVariables pagingVariables = new TemplateVariables(names);
return pagingVariables.concat(sortResolver.getSortTemplateVariables(parameter, template));
}
@Override
public void enhance(UriComponentsBuilder builder, @Nullable MethodParameter parameter, Object value) {
Assert.notNull(builder, "UriComponentsBuilder must not be null!");
if (!(value instanceof Pageable)) {
return;
}
Pageable pageable = (Pageable) value;
if (pageable.isUnpaged()) {
return;
}
String pagePropertyName = getParameterNameToUse(getPageParameterName(), parameter);
String sizePropertyName = getParameterNameToUse(getSizeParameterName(), parameter);
int pageNumber = pageable.getPageNumber();
builder.replaceQueryParam(pagePropertyName, isOneIndexedParameters() ? pageNumber + 1 : pageNumber);
builder.replaceQueryParam(sizePropertyName,
pageable.getPageSize() <= getMaxPageSize() ? pageable.getPageSize() : getMaxPageSize());
this.sortResolver.enhance(builder, parameter, pageable.getSort());
}
private static HateoasSortHandlerMethodArgumentResolver getDefaultedSortResolver(
@Nullable HateoasSortHandlerMethodArgumentResolver sortResolver) {
return sortResolver == null ? DEFAULT_SORT_RESOLVER : sortResolver;
}
}