Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.mosip.kernel.masterdata.controller.DeviceSpecificationController Maven / Gradle / Ivy
package io.mosip.kernel.masterdata.controller;
import java.util.List;
import javax.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import io.mosip.kernel.core.http.RequestWrapper;
import io.mosip.kernel.core.http.ResponseFilter;
import io.mosip.kernel.core.http.ResponseWrapper;
import io.mosip.kernel.masterdata.constant.MasterDataConstant;
import io.mosip.kernel.masterdata.constant.OrderEnum;
import io.mosip.kernel.masterdata.dto.DeviceSpecificationDto;
import io.mosip.kernel.masterdata.dto.getresponse.DeviceSpecificationResponseDto;
import io.mosip.kernel.masterdata.dto.getresponse.PageDto;
import io.mosip.kernel.masterdata.dto.getresponse.extn.DeviceSpecificationExtnDto;
import io.mosip.kernel.masterdata.dto.postresponse.IdResponseDto;
import io.mosip.kernel.masterdata.dto.request.FilterValueDto;
import io.mosip.kernel.masterdata.dto.request.SearchDto;
import io.mosip.kernel.masterdata.dto.response.FilterResponseCodeDto;
import io.mosip.kernel.masterdata.dto.response.FilterResponseDto;
import io.mosip.kernel.masterdata.dto.response.PageResponseDto;
import io.mosip.kernel.masterdata.entity.id.IdAndLanguageCodeID;
import io.mosip.kernel.masterdata.service.DeviceSpecificationService;
import io.mosip.kernel.masterdata.utils.AuditUtil;
import io.mosip.kernel.masterdata.validator.DeviceSpecificationValidator;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
/**
*
* Device specification controller with api to save and get list of Device
* specification.
*
* @author Uday Kumar
* @author Megha Tanga
*
* @since 1.0.0
*
*/
@RestController
@Api(tags = { "DeviceSpecification" })
public class DeviceSpecificationController {
@Autowired
AuditUtil auditUtil;
/**
* Reference to DeviceSpecificationService.
*/
@Autowired
DeviceSpecificationService deviceSpecificationService;
@Autowired
DeviceSpecificationValidator deviceSpecificationValidator;
/**
* Function to fetch list of device specification details based on language code
*
* @param langCode pass language code as String
*
* @return DeviceSpecificationResponseDto all device Specification details based
* on given language code
*
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER','GLOBAL_ADMIN','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/devicespecifications/{langcode}")
@ApiOperation(value = "Retrieve all Device Specification for given Languge Code", notes = "Retrieve all DeviceSpecification for the given Languge Code")
@ApiResponses({
@ApiResponse(code = 200, message = "When Device Specification retrieved from database for the given Languge Code "),
@ApiResponse(code = 404, message = "When No Device Specificationfound for the given Languge Code and ID"),
@ApiResponse(code = 500, message = "While retrieving Device Specifications any error occured") })
public ResponseWrapper getDeviceSpecificationByLanguageCode(
@PathVariable("langcode") String langCode) {
List deviceSpecificationDtos = deviceSpecificationService
.findDeviceSpecificationByLangugeCode(langCode);
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(new DeviceSpecificationResponseDto(deviceSpecificationDtos));
return responseWrapper;
}
/**
* Function to fetch list of device specification details based on language code
* and device Type Code
*
* @param langCode pass language code as String
* @param deviceTypeCode pass deviceTypeCode as String
* @return {@link DeviceSpecificationResponseDto}
*
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER','GLOBAL_ADMIN')")
@ResponseFilter
@GetMapping("/devicespecifications/{langcode}/{devicetypecode}")
@ApiOperation(value = "Retrieve all Device Specification for specific langCode and DeviceTypeCode", notes = "Retrieve all DeviceSpecification for specific langCode and DeviceTypeCode")
@ApiResponses({
@ApiResponse(code = 200, message = "When Device Specification retrieved from database for specific langCode and DeviceTypeCode "),
@ApiResponse(code = 404, message = "When No Device Specificationfound for specific langCode and DeviceTypeCode"),
@ApiResponse(code = 500, message = "While retrieving Device Specifications any error occured") })
public ResponseWrapper getDeviceSpecificationByLanguageCodeAndDeviceTypeCode(
@PathVariable("langcode") String langCode, @PathVariable("devicetypecode") String deviceTypeCode) {
List deviceSpecificationDtos = deviceSpecificationService
.findDeviceSpecByLangCodeAndDevTypeCode(langCode, deviceTypeCode);
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(new DeviceSpecificationResponseDto(deviceSpecificationDtos));
return responseWrapper;
}
/**
* Post API to insert a new row of DeviceSpecification data
*
* @param deviceSpecification input parameter deviceRequestDto
*
* @return {@link IdResponseDto}
*/
@ResponseFilter
@PostMapping("/devicespecifications")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to save Device Specification", notes = "Saves Device Specification and return Device Specification ID")
@ApiResponses({ @ApiResponse(code = 201, message = "When Device Specification successfully created"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 500, message = "While creating Device Specification any error occured") })
public ResponseWrapper createDeviceSpecification(
@Valid @RequestBody RequestWrapper deviceSpecification) {
deviceSpecificationValidator.validate(deviceSpecification.getRequest());
auditUtil.auditRequest(
MasterDataConstant.CREATE_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.CREATE_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(), "ADM-638");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper
.setResponse(deviceSpecificationService.createDeviceSpecification(deviceSpecification.getRequest()));
return responseWrapper;
}
@ResponseFilter
@PutMapping("/devicespecifications")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to update device specification", notes = "update Device Specification and return Device Specification ID")
@ApiResponses({ @ApiResponse(code = 200, message = "When device specification successfully updated"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No device specification found"),
@ApiResponse(code = 500, message = "While updating device specification any error occured") })
public ResponseWrapper updateDeviceSpecification(
@Valid @RequestBody RequestWrapper deviceSpecification) {
deviceSpecificationValidator.validate(deviceSpecification.getRequest());
auditUtil.auditRequest(
MasterDataConstant.UPDATE_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.UPDATE_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(), "ADM-640");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper
.setResponse(deviceSpecificationService.updateDeviceSpecification(deviceSpecification.getRequest()));
return responseWrapper;
}
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ResponseFilter
@DeleteMapping("/devicespecifications/{id}")
@ApiOperation(value = "Service to delete device specifications", notes = "Delete device specifications and return device specification id")
@ApiResponses({ @ApiResponse(code = 200, message = "When device specifications successfully deleted"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No device specifications found"),
@ApiResponse(code = 500, message = "While deleting device specifications error occured") })
public ResponseWrapper deleteDeviceSpecification(@PathVariable("id") String id) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(deviceSpecificationService.deleteDeviceSpecification(id));
return responseWrapper;
}
/**
* This controller method provides with all device specifications.
*
* @param pageNumber the page number
* @param pageSize the size of each page
* @param sortBy the attributes by which it should be ordered
* @param orderBy the order to be used
* @return the response i.e. pages containing the device specifications.
*/
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ResponseFilter
@GetMapping("/devicespecifications/all")
@ApiOperation(value = "Retrieve all the device specifications with additional metadata", notes = "Retrieve all the device specifications with additional metadata")
@ApiResponses({ @ApiResponse(code = 200, message = "list of device specifications"),
@ApiResponse(code = 500, message = "Error occured while retrieving device specifications") })
public ResponseWrapper> getAllDeviceSpecifications(
@RequestParam(name = "pageNumber", defaultValue = "0") @ApiParam(value = "page no for the requested data", defaultValue = "0") int pageNumber,
@RequestParam(name = "pageSize", defaultValue = "10") @ApiParam(value = "page size for the requested data", defaultValue = "10") int pageSize,
@RequestParam(name = "sortBy", defaultValue = "createdDateTime") @ApiParam(value = "sort the requested data based on param value", defaultValue = "createdDateTime") String sortBy,
@RequestParam(name = "orderBy", defaultValue = "desc") @ApiParam(value = "order the requested data based on param", defaultValue = "desc") OrderEnum orderBy) {
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(
deviceSpecificationService.getAllDeviceSpecifications(pageNumber, pageSize, sortBy, orderBy.name()));
return responseWrapper;
}
@ResponseFilter
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@PostMapping("/devicespecifications/search")
public ResponseWrapper> deviceSpecificationSearch(
@RequestBody @Valid RequestWrapper requestWrapper) {
auditUtil.auditRequest(
MasterDataConstant.SEARCH_API_IS_CALLED + DeviceSpecificationExtnDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.SEARCH_API_IS_CALLED + DeviceSpecificationExtnDto.class.getCanonicalName(),
"ADM-642");
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(deviceSpecificationService.searchDeviceSpec(requestWrapper.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_SEARCH,
DeviceSpecificationExtnDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM, String.format(MasterDataConstant.SUCCESSFUL_SEARCH_DESC,
DeviceSpecificationExtnDto.class.getCanonicalName()),
"ADM-643");
return responseWrapper;
}
/**
* API that returns the values required for the column filter columns.
*
* @param request the request DTO {@link FilterResponseDto} wrapper in
* {@link RequestWrapper}.
* @return the response i.e. the list of values for the specific filter column
* name and type.
*/
@ResponseFilter
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@PostMapping("/devicespecifications/filtervalues")
public ResponseWrapper deviceSpecificationFilterValues(
@RequestBody @Valid RequestWrapper requestWrapper) {
auditUtil.auditRequest(
MasterDataConstant.FILTER_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.FILTER_API_IS_CALLED + DeviceSpecificationDto.class.getCanonicalName(), "ADM-645");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(deviceSpecificationService.deviceSpecFilterValues(requestWrapper.getRequest()));
auditUtil.auditRequest(MasterDataConstant.SUCCESSFUL_FILTER + DeviceSpecificationDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.SUCCESSFUL_FILTER_DESC + DeviceSpecificationDto.class.getCanonicalName(), "ADM-646");
return responseWrapper;
}
}
