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.DocumentCategoryController 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.CrossOrigin;
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.DocumentCategoryDto;
import io.mosip.kernel.masterdata.dto.DocumentTypeDto;
import io.mosip.kernel.masterdata.dto.getresponse.DocumentCategoryResponseDto;
import io.mosip.kernel.masterdata.dto.getresponse.PageDto;
import io.mosip.kernel.masterdata.dto.getresponse.extn.DocumentCategoryExtnDto;
import io.mosip.kernel.masterdata.dto.postresponse.CodeResponseDto;
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.CodeAndLanguageCodeID;
import io.mosip.kernel.masterdata.service.DocumentCategoryService;
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 class to fetch or create document categories.
*
* @author Neha
* @author Ritesh Sinha
* @author Uday Kumar
* @since 1.0.0
*
*/
@CrossOrigin
@RestController
@Api(tags = { "DocumentCategory" })
public class DocumentCategoryController {
@Autowired
AuditUtil auditUtil;
@Autowired
DocumentCategoryService documentCategoryService;
/**
* API to fetch all Document categories details
*
* @return All Document categories
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN','INDIVIDUAL','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','RESIDENT','REGISTRATION_PROCESSOR','REGISTRATION_PROCESSOR','REGISTRATION_OFFICER','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/documentcategories")
public ResponseWrapper getAllDocumentCategory() {
auditUtil.auditRequest(String.format(MasterDataConstant.GET_ALL, DocumentCategoryDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_ALL, DocumentCategoryDto.class.getSimpleName()), "ADM-692");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.getAllDocumentCategory());
auditUtil.auditRequest(
String.format(MasterDataConstant.GET_ALL_SUCCESS, DocumentCategoryDto.class.getSimpleName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.GET_ALL_SUCCESS_DESC, DocumentCategoryDto.class.getSimpleName()),
"ADM-693");
return responseWrapper;
}
/**
* API to fetch all Document categories details based on language code
*
* @param langCode the language code
*
* @return {@link DocumentCategoryResponseDto}
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN','INDIVIDUAL','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','RESIDENT','REGISTRATION_PROCESSOR','REGISTRATION_PROCESSOR','REGISTRATION_OFFICER','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/documentcategories/{langcode}")
public ResponseWrapper getAllDocumentCategoryByLaguageCode(
@PathVariable("langcode") String langCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.getAllDocumentCategoryByLaguageCode(langCode));
return responseWrapper;
}
/**
* API to fetch all Document categories details based on code and language code
*
* @param code the code
* @param langCode the language code
* @return {@link DocumentCategoryResponseDto}
*/
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN','INDIVIDUAL','PRE_REGISTRATION','REGISTRATION_SUPERVISOR','RESIDENT','REGISTRATION_PROCESSOR','REGISTRATION_PROCESSOR','REGISTRATION_OFFICER','PARTNER','AUTH_PARTNER','PARTNER_ADMIN','DEVICE_PROVIDER','DEVICE_MANAGER')")
@ResponseFilter
@GetMapping("/documentcategories/{code}/{langcode}")
public ResponseWrapper getDocumentCategoryByCodeAndLangCode(
@PathVariable("code") String code, @PathVariable("langcode") String langCode) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.getDocumentCategoryByCodeAndLangCode(code, langCode));
return responseWrapper;
}
/**
* API to create Document category
*
* @param category is of type {@link DocumentCategoryDto}
*
* @return {@link CodeAndLanguageCodeID}
*/
@ResponseFilter
@PostMapping("/documentcategories")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "Service to create document category", notes = "Create document category and return composite id")
public ResponseWrapper createDocumentCategory(
@ApiParam("Document category DTO to create") @Valid @RequestBody RequestWrapper category) {
auditUtil.auditRequest(MasterDataConstant.CREATE_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.CREATE_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(), "ADM-694");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.createDocumentCategory(category.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_CREATE, DocumentCategoryDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_CREATE_DESC, DocumentCategoryDto.class.getCanonicalName()),
"ADM-695");
return responseWrapper;
}
/**
* Api to update Document category.
*
* @param category is of type {@link DocumentCategoryDto}
* @return {@link CodeAndLanguageCodeID}
*/
@ResponseFilter
@PutMapping("/documentcategories")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "Service to update document category", notes = "Update document category and return composite id")
public ResponseWrapper updateDocumentCategory(
@ApiParam("Document category DTO to update") @Valid @RequestBody RequestWrapper category) {
auditUtil.auditRequest(MasterDataConstant.UPDATE_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.UPDATE_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(), "ADM-696");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.updateDocumentCategory(category.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_UPDATE, DocumentCategoryDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_UPDATE_DESC, DocumentCategoryDto.class.getCanonicalName()),
"ADM-697");
return responseWrapper;
}
/**
* Api to delete Document Category.
*
* @param code the document category code.
* @return the code.
*/
@ResponseFilter
@DeleteMapping("/documentcategories/{code}")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "Service to delete document category", notes = "Delete document category and return composite id")
public ResponseWrapper deleteDocumentCategory(@PathVariable("code") String code) {
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.deleteDocumentCategory(code));
return responseWrapper;
}
/**
* This controller method provides with all document category details.
*
* @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 document category details.
*/
//@PreAuthorize("hasAnyRole('ZONAL_ADMIN','CENTRAL_ADMIN')")
@ResponseFilter
@GetMapping("/documentcategories/all")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
@ApiOperation(value = "Retrieve all the document category with metadata", notes = "Retrieve all the document categories")
@ApiResponses({ @ApiResponse(code = 200, message = "list of device specifications"),
@ApiResponse(code = 500, message = "Error occured while retrieving device specifications") })
public ResponseWrapper> getAllDocCategories(
@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(documentCategoryService.getAllDocCategories(pageNumber, pageSize, sortBy, orderBy.name()));
return responseWrapper;
}
/**
* API to search document Category.
*
* @param request the request DTO {@link SearchDto} wrapped in
* {@link RequestWrapper}.
* @return the response i.e. multiple entities based on the search values
* required.
*/
@ResponseFilter
@PostMapping("/documentcategories/search")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
public ResponseWrapper> searchDocCategories(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(MasterDataConstant.SEARCH_API_IS_CALLED + DocumentTypeDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.SEARCH_API_IS_CALLED + DocumentTypeDto.class.getCanonicalName(), "ADM-698");
ResponseWrapper> responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.searchDocCategories(request.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_FILTER, DocumentCategoryDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_FILTER_DESC, DocumentCategoryDto.class.getCanonicalName()),
"ADM-699");
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
@PostMapping("/documentcategories/filtervalues")
@PreAuthorize("hasAnyRole('ZONAL_ADMIN','GLOBAL_ADMIN')")
public ResponseWrapper docCategoriesFilterValues(
@RequestBody @Valid RequestWrapper request) {
auditUtil.auditRequest(MasterDataConstant.FILTER_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(),
MasterDataConstant.AUDIT_SYSTEM,
MasterDataConstant.FILTER_API_IS_CALLED + DocumentCategoryDto.class.getCanonicalName(), "ADM-800");
ResponseWrapper responseWrapper = new ResponseWrapper<>();
responseWrapper.setResponse(documentCategoryService.docCategoriesFilterValues(request.getRequest()));
auditUtil.auditRequest(
String.format(MasterDataConstant.SUCCESSFUL_FILTER, DocumentCategoryDto.class.getCanonicalName()),
MasterDataConstant.AUDIT_SYSTEM,
String.format(MasterDataConstant.SUCCESSFUL_FILTER_DESC, DocumentCategoryDto.class.getCanonicalName()),
"ADM-801");
return responseWrapper;
}
}
