Add configurable default page size and max allowed page size

Additionally make these configurable vars consistent and usable across
BrAPIController and PagingUtility, which both utilize them.

Author: jloux-brapi

src/main/java/org/brapi/test/BrAPITestServer/controller/core/BrAPIController.java

@@ -11,7 +11,7 @@
 import io.swagger.model.core.BatchDeletesListResponseResult;
 import org.brapi.test.BrAPITestServer.auth.AuthDetails;
 import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
-import org.brapi.test.BrAPITestServer.exceptions.InvalidPagingException;
+import org.brapi.test.BrAPITestServer.service.PagingUtility;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
@@ -33,29 +33,14 @@
 
 public class BrAPIController {
 	private static final Logger log = LoggerFactory.getLogger(ServerInfoApiController.class);
-	
-	protected Metadata generateMetaDataTemplateForSearch(Integer originalRequestedPage, Integer newRequestedPage,
-			Integer originalRequestedPageSize, Integer newRequestedPageSize) throws BrAPIServerException {
-		Integer page = newRequestedPage;
-		Integer pageSize = newRequestedPageSize;
-
-		if (page == null) {
-			page = originalRequestedPage;
-		}
-		if (pageSize == null) {
-			pageSize = originalRequestedPageSize;
-		}
-
-		return generateMetaDataTemplate(page, pageSize);
-	}
 
 	protected Metadata generateMetaDataTemplate(SearchRequest request) throws BrAPIServerException {
 		return generateMetaDataTemplate(request.getPage(), request.getPageSize());
 	}
 
 	protected Metadata generateMetaDataTemplate(String pageToken, Integer pageSize) {
 		if (pageSize == null) {
-			pageSize = 1000;
+			pageSize = PagingUtility.getDefaultPageSize();
 		}
 
 		Metadata metaData = generateEmptyMetadataToken();
@@ -65,14 +50,14 @@ protected Metadata generateMetaDataTemplate(String pageToken, Integer pageSize)
 	}
 
 	protected Metadata generateMetaDataTemplate(Integer page, Integer pageSize) throws BrAPIServerException {
-		validatePaging(page, pageSize);
+		PagingUtility.validatePaging(page, pageSize);
 
 		// defaults
 		if (page == null) {
 			page = 0;
 		}
 		if (pageSize == null) {
-			pageSize = 1000;
+			pageSize = PagingUtility.getDefaultPageSize();
 		}
 
 		Metadata metaData = generateEmptyMetadata();
@@ -81,16 +66,6 @@ protected Metadata generateMetaDataTemplate(Integer page, Integer pageSize) thro
 		return metaData;
 	}
 
-	private void validatePaging(Integer page, Integer pageSize) throws BrAPIServerException {
-		boolean pageValid = (page == null) || (page >= 0);
-		if (!pageValid)
-			throw new InvalidPagingException("page");
-		boolean pageSizeValid = (pageSize == null) || (pageSize >= 1);
-		if (!pageSizeValid)
-			throw new InvalidPagingException("pageSize");
-
-	}
-
 	protected Metadata generateEmptyMetadata() {
 		Metadata metaData = new Metadata();
 		metaData.setDatafiles(new ArrayList<>());

src/main/java/org/brapi/test/BrAPITestServer/service/PagingUtility.java

@@ -3,21 +3,59 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
+import org.brapi.test.BrAPITestServer.exceptions.InvalidPagingException;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 
 import io.swagger.model.IndexPagination;
 import io.swagger.model.Metadata;
+import org.springframework.stereotype.Component;
 
+import javax.annotation.PostConstruct;
+
+@Component
 public class PagingUtility {
+	@Value("${paging.page-size.default:1000}")
+	private int defaultPageSize;
+	@Value("${paging.page-size.max-allowed:65000}")
+	private int maxAllowablePageSize;
+
+	private static int defaultPageSizeStatic;
+	private static int maxAllowablePageSizeStatic;
+
+	@PostConstruct
+	private void init() {
+		// Java made me do this - JL
+		defaultPageSizeStatic = defaultPageSize;
+		maxAllowablePageSizeStatic = maxAllowablePageSize;
+	}
+
 	public static void calculateMetaData(Metadata metaData) {
 		int totalCount = metaData.getPagination().getTotalCount();
 		int pageSize = metaData.getPagination().getPageSize();
 		metaData.getPagination().setTotalPages((totalCount / pageSize) + Integer.signum( totalCount % pageSize));
 	}
 
+	public static void validatePaging(Integer page, Integer pageSize) throws BrAPIServerException {
+		boolean pageValid = (page == null) || (page >= 0);
+		if (!pageValid)
+			throw new InvalidPagingException("page");
+		boolean pageSizeValid = (pageSize == null) || (pageSize >= 1);
+		if (!pageSizeValid)
+			throw new InvalidPagingException("pageSize");
+		if (pageSize != null && pageSize > maxAllowablePageSizeStatic) {
+			throw new InvalidPagingException("pageSize [Over maximum allowable page size of [" + maxAllowablePageSizeStatic + "]] ");
+		}
+	}
+
+	public static int getDefaultPageSize() {
+		return defaultPageSizeStatic;
+	}
+
 	public static Pageable getPageRequest(Metadata metaData) {
 		if (metaData == null) {
 			metaData = new Metadata();
@@ -34,7 +72,7 @@ public static Pageable getPageRequest(Metadata metaData, Sort sort) {
 			page = metaData.getPagination().getCurrentPage();
 		}
 
-		int pageSize = 1000;
+		int pageSize = defaultPageSizeStatic;
 		if (metaData.getPagination().getPageSize() != null && metaData.getPagination().getPageSize() > 0) {
 			pageSize = metaData.getPagination().getPageSize();
 		}

src/main/resources/application.properties.template

@@ -19,3 +19,13 @@ spring.mvc.dispatch-options-request=true
 
 security.oidc_discovery_url=https://example.com/auth/.well-known/openid-configuration
 security.enabled=true
+security.issuer_url=http://example.com/issuerurl
+
+# This should either be set in accordance with a maximum number of SQL parameters (on JOIN FETCHES of collections,
+# if there is more than one collection the IDs of each entity need to be passed through as parameters, and there is a SQL
+# maximum of 65535.  See GermplasmService.findGermplasmEntities()),
+# whatever returns in a reasonable amount of time,
+# or if you want to limit for the sake of server efficiency.
+paging.page-size.max-allowed=65000
+
+paging.page-size.default=1000