TraitDataController.java

/*
 * Copyright 2024 Global Crop Diversity Trust
 *
 * 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.gringlobal.api.v2.impl;

import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v1.Pagination;
import org.gringlobal.api.v2.facade.TraitDataService;
import org.gringlobal.api.v2.model.TraitDataFilter;
import org.gringlobal.api.v2.model.TraitsPage;
import org.gringlobal.util.LoggerHelper;
import org.springdoc.api.annotations.ParameterObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;

@RestController("traitDataApi2")
@RequestMapping(TraitDataController.API_URL)
@PreAuthorize("isAuthenticated()")
@Tag(name = "TraitData")
@Slf4j
public class TraitDataController extends ApiBaseController {

	/** The Constant API_URL. */
	public static final String API_URL = ApiBaseController.APIv2_BASE + "/trait-data";

	@Autowired
	private TraitDataService traitDataService;

	@PostMapping(path = { "/data" })
	@Operation(operationId = "getTraitData", summary = "Get trait data in a wide format")
	public TraitsPage getTraitData(
			@Parameter(description = "Trait filters", required = true) @RequestBody TraitDataFilter filter, // data filters
			@ParameterObject final Pagination page // page
	) throws Exception {
		log.debug("Loading trait data with filter: {}", filter);

		if (log.isDebugEnabled()) {
			// SQL logging here.
			return LoggerHelper.withSqlLogging(() -> traitDataService.getTraitData(filter, page.toPageRequest(MAX_PAGE_SIZE, DEFAULT_PAGE_SIZE)));
		}
		return traitDataService.getTraitData(filter, page.toPageRequest(MAX_PAGE_SIZE, DEFAULT_PAGE_SIZE));
	}

}