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.TemplateController Maven / Gradle / Ivy
package io.mosip.kernel.masterdata.controller;
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.RequestMapping;
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.TemplateDto;
import io.mosip.kernel.masterdata.dto.getresponse.PageDto;
import io.mosip.kernel.masterdata.dto.getresponse.TemplateResponseDto;
import io.mosip.kernel.masterdata.dto.getresponse.extn.TemplateExtnDto;
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.FilterResponseDto;
import io.mosip.kernel.masterdata.dto.response.PageResponseDto;
import io.mosip.kernel.masterdata.entity.id.IdAndLanguageCodeID;
import io.mosip.kernel.masterdata.service.TemplateService;
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;
/**
* Controller APIs to get Template details
*
* @author Neha
* @author Uday kumar
* @author Srinivasan
* @since 1.0.0
*
*/
@RestController
@Api(tags = { "Template" })
@RequestMapping("/templates")
public class TemplateController {
@Autowired
private TemplateService templateService;
@Autowired
private AuditUtil auditUtil;
/**
* Method to fetch all Template details
*
* @return All {@link TemplateDto}
*/
@PreAuthorize("hasAnyRole('INDIVIDUAL','REGISTRATION_PROCESSOR','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','REGISTRATION_OFFICER','ID_AUTHENTICATION','AUTH','ZONAL_ADMIN','GLOBAL_ADMIN','PRE_REGISTRATION_ADMIN','RESIDENT','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping
public ResponseWrapper getAllTemplate() {
auditUtil.auditRequest(String.format(MasterDataConstant.GET_ALL, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_ALL, TemplateDto.class.getSimpleName()));
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.getAllTemplate());
auditUtil.auditRequest(String.format(MasterDataConstant.GET_ALL_SUCCESS, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_ALL_SUCCESS_DESC, TemplateDto.class.getSimpleName()));
return responseWrapper;
}
/**
* Method to fetch all Template details based on language code
*
* @param langCode the language code
* @return All {@link TemplateDto}
*/
@PreAuthorize("hasAnyRole('INDIVIDUAL','REGISTRATION_PROCESSOR','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','REGISTRATION_OFFICER','ID_AUTHENTICATION','AUTH','ZONAL_ADMIN','GLOBAL_ADMIN','PRE_REGISTRATION_ADMIN','RESIDENT','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/{langcode}")
public ResponseWrapper getAllTemplateBylangCode(@PathVariable("langcode") String langCode) {
auditUtil.auditRequest(String.format(MasterDataConstant.GET_LANG, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_LANG, TemplateDto.class.getSimpleName()));
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.getAllTemplateByLanguageCode(langCode));
auditUtil.auditRequest(String.format(MasterDataConstant.GET_LANG_SUCCESS, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_LANG_SUCCESS_DESC, TemplateDto.class.getSimpleName()));
return responseWrapper;
}
/**
* Method to fetch all Template details based on language code and template type
* code
*
* @param langCode the language code
* @param templateTypeCode the template type code
* @return All {@link TemplateDto}
*/
@PreAuthorize("hasAnyRole('INDIVIDUAL','REGISTRATION_PROCESSOR','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','REGISTRATION_OFFICER','ID_AUTHENTICATION','AUTH','ZONAL_ADMIN','GLOBAL_ADMIN','PRE_REGISTRATION_ADMIN','RESIDENT','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/{langcode}/{templatetypecode}")
public ResponseWrapper getAllTemplateBylangCodeAndTemplateTypeCode(
@PathVariable("langcode") String langCode, @PathVariable("templatetypecode") String templateTypeCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(
templateService.getAllTemplateByLanguageCodeAndTemplateTypeCode(langCode, templateTypeCode));
return responseWrapper;
}
/**
* This method creates template based on provided details.
*
* @param template the template detail
* @return {@link IdResponseDto}
*/
@ResponseFilter
@PostMapping
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to create template ", notes = "create Template and return code")
@ApiResponses({ @ApiResponse(code = 201, message = " successfully created"),
@ApiResponse(code = 400, message = " Request body passed is null or invalid"),
@ApiResponse(code = 500, message = " creating any error occured") })
public ResponseWrapper createTemplate(
@Valid @RequestBody RequestWrapper template) {
auditUtil.auditRequest(MasterDataConstant.CREATE_API_IS_CALLED + TemplateDto.class.getSimpleName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.CREATE_API_IS_CALLED + TemplateDto.class.getSimpleName(), "ADM-806");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.createTemplate(template.getRequest()));
return responseWrapper;
}
/**
* This method update template based on provided details.
*
* @param template the template detail
* @return {@link IdResponseDto}
*/
@ResponseFilter
@PutMapping
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to update template ", notes = "update Template and return code ")
@ApiResponses({ @ApiResponse(code = 200, message = " successfully updated"),
@ApiResponse(code = 400, message = " Request body passed is null or invalid"),
@ApiResponse(code = 500, message = " creating any error occured") })
public ResponseWrapper updateTemplate(
@Valid @RequestBody RequestWrapper template) {
auditUtil.auditRequest(MasterDataConstant.UPDATE_API_IS_CALLED + TemplateDto.class.getSimpleName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.UPDATE_API_IS_CALLED + TemplateDto.class.getSimpleName(), "ADM-807");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.updateTemplates(template.getRequest()));
return responseWrapper;
}
/**
* This method delete template based on provided details.
*
* @param id the template id
* @return {@link IdResponseDto}
*/
@ResponseFilter
@DeleteMapping("/{id}")
@PreAuthorize("hasAnyRole('GLOBAL_ADMIN','ZONAL_ADMIN')")
@ApiOperation(value = "Service to delete template", notes = "Delete template and return template id")
@ApiResponses({ @ApiResponse(code = 200, message = "When template successfully deleted"),
@ApiResponse(code = 400, message = "When Request body passed is null or invalid"),
@ApiResponse(code = 404, message = "When No template found"),
@ApiResponse(code = 500, message = "While deleting template error occured") })
public ResponseWrapper deleteTemplate(@PathVariable("id") String id) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.deleteTemplates(id));
return responseWrapper;
}
/**
* Method to fetch all Template details based on template type code
*
* @param templateTypeCode the template type code
* @return All {@link TemplateDto}
*/
@GetMapping("/templatetypecodes/{code}")
@ResponseFilter
@PreAuthorize("hasAnyRole('INDIVIDUAL','REGISTRATION_PROCESSOR','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','REGISTRATION_OFFICER','ID_AUTHENTICATION','AUTH','ZONAL_ADMIN','GLOBAL_ADMIN','PRE_REGISTRATION_ADMIN','RESIDENT','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
public ResponseWrapper getAllTemplateByTemplateTypeCode(
@PathVariable("code") String templateTypeCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.getAllTemplateByTemplateTypeCode(templateTypeCode));
return responseWrapper;
}
/**
* This controller method provides with all templates.
*
* @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 templates.
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ResponseFilter
@GetMapping("/all")
@ApiOperation(value = "Retrieve all the templates with additional metadata", notes = "Retrieve all the templates with the additional metadata")
@ApiResponses({ @ApiResponse(code = 200, message = "list of templates"),
@ApiResponse(code = 500, message = "Error occured while retrieving templates") })
public ResponseWrapper> getTemplates(
@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(templateService.getTemplates(pageNumber, pageSize, sortBy, orderBy.name()));
return responseWrapper;
}
/**
* Search templates.
*
* @param request the request
* @return {@link PageResponseDto}
*/
@ResponseFilter
@PostMapping("/search")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "Search template details")
@ApiResponses({ @ApiResponse(code = 200, message = "list of templates"),
@ApiResponse(code = 500, message = "Error occured while retrieving templates") })
public ResponseWrapper> searchTemplates(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(
String.format(MasterDataConstant.SEARCH_API_IS_CALLED, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SEARCH_API_IS_CALLED, TemplateDto.class.getSimpleName()), "ADM-808");
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.searchTemplates(request.getRequest()));
auditUtil.auditRequest(String.format(MasterDataConstant.SUCCESSFUL_SEARCH, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_SEARCH_DESC, TemplateDto.class.getSimpleName()), "ADM-809");
return responseWrapper;
}
/**
* Filter templates.
*
* @param request the request
* @return {@link FilterResponseDto}
*/
@ResponseFilter
@PostMapping("/filtervalues")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "filter template details")
@ApiResponses({ @ApiResponse(code = 200, message = "list of templates"),
@ApiResponse(code = 500, message = "Error occured while retrieving templates") })
public ResponseWrapper filterTemplates(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(
String.format(MasterDataConstant.FILTER_API_IS_CALLED, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.FILTER_API_IS_CALLED, TemplateDto.class.getSimpleName()), "ADM-810");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(templateService.filterTemplates(request.getRequest()));
auditUtil.auditRequest(String.format(MasterDataConstant.SUCCESSFUL_FILTER, TemplateDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_FILTER_DESC, TemplateDto.class.getSimpleName()), "ADM-811");
return responseWrapper;
}
}
