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.MachineController Maven / Gradle / Ivy
package io.mosip.kernel.masterdata.controller;
import javax.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
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.MachinePutReqDto;
import io.mosip.kernel.masterdata.constant.MasterDataConstant;
import io.mosip.kernel.masterdata.dto.DeviceDto;
import io.mosip.kernel.masterdata.dto.MachineDto;
import io.mosip.kernel.masterdata.dto.MachinePostReqDto;
import io.mosip.kernel.masterdata.dto.MachineRegistrationCenterDto;
import io.mosip.kernel.masterdata.dto.PageDto;
import io.mosip.kernel.masterdata.dto.getresponse.MachineResponseDto;
import io.mosip.kernel.masterdata.dto.getresponse.extn.MachineExtnDto;
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.MachineSearchDto;
import io.mosip.kernel.masterdata.dto.response.PageResponseDto;
import io.mosip.kernel.masterdata.service.MachineService;
import io.mosip.kernel.masterdata.utils.AuditUtil;
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;
/**
*
* This class provide services to do CRUD operations on Machine.
*
* @author Megha Tanga
* @author Ritesh Sinha
* @author Sidhant Agarwal
* @author Ramadurai Pandian
* @since 1.0.0
*
*/
@RestController
@Api(tags = { "Machine" })
public class MachineController {
/**
* Reference to MachineService.
*/
@Autowired
private MachineService machineService;
@Autowired
private AuditUtil auditUtil;
/**
*
* Function to fetch machine detail based on given Machine ID and Language code.
*
* @param machineId pass Machine ID as String
* @param langCode pass language code as String
* @return MachineResponseDto machine detail based on given Machine ID and
* Language code {@link MachineResponseDto}
*/
@ResponseFilter
@GetMapping(value = "/machines/{id}/{langcode}")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN','REGISTRATION_CLIENT','REGISTRATION_PROCESSOR','RESIDENT')")
@ApiOperation(value = "Retrieve all Machine Details for given Languge Code", notes = "Retrieve all Machine Detail for given Languge Code and ID")
@ApiResponses({
@ApiResponse(code = 200, message = "When Machine Details retrieved from database for the given Languge Code and ID"),
@ApiResponse(code = 404, message = "When No Machine Details found for the given Languge Code and ID"),
@ApiResponse(code = 500, message = "While retrieving Machine Details any error occured") })
public ResponseWrapper getMachineIdLangcode(@PathVariable("id") String machineId,
@PathVariable("langcode") String langCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.getMachine(machineId, langCode));
return responseWrapper;
}
/**
*
* Function to fetch machine detail based on given Language code
*
* @param langCode pass language code as String
*
* @return MachineResponseDto machine detail based on given Language code
* {@link MachineResponseDto}
*/
@ResponseFilter
@GetMapping(value = "/machines/{langcode}")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN','REGISTRATION_CLIENT','REGISTRATION_PROCESSOR')")
@ApiOperation(value = "Retrieve all Machine Details for given Languge Code", notes = "Retrieve all Machine Detail for given Languge Code")
@ApiResponses({
@ApiResponse(code = 200, message = "When Machine Details retrieved from database for the given Languge Code"),
@ApiResponse(code = 404, message = "When No Machine Details found for the given Languge Code"),
@ApiResponse(code = 500, message = "While retrieving Machine Details any error occured") })
public ResponseWrapper getMachineLangcode(@PathVariable("langcode") String langCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.getMachine(langCode));
return responseWrapper;
}
/**
* Function to fetch a all machines details
*
* @return MachineResponseDto all machines details {@link MachineResponseDto}
*/
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN','REGISTRATION_CLIENT','REGISTRATION_PROCESSOR')")
@ResponseFilter
@GetMapping(value = "/machines")
@ApiOperation(value = "Retrieve all Machine Details", notes = "Retrieve all Machine Detail")
@ApiResponses({ @ApiResponse(code = 200, message = "When all Machine retrieved from database"),
@ApiResponse(code = 404, message = "When No Machine found"),
@ApiResponse(code = 500, message = "While retrieving Machine any error occured") })
public ResponseWrapper getMachineAll() {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.getMachineAll());
return responseWrapper;
}
/**
* Post API to deleted a row of Machine data
*
* @param id input from user Machine id
*
* @return ResponseEntity Machine Id which is deleted successfully
* {@link ResponseEntity}
*/
@ResponseFilter
@DeleteMapping("/machines/{id}")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to delete Machine ", notes = "Delete Machine and return Machine Id ")
@ApiResponses({ @ApiResponse(code = 200, message = "When Machine successfully deleted"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No Machine found"),
@ApiResponse(code = 500, message = "While deleting Machine any error occured") })
public ResponseWrapper deleteMachine(@Valid @PathVariable("id") String id) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.deleteMachine(id));
return responseWrapper;
}
/**
* Post API to update a row of Machine data
*
* @param machine input from user Machine DTO
*
* @return ResponseEntity Machine Id which is update successfully
* {@link ResponseEntity}
*//*
* @ResponseFilter
*
* @PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
*
* @PutMapping("/machines")
*
* @ApiOperation(value = "Service to update Machine", notes =
* "update Machine Detail and return Machine id")
*
* @ApiResponses({ @ApiResponse(code = 200, message =
* "When Machine successfully udated"),
*
* @ApiResponse(code = 400, message =
* "When Request body passed is null or invalid"),
*
* @ApiResponse(code = 404, message = "When No Machine found"),
*
* @ApiResponse(code = 500, message =
* "While updating Machine any error occured") }) public
* ResponseWrapper updateMachine(@Valid @RequestBody
* RequestWrapper machine) {
*
* ResponseWrapper responseWrapper = new ResponseWrapper<>();
* responseWrapper.setResponse(machineService.updateMachine(machine.getRequest()
* )); return responseWrapper; }
*/
/**
*
* Function to fetch machine detail those are mapped with given registration Id
*
* @param regCenterId pass registration Id as String
*
* @return MachineResponseDto all machines details those are mapped with given
* registration Id {@link MachineResponseDto}
*/
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN','REGISTRATION_PROCESSOR','REGISTRATION_CLIENT','REGISTRATION_SUPERVISOR','REGISTRATION_OFFICER')")
@ResponseFilter
@GetMapping(value = "/machines/mappedmachines/{regCenterId}")
@ApiOperation(value = "Retrieve all Machines which are mapped to given Registration Center Id", notes = "Retrieve all Machines which are mapped to given Registration Center Id")
@ApiResponses({
@ApiResponse(code = 200, message = "When Machine Details retrieved from database for the given Registration Center Id"),
@ApiResponse(code = 404, message = "When No Machine Details not mapped with the Given Registation Center ID"),
@ApiResponse(code = 500, message = "While retrieving Machine Detail any error occured") })
public ResponseWrapper> getMachinesByRegistrationCenter(
@PathVariable("regCenterId") String regCenterId,
@RequestParam(value = "pageNumber", defaultValue = "0") @ApiParam(value = "page number for the requested data", defaultValue = "0") int page,
@RequestParam(value = "pageSize", defaultValue = "1") @ApiParam(value = "page size for the request data", defaultValue = "1") int size,
@RequestParam(value = "orderBy", defaultValue = "cr_dtimes") @ApiParam(value = "sort the requested data based on param value", defaultValue = "createdDateTime") String orderBy,
@RequestParam(value = "direction", defaultValue = "DESC") @ApiParam(value = "order the requested data based on param", defaultValue = "DESC") String direction) {
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(
machineService.getMachinesByRegistrationCenter(regCenterId, page, size, orderBy, direction));
return responseWrapper;
}
/**
* Api to search Machine based on filters provided.
*
* @param request the request DTO.
* @return the pages of {@link MachineExtnDto}.
*/
@ResponseFilter
@PostMapping("/machines/search")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
public ResponseWrapper> searchMachine(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(MasterDataConstant.SEARCH_API_IS_CALLED + MachineSearchDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.SEARCH_API_IS_CALLED + MachineSearchDto.class.getCanonicalName());
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.searchMachine(request.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_SEARCH, MachineSearchDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_SEARCH_DESC, MachineSearchDto.class.getCanonicalName()));
return responseWrapper;
}
/**
* Api to filter Machine based on column and type provided.
*
* @param request the request DTO.
* @return the {@link FilterResponseDto}.
*/
@ResponseFilter
@PostMapping("/machines/filtervalues")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
public ResponseWrapper machineFilterValues(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(MasterDataConstant.FILTER_API_IS_CALLED + MachineDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.FILTER_API_IS_CALLED + MachineDto.class.getCanonicalName());
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.machineFilterValues(request.getRequest()));
auditUtil.auditRequest(String.format(MasterDataConstant.SUCCESSFUL_FILTER, MachineDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_SEARCH_DESC, MachineDto.class.getCanonicalName()));
return responseWrapper;
}
/**
* PUT API to decommission machines
*
* @param machineId input from user
* @return machineID of decommissioned machine
*/
@ResponseFilter
@ApiOperation(value = "Decommission Machine")
@PutMapping("/machines/decommission/{machineId}")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
public ResponseWrapper decommissionMachine(@PathVariable("machineId") String machineId) {
auditUtil.auditRequest(MasterDataConstant.DECOMMISION_API_CALLED + DeviceDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.DECOMMISION_API_CALLED + DeviceDto.class.getCanonicalName());
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.decommissionMachine(machineId));
auditUtil.auditRequest(MasterDataConstant.DECOMMISSION_SUCCESS + DeviceDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.DECOMMISSION_SUCCESS_DESC + DeviceDto.class.getCanonicalName());
return responseWrapper;
}
/**
* Post API to insert a new row of Machine data
*
* @param machineRequest input from user Machine DTO
*
* @return Responding with Machine which is inserted successfully
* {@link ResponseEntity}
*/
@ResponseFilter
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@PostMapping("/machines")
@ApiOperation(value = "Service to save Machine", notes = "Saves Machine Detail and return Machine id")
@ApiResponses({ @ApiResponse(code = 201, message = "When Machine successfully created"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No Machine found"),
@ApiResponse(code = 500, message = "While creating Machine any error occured") })
public ResponseWrapper createMachine(
@Valid @RequestBody RequestWrapper machineRequest) {
auditUtil.auditRequest(MasterDataConstant.CREATE_API_IS_CALLED + MachinePostReqDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.CREATE_API_IS_CALLED + MachinePostReqDto.class.getCanonicalName());
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.createMachine(machineRequest.getRequest()));
return responseWrapper;
}
/**
* This method updates Machine by Admin.
*
* @param machineCenterDto the request DTO for updating machine.
* @return the response i.e. the updated machine.
*/
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ResponseFilter
@PutMapping("/machines")
@ApiOperation(value = "Service to upadte Machine", notes = "Update Machine Detail and return updated Machine")
@ApiResponses({ @ApiResponse(code = 201, message = "When Machine successfully updated"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No Machine found"),
@ApiResponse(code = 500, message = "While updating Machine any error occured") })
public ResponseWrapper updateMachienAdmin(
@RequestBody @Valid RequestWrapper machineCenterDto) {
auditUtil.auditRequest(MasterDataConstant.UPDATE_API_IS_CALLED + MachinePutReqDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.UPDATE_API_IS_CALLED + MachinePutReqDto.class.getCanonicalName());
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(machineService.updateMachine(machineCenterDto.getRequest()));
return responseWrapper;
}
}
