Package es.kukenan.smartfi.microservice.smartficore.controller

Class ConciliationController

java.lang.Object

es.kukenan.smartfi.microservice.smartficore.controller.AbstractController

es.kukenan.smartfi.microservice.smartficore.controller.ConciliationController

@RestController
public class ConciliationController
extends AbstractController

Controller to reply Core Conciliation endpoints definition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_BACKOFFICE_AUTHORITIES	Authority (role) required in order to be able to invoke change application status.
static final String	API_CONCILIATION_CARDS_PATH	REST API Conciliation cards path.
static final String	API_CONCILIATION_COMPANY_FILE_PATH	Conciliation company file path.
static final String	API_CONCILIATION_COMPANY_PATH	Conciliation company path.
static final String	API_CONCILIATION_LIST_PATH	REST API Conciliation list path.
static final String	API_PATH	REST API base path.
private ConciliationService	conciliationService	Company service.
private es.kukenan.smartfi.common.context.RequestContextManager	contextManager	Request context manager.
private es.kukenan.smartfi.common.service.jwt.JwtServiceImpl	jwtService	JWT service for create a bearer to call products.

Constructor Summary

Constructors

Constructor	Description
ConciliationController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Company>>	generateConciliationFile(String userId, Integer companyId)	Generate Conciliation file.
void	getConciliationFile(String userId, Integer companyId, String fileId, javax.servlet.http.HttpServletResponse response)	Get Conciliation file.
org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.common.api.dtos.ResultsPageDto<es.kukenan.smartfi.microservice.backoffice.dtos.core.conciliation.ConciliationFileDto>>>	getConciliationFiles(Integer companyId, Integer pageNumber, Integer pageSize, String sortedBy, Integer conciliationStatus, String userId)	Retrieve Conciliation files list.
org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<List<es.kukenan.smartfi.microservice.backoffice.dtos.core.conciliation.ConciliationFileCardsDto>>>	getConciliationFilesCards(Integer companyId, String userId)	Retrieve Conciliation files cards.
org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<Object>>	uploadConciliationFile(String userId, org.springframework.web.multipart.MultipartFile file)	Upload conciliation file.

Methods inherited from class es.kukenan.smartfi.microservice.smartficore.controller.AbstractController

fillResponseOk, fillResponseOk

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

API_PATH

public static final String API_PATH

REST API base path.

See Also:

• Constant Field Values

API_CONCILIATION_COMPANY_PATH

public static final String API_CONCILIATION_COMPANY_PATH

Conciliation company path.

See Also:

• Constant Field Values

API_CONCILIATION_COMPANY_FILE_PATH

public static final String API_CONCILIATION_COMPANY_FILE_PATH

Conciliation company file path.

See Also:

• Constant Field Values

API_CONCILIATION_LIST_PATH

public static final String API_CONCILIATION_LIST_PATH

REST API Conciliation list path.

See Also:

• Constant Field Values

API_CONCILIATION_CARDS_PATH

public static final String API_CONCILIATION_CARDS_PATH

REST API Conciliation cards path.

See Also:

• Constant Field Values

conciliationService

@Autowired
private ConciliationService conciliationService

Company service.

jwtService

@Autowired
private es.kukenan.smartfi.common.service.jwt.JwtServiceImpl jwtService

JWT service for create a bearer to call products.

contextManager

@Autowired
private es.kukenan.smartfi.common.context.RequestContextManager contextManager

Request context manager.

API_BACKOFFICE_AUTHORITIES

public static final String API_BACKOFFICE_AUTHORITIES

Authority (role) required in order to be able to invoke change application status.

See Also:

• Constant Field Values

Constructor Details

ConciliationController

public ConciliationController()

Method Details

uploadConciliationFile

@PreAuthorize("(hasRole(\'ROLE_ACCESS_ADMIN\') and hasRole(\'ROLE_LEVEL_BACKOFFICE_ADMIN\')) or (hasRole(\'ROLE_ACCESS_MODERATOR\') and hasRole(\'ROLE_LEVEL_USER_MODERATOR\')) or (hasRole(\'ROLE_ACCESS_COMPANY\') and hasRole(\'ROLE_LEVEL_USER_COMPANY\'))")
@PostMapping(path="/api/v1/conciliation",
             produces="application/json")
public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<Object>> uploadConciliationFile(@RequestHeader(name="X-USER-PROFILE-ID")
 String userId,
 @RequestPart("file")
 org.springframework.web.multipart.MultipartFile file)

Upload conciliation file. .

Parameters:

userId - user id.

file - file received.

Returns:

ok.

generateConciliationFile

@PreAuthorize("(hasRole(\'ROLE_ACCESS_ADMIN\') and hasRole(\'ROLE_LEVEL_BACKOFFICE_ADMIN\')) or (hasRole(\'ROLE_ACCESS_MODERATOR\') and hasRole(\'ROLE_LEVEL_USER_MODERATOR\')) or (hasRole(\'ROLE_ACCESS_COMPANY\') and hasRole(\'ROLE_LEVEL_USER_COMPANY\'))")
@GetMapping(path="/api/v1/conciliation/{companyId}")
public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.microservice.backoffice.dtos.core.contract.Company>> generateConciliationFile(@RequestHeader(name="X-USER-PROFILE-ID")
 String userId,
 @PathVariable("companyId")
 Integer companyId)

Generate Conciliation file.

Parameters:

userId - user identifier.

companyId - company identifier.

Returns:

Company detail.

getConciliationFile

@PreAuthorize("(hasRole(\'ROLE_ACCESS_ADMIN\') and hasRole(\'ROLE_LEVEL_BACKOFFICE_ADMIN\')) or (hasRole(\'ROLE_ACCESS_MODERATOR\') and hasRole(\'ROLE_LEVEL_USER_MODERATOR\')) or (hasRole(\'ROLE_ACCESS_COMPANY\') and hasRole(\'ROLE_LEVEL_USER_COMPANY\'))")
@GetMapping(path="/api/v1/conciliation/{companyId}/{fileId}")
public void getConciliationFile(@RequestHeader(name="X-USER-PROFILE-ID")
 String userId,
 @PathVariable("companyId")
 Integer companyId,
 @PathVariable("fileId")
 String fileId,
 javax.servlet.http.HttpServletResponse response)

Get Conciliation file.

Parameters:

userId - user identifier.

companyId - company identifier.

fileId - file identifier.

response - response.

getConciliationFiles

@PreAuthorize("(hasRole(\'ROLE_ACCESS_ADMIN\') and hasRole(\'ROLE_LEVEL_BACKOFFICE_ADMIN\')) or (hasRole(\'ROLE_ACCESS_MODERATOR\') and hasRole(\'ROLE_LEVEL_USER_MODERATOR\')) or (hasRole(\'ROLE_ACCESS_COMPANY\') and hasRole(\'ROLE_LEVEL_USER_COMPANY\'))")
@GetMapping(path="/api/v1/conciliation/{companyId}/list",
            produces="application/json")
public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<es.kukenan.smartfi.common.api.dtos.ResultsPageDto<es.kukenan.smartfi.microservice.backoffice.dtos.core.conciliation.ConciliationFileDto>>> getConciliationFiles(@PathVariable("companyId")
 Integer companyId,
 @RequestParam(name="pageNumber",required=false)
 Integer pageNumber,
 @RequestParam(name="pageSize",required=false)
 Integer pageSize,
 @RequestParam(name="sortedBy",required=false)
 String sortedBy,
 @RequestParam(name="conciliationStatus",required=false)
 Integer conciliationStatus,
 @RequestHeader(name="X-USER-PROFILE-ID",required=false)
 String userId)

Retrieve Conciliation files list.

Parameters:

companyId - company identifier.

pageNumber - number of page to get.

pageSize - size of list to return.

sortedBy - sort param.

conciliationStatus - conciliation status.

userId - user id.

Returns:

the Conciliation files.

getConciliationFilesCards

@PreAuthorize("(hasRole(\'ROLE_ACCESS_ADMIN\') and hasRole(\'ROLE_LEVEL_BACKOFFICE_ADMIN\')) or (hasRole(\'ROLE_ACCESS_MODERATOR\') and hasRole(\'ROLE_LEVEL_USER_MODERATOR\')) or (hasRole(\'ROLE_ACCESS_COMPANY\') and hasRole(\'ROLE_LEVEL_USER_COMPANY\'))")
@GetMapping(path="/api/v1/conciliation/{companyId}/cards",
            produces="application/json")
public org.springframework.http.ResponseEntity<es.kukenan.smartfi.dto.ResponseDTO<List<es.kukenan.smartfi.microservice.backoffice.dtos.core.conciliation.ConciliationFileCardsDto>>> getConciliationFilesCards(@PathVariable("companyId")
 Integer companyId,
 @RequestHeader(name="X-USER-PROFILE-ID",required=false)
 String userId)

Retrieve Conciliation files cards.

Parameters:

companyId - company identifier.

userId - user id.

Returns:

the Conciliation files.