DATACMNS-236, DATACMNS-117 - Added (Pageable|Sort)HanderMethodArgumentResolvers.

Added HandlerMethodArgumentResolver implementations for Pageable and Sort exposing a new default set of properties (page, size, sort) to resolve pagination and sorting information from the request. To mimic the legacy behavior we expose a (deprecated) LEGACY constant in PageableHandlerMethodArgumentResolver. Clients should move to the new properties structure ASAP. Added unit tests to verify old and new defaulting behavior.

Introduced new annotations @SortDefault (with @SortDefaults wrapper annotation) and @PageableDefault (superseding the legacy @PageableDefaults). The new annotations have more speaking attribute names and the HMAR implementations transparently alias the generic value attribute into a more semantic one (size).

The HMAR implementations implement Spring HATEOAS' UriComponentsContributor to be able to turn Pageable / Sort instances back into URIs created through the MethodLinkBuilderFactory API in Spring HATEOAS.

Extracted common API between legacy PageableArgumentResolver and PageableHandlerMethodArgumentResolver into common helper class.
Upgraded to Spring Hateoas 0.5.0.BUILD-SNAPSHOT.

Author: odrotbohm

pom.xml

@@ -19,7 +19,7 @@
     <properties>
     	<jackson>1.9.7</jackson>
     	<querydsl>2.8.0</querydsl>
-    	<springhateoas>0.4.0.RELEASE</springhateoas>
+    	<springhateoas>0.5.0.BUILD-SNAPSHOT</springhateoas>
     	<dist.key>DATACMNS</dist.key>
     </properties>
 

src/main/java/org/springframework/data/web/PageableArgumentResolver.java

@@ -15,11 +15,10 @@
  */
 package org.springframework.data.web;
 
+import static org.springframework.data.web.SpringDataAnnotationUtils.*;
+
 import java.beans.PropertyEditorSupport;
 import java.lang.annotation.Annotation;
-import java.lang.reflect.Method;
-import java.util.HashSet;
-import java.util.Set;
 
 import javax.servlet.ServletRequest;
 
@@ -131,7 +130,7 @@ private Pageable getDefaultFromAnnotationOrFallback(MethodParameter methodParame
 		return new PageRequest(fallbackPagable.getPageNumber(), fallbackPagable.getPageSize(), fallbackPagable.getSort());
 	}
 
-	private static Pageable getDefaultPageRequestFrom(PageableDefaults defaults) {
+	static Pageable getDefaultPageRequestFrom(PageableDefaults defaults) {
 
 		// +1 is because we substract 1 later
 		int defaultPageNumber = defaults.pageNumber() + 1;
@@ -162,94 +161,6 @@ private String getPrefix(MethodParameter parameter) {
 		return prefix;
 	}
 
-	/**
-	 * Asserts uniqueness of all {@link Pageable} parameters of the method of the given {@link MethodParameter}.
-	 * 
-	 * @param parameter
-	 */
-	private void assertPageableUniqueness(MethodParameter parameter) {
-
-		Method method = parameter.getMethod();
-
-		if (containsMoreThanOnePageableParameter(method)) {
-			Annotation[][] annotations = method.getParameterAnnotations();
-			assertQualifiersFor(method.getParameterTypes(), annotations);
-		}
-	}
-
-	/**
-	 * Returns whether the given {@link Method} has more than one {@link Pageable} parameter.
-	 * 
-	 * @param method
-	 * @return
-	 */
-	private boolean containsMoreThanOnePageableParameter(Method method) {
-
-		boolean pageableFound = false;
-
-		for (Class<?> type : method.getParameterTypes()) {
-
-			if (pageableFound && type.equals(Pageable.class)) {
-				return true;
-			}
-
-			if (type.equals(Pageable.class)) {
-				pageableFound = true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Asserts that every {@link Pageable} parameter of the given parameters carries an {@link Qualifier} annotation to
-	 * distinguish them from each other.
-	 * 
-	 * @param parameterTypes
-	 * @param annotations
-	 */
-	private void assertQualifiersFor(Class<?>[] parameterTypes, Annotation[][] annotations) {
-
-		Set<String> values = new HashSet<String>();
-
-		for (int i = 0; i < annotations.length; i++) {
-
-			if (Pageable.class.equals(parameterTypes[i])) {
-
-				Qualifier qualifier = findAnnotation(annotations[i]);
-
-				if (null == qualifier) {
-					throw new IllegalStateException(
-							"Ambiguous Pageable arguments in handler method. If you use multiple parameters of type Pageable you need to qualify them with @Qualifier");
-				}
-
-				if (values.contains(qualifier.value())) {
-					throw new IllegalStateException("Values of the user Qualifiers must be unique!");
-				}
-
-				values.add(qualifier.value());
-			}
-		}
-	}
-
-	/**
-	 * Returns a {@link Qualifier} annotation from the given array of {@link Annotation}s. Returns {@literal null} if the
-	 * array does not contain a {@link Qualifier} annotation.
-	 * 
-	 * @param annotations
-	 * @return
-	 */
-	private Qualifier findAnnotation(Annotation[] annotations) {
-
-		for (Annotation annotation : annotations) {
-			if (annotation instanceof Qualifier) {
-				return (Qualifier) annotation;
-			}
-		}
-
-		return null;
-	}
-
 	/**
 	 * {@link java.beans.PropertyEditor} to create {@link Sort} instances from textual representations. The implementation
 	 * interprets the string as a comma separated list where the first entry is the sort direction ( {@code asc},

src/main/java/org/springframework/data/web/PageableDefault.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2013 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.web;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.data.domain.Sort.Direction;
+import org.springframework.data.web.SortDefault.SortDefaults;
+
+/**
+ * Annotation to set defaults when injecting a {@link org.springframework.data.domain.Pageable} into a controller
+ * method. Instead of configuring {@link #sort()} and {@link #direction()} you can also use {@link SortDefault} or
+ * {@link SortDefaults}.
+ * 
+ * @since 1.6
+ * @author Oliver Gierke
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.PARAMETER)
+public @interface PageableDefault {
+
+	/**
+	 * Alias for {@link #size()}. Prefer to use the {@link #size()} method as it makes the annotation declaration more
+	 * expressive and you'll probably want to configure the {@link #page()} anyway.
+	 * 
+	 * @return
+	 */
+	int value() default 10;
+
+	/**
+	 * The default-size the injected {@link org.springframework.data.domain.Pageable} should get if no corresponding
+	 * parameter defined in request (default is 10).
+	 */
+	int size() default 10;
+
+	/**
+	 * The default-pagenumber the injected {@link org.springframework.data.domain.Pageable} should get if no corresponding
+	 * parameter defined in request (default is 0).
+	 */
+	int page() default 0;
+
+	/**
+	 * The properties to sort by by default. If unset, no sorting will be applied at all.
+	 * 
+	 * @return
+	 */
+	String[] sort() default {};
+
+	/**
+	 * The direction to sort by. Defaults to {@link Direction#ASC}.
+	 * 
+	 * @return
+	 */
+	Direction direction() default Direction.ASC;
+}

src/main/java/org/springframework/data/web/PageableDefaults.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.web;
 
+import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -26,10 +27,13 @@
  * Annotation to set defaults when injecting a {@link org.springframework.data.domain.Pageable} into a controller
  * method.
  * 
+ * @deprecated use {@link PageableDefault} instead.
  * @author Oliver Gierke
  */
+@Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.PARAMETER)
+@Deprecated
 public @interface PageableDefaults {
 
 	/**