Package org.qubership.atp.itf.lite.backend.controllers

Class SseController

java.lang.Object

org.qubership.atp.itf.lite.backend.controllers.SseController

@RestController
@RequestMapping("/atp-itf-lite/api/v1/sse")
public class SseController
extends Object

Constructor Summary

Constructors

Constructor	Description
SseController()

Method Summary

Modifier and Type	Method	Description
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	connect(UUID projectId, UUID sseId, String token)	Endpoint to create SSE-emitter.
void	executeRequest(UUID requestId, String token, UUID environmentId, String context, UUID sessionId, UUID sseId, org.springframework.web.multipart.MultipartFile dictionary, List<org.springframework.web.multipart.MultipartFile> files, @Valid RequestEntitySaveRequest requestEntity)	Endpoint to send caught response via created emitter.
void	exportRequestsToItf(UUID sseId, UUID environmentId, @Valid RequestItfExportRequest itfExportRequest, String token)	Endpoint to export requests into ITF.
void	exportRequestsToMia(UUID sseId, UUID environmentId, String context, @Valid RequestMiaExportRequest miaExportRequest, String token)	Endpoint to send response for notification during export into MIA.

Methods inherited from class java.lang.Object

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

Constructor Details

SseController

public SseController()

Method Details

connect

@PreAuthorize("@entityAccess.checkAccess(#projectId,\'READ\')")
@GetMapping(value="/requests/connect",
            produces="text/event-stream")
public org.springframework.web.servlet.mvc.method.annotation.SseEmitter connect(@RequestParam
 UUID projectId,
 @RequestParam
 UUID sseId,
 @RequestHeader("Authorization")
 String token)
                                                                         throws IOException

Endpoint to create SSE-emitter.

Returns:

created emitter for particular request identifier

Throws:

IOException

executeRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'EXECUTE\')")
@PostMapping("/requests/{itfLiteRequestId}/execute")
public void executeRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestHeader("Authorization")
 String token,
 @RequestParam(required=false)
 UUID environmentId,
 @RequestParam(required=false)
 String context,
 @RequestParam(required=false)
 UUID sessionId,
 @RequestParam
 UUID sseId,
 @RequestPart(name="file",required=false)
 org.springframework.web.multipart.MultipartFile dictionary,
 @RequestPart(name="files",required=false)
 List<org.springframework.web.multipart.MultipartFile> files,
 @RequestPart(name="requestEntity") @Valid
 @Valid RequestEntitySaveRequest requestEntity)

Endpoint to send caught response via created emitter.

Parameters:

requestId - request identifier

exportRequestsToMia

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#miaExportRequest.getProjectId(),@requestService.getPermissionFolderIdsByRequestIds(#miaExportRequest.getRequestIds()),\'READ\')")
@PostMapping("/requests/mia/export")
public void exportRequestsToMia(@RequestParam
 UUID sseId,
 @RequestParam(required=false)
 UUID environmentId,
 @RequestParam(required=false)
 String context,
 @RequestBody @Valid
 @Valid RequestMiaExportRequest miaExportRequest,
 @RequestHeader("Authorization")
 String token)

Endpoint to send response for notification during export into MIA.

Parameters:

miaExportRequest - mia export requests

exportRequestsToItf

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#itfExportRequest.getProjectId(),@requestService.getPermissionFolderIdsByRequestIds(#itfExportRequest.getRequestIds()),\'READ\')")
@PostMapping("/requests/itf/export")
public void exportRequestsToItf(@RequestParam
 UUID sseId,
 @RequestParam(required=false)
 UUID environmentId,
 @RequestBody @Valid
 @Valid RequestItfExportRequest itfExportRequest,
 @RequestHeader("Authorization")
 String token)

Endpoint to export requests into ITF.

Parameters:

itfExportRequest - itf export requests