AuditLogController.java

/*
 * Copyright 2021 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.v1.impl;

import com.querydsl.core.types.OrderSpecifier;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.genesys.blocks.auditlog.model.AuditLog;
import org.genesys.blocks.auditlog.model.QAuditLog;
import org.genesys.blocks.auditlog.model.filters.AuditLogFilter;
import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v1.FilteredCRUDController;
import org.gringlobal.service.AuditLogService;
import org.gringlobal.service.CRUDService;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.PathVariable;
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.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;

/**
 * The AuditLogController class.
 */
@RestController("auditLogApi1")
@RequestMapping(AuditLogController.API_URL)
@PreAuthorize("hasAuthority('GROUP_ADMINS')")
@Tag(name = "AuditLog")
public class AuditLogController extends FilteredCRUDController<AuditLog, AuditLogService, AuditLogFilter> {

	/** The Constant API_URL. */
	public static final String API_URL = ApiBaseController.APIv1_BASE + "/auditlog";

	@Override
	protected Class<AuditLogFilter> filterType() {
		return AuditLogFilter.class;
	}

	@Override
	protected OrderSpecifier<?>[] defaultSort() {
		return new OrderSpecifier[] { QAuditLog.auditLog.logDate.desc() };
	}

	/**
	 * Override this method due to unable to use {@link CRUDService#load(long)} in super.
	 *
	 * @param id the id
	 * @return found record
	 */
	@Override
	public AuditLog get(@PathVariable("id") final long id) {
		return crudService.get(id);
	}

	/**
	 * Override this method due to unable to use {@link CRUDService#load(long)} in super.
	 *
	 * @param id the id
	 * @return found record
	 */
	@Override
	public AuditLog remove(@PathVariable("id") final long id) {
		return crudService.remove(crudService.get(id));
	}

	/**
	 * Remove existing records by filter.
	 *
	 * @param filterCode the filterCode
	 * @param filter the filter
	 * @return OK if no errors
	 */
	@PostMapping(value = "/delete", produces = { MediaType.APPLICATION_JSON_VALUE })
	@Operation(operationId = "delete", description = "Delete existing records by filter", summary = "Delete by filter")
	public ResponseEntity<HttpStatus> remove(@RequestParam(name = "f", required = false) String filterCode, @RequestBody(required = false) AuditLogFilter filter) throws IOException {
		var filterInfo = shortFilterService.processFilter(filterCode, filter, filterType());
		crudService.removeAllByFilter(filterInfo.filter);
		return ResponseEntity.ok().build();
	}

}