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

Class RequestController

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor	Description
RequestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Request>	copyRequest(UUID requestId, @Valid RequestEntityCopyRequest request)
org.springframework.http.ResponseEntity<Void>	copyRequests(@Valid RequestEntitiesCopyRequest request)
org.springframework.http.ResponseEntity<Request>	createRequest(@Valid RequestEntityCreateRequest request)
org.springframework.http.ResponseEntity<Void>	deleteRequest(UUID requestId)
org.springframework.http.ResponseEntity<Void>	deleteRequests(@Valid RequestEntitiesBulkDelete request)
void	downloadFile(UUID requestId, UUID fileId, javax.servlet.http.HttpServletResponse response)
void	downloadResponseAsFile(UUID requestId, UUID executionId, javax.servlet.http.HttpServletResponse response)	Sends response as file.
org.springframework.http.ResponseEntity<Request>	editRequest(UUID requestId, @Valid RequestEntityEditRequest request)	Update request entity configuration.
org.springframework.http.ResponseEntity<ExecuteStepResponse>	execute(UUID environmentId, ExecutionCollectionRequestExecuteRequest requestExecuteRequest)	Endpoint to execute single request from collection.
org.springframework.http.ResponseEntity<RequestExportResponse>	exportRequest(UUID requestId, UUID environmentId, String context)	Deprecated.
org.springframework.http.ResponseEntity<RequestExportResponse>	exportRequest(UUID requestId, UUID environmentId, String context, List<ContextVariable> contextVariables)
org.springframework.http.ResponseEntity<Collection<Request>>	getAllRequests(UUID projectId, UUID folderId)
org.springframework.http.ResponseEntity<ContextResponse>	getContext(UUID projectId, String context)
org.springframework.http.ResponseEntity<Request>	getRequest(UUID projectId, UUID requestId)	Get request by request id.
void	getRequestBinaryFile(UUID requestId, javax.servlet.http.HttpServletResponse response)
org.springframework.http.ResponseEntity<Settings>	getRequestSetting(UUID requestId)
org.springframework.http.ResponseEntity<ImportContextResponse>	importContextFromRam(ImportContextRequest importContextRequest)
org.springframework.http.ResponseEntity<Request>	importRequest(@Valid CurlStringImportRequest importRequest)	Imports request from curl string.
org.springframework.http.ResponseEntity<Request>	moveRequest(UUID requestId, @Valid RequestEntityMoveRequest request)
org.springframework.http.ResponseEntity<List<UUID>>	moveRequests(@Valid RequestEntitiesMoveRequest request)	Change parent folder for request.
org.springframework.http.ResponseEntity<Void>	order(UUID requestId, RequestOrderChangeRequest request)
org.springframework.http.ResponseEntity<Request>	saveRequest(UUID requestId, UUID sessionId, org.springframework.web.multipart.MultipartFile file, List<org.springframework.web.multipart.MultipartFile> files, @Valid RequestEntitySaveRequest requestEntity)	Saves request entity and file to file system and grid fs if exists.
void	uploadBinaryFile(UUID requestId, org.springframework.web.multipart.MultipartFile file)
org.springframework.http.ResponseEntity<Void>	uploadFormDataFile(UUID requestId, UUID formDataPartId, org.springframework.web.multipart.MultipartFile file)

Methods inherited from class java.lang.Object

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

Constructor Details

RequestController

public RequestController()

Method Details

getAllRequests

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#projectId,\'READ\')")
@GetMapping
public org.springframework.http.ResponseEntity<Collection<Request>> getAllRequests(@RequestParam
 UUID projectId,
 @RequestParam(required=false)
 UUID folderId)

createRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'CREATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),#request.getFolderId() != null ? @folderService.getFolder(#request.getFolderId()).getPermissionFolderId() : null,\'UPDATE\')")
@PostMapping
public org.springframework.http.ResponseEntity<Request> createRequest(@RequestBody @Valid
 @Valid RequestEntityCreateRequest request)

getRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#projectId != null ? #projectId : @requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}")
public org.springframework.http.ResponseEntity<Request> getRequest(@RequestParam(required=false)
 UUID projectId,
 @PathVariable("itfLiteRequestId")
 UUID requestId)

Get request by request id.

Parameters:

requestId - request id.

Returns:

request entity

getRequestSetting

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}/settings")
public org.springframework.http.ResponseEntity<Settings> getRequestSetting(@PathVariable("itfLiteRequestId")
 UUID requestId)

getRequestBinaryFile

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}/binary")
public void getRequestBinaryFile(@PathVariable("itfLiteRequestId")
 UUID requestId,
 javax.servlet.http.HttpServletResponse response)
                          throws IOException

Throws:

IOException

uploadBinaryFile

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(), \'CREATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),@requestService.getRequest(#requestId).getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@PutMapping("/{itfLiteRequestId}/binary/upload")
public void uploadBinaryFile(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestPart(name="file")
 org.springframework.web.multipart.MultipartFile file)

saveRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#requestEntity.getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#requestEntity.getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@PutMapping("/{itfLiteRequestId}")
public org.springframework.http.ResponseEntity<Request> saveRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestParam(required=false)
 UUID sessionId,
 @RequestPart(name="file",required=false)
 org.springframework.web.multipart.MultipartFile file,
 @RequestPart(name="files",required=false)
 List<org.springframework.web.multipart.MultipartFile> files,
 @RequestPart(name="requestEntity") @Valid
 @Valid RequestEntitySaveRequest requestEntity)
                                                             throws IOException

Saves request entity and file to file system and grid fs if exists.

Parameters:

requestId - request id

file - dictionary

requestEntity - request entity

Returns:

Request

Throws:

IOException

editRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@PatchMapping("/{itfLiteRequestId}")
public org.springframework.http.ResponseEntity<Request> editRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestBody @Valid
 @Valid RequestEntityEditRequest request)

Update request entity configuration.

Parameters:

requestId - request id.

request - body with params for update.

Returns:

updated request.

copyRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'CREATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),#request.getFolderId() != null ? @folderService.getFolder(#request.getFolderId()).getPermissionFolderId() : null,\'UPDATE\')")
@PostMapping("/{itfLiteRequestId}/copy")
public org.springframework.http.ResponseEntity<Request> copyRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestBody @Valid
 @Valid RequestEntityCopyRequest request)

copyRequests

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'CREATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),#request.getFolderId() != null ? @folderService.getFolder(#request.getFolderId()).getPermissionFolderId() : null,\'UPDATE\')")
@PostMapping("/copy")
public org.springframework.http.ResponseEntity<Void> copyRequests(@RequestBody @Valid
 @Valid RequestEntitiesCopyRequest request)

moveRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),#request.getFolderId() != null ? @folderService.getFolder(#request.getFolderId()).getPermissionFolderId() : null,\'UPDATE\')")
@PostMapping("/{itfLiteRequestId}/move")
public org.springframework.http.ResponseEntity<Request> moveRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestBody @Valid
 @Valid RequestEntityMoveRequest request)

moveRequests

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),@requestService.getPermissionFolderIdsByIdsWithModifiedWhen(#request.getRequestIds()),\'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),#request.getFolderId() != null ? @folderService.getFolder(#request.getFolderId()).getPermissionFolderId() : null,\'UPDATE\')")
@PostMapping("/move")
public org.springframework.http.ResponseEntity<List<UUID>> moveRequests(@RequestBody @Valid
 @Valid RequestEntitiesMoveRequest request)

Change parent folder for request.

Parameters:

request - body with list of requests and new parent folder.

Returns:

list of request ids.

deleteRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(), \'DELETE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),@requestService.getRequest(#requestId).getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@DeleteMapping("/{itfLiteRequestId}")
public org.springframework.http.ResponseEntity<Void> deleteRequest(@PathVariable("itfLiteRequestId")
 UUID requestId)

deleteRequests

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'DELETE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),@requestService.getPermissionFolderIdsByRequestIds(#request.getRequestIds()),\'UPDATE\')")
@DeleteMapping
public org.springframework.http.ResponseEntity<Void> deleteRequests(@RequestBody @Valid
 @Valid RequestEntitiesBulkDelete request)

exportRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}/export")
@Deprecated
public org.springframework.http.ResponseEntity<RequestExportResponse> exportRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestParam(required=false)
 UUID environmentId,
 @RequestParam(required=false)
 String context)
                                                                             throws URISyntaxException

Deprecated.

Throws:

URISyntaxException

exportRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@PostMapping("/{itfLiteRequestId}/export")
public org.springframework.http.ResponseEntity<RequestExportResponse> exportRequest(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestParam(required=false)
 UUID environmentId,
 @RequestParam(required=false)
 String context,
 @RequestBody(required=false)
 List<ContextVariable> contextVariables)
                                                                             throws URISyntaxException

Throws:

URISyntaxException

importRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#importRequest.getRequestId()).getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),@requestService.getRequest(#importRequest.getRequestId()).getProjectId(),@requestService.getRequest(#importRequest.getRequestId()).getPermissionFolderId(),\'UPDATE\')")
@PostMapping("/import")
public org.springframework.http.ResponseEntity<Request> importRequest(@RequestBody @Valid
 @Valid CurlStringImportRequest importRequest)

Imports request from curl string.

Parameters:

importRequest - request id and curl request string

Returns:

imported request

getContext

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#projectId,\'READ\')")
@GetMapping("/context")
public org.springframework.http.ResponseEntity<ContextResponse> getContext(@RequestParam
 UUID projectId,
 @RequestParam
 String context)
                                                                    throws URISyntaxException

Throws:

URISyntaxException

order

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),#request.getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),#request.getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@PostMapping("/{itfLiteRequestId}/order")
public org.springframework.http.ResponseEntity<Void> order(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestBody
 RequestOrderChangeRequest request)

execute

@PreAuthorize("@entityAccess.checkAccess(#requestExecuteRequest.getProjectId(),\'EXECUTE\')")
@PostMapping("/execute")
public org.springframework.http.ResponseEntity<ExecuteStepResponse> execute(@RequestParam(required=false)
 UUID environmentId,
 @RequestBody
 ExecutionCollectionRequestExecuteRequest requestExecuteRequest)
                                                                     throws com.fasterxml.jackson.core.JsonProcessingException

Endpoint to execute single request from collection.

Throws:

com.fasterxml.jackson.core.JsonProcessingException

uploadFormDataFile

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(), \'UPDATE\') and @entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).FOLDER.getName(),@requestService.getRequest(#requestId).getProjectId(),@requestService.getRequest(#requestId).getPermissionFolderId(),\'UPDATE\')")
@PutMapping("/{itfLiteRequestId}/formdata/{formDataPartId}/file/upload")
public org.springframework.http.ResponseEntity<Void> uploadFormDataFile(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @PathVariable
 UUID formDataPartId,
 @RequestPart(name="file")
 org.springframework.web.multipart.MultipartFile file)

downloadFile

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}/file/{fileId}/download")
public void downloadFile(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @PathVariable("fileId")
 UUID fileId,
 javax.servlet.http.HttpServletResponse response)
                  throws IOException

Throws:

IOException

importContextFromRam

@PreAuthorize("@entityAccess.checkAccess(#importContextRequest.getProjectId(),\'READ\')")
@PostMapping("/import/contextVariables")
public org.springframework.http.ResponseEntity<ImportContextResponse> importContextFromRam(@RequestBody
 ImportContextRequest importContextRequest)

downloadResponseAsFile

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.itf.lite.backend.utils.UserManagementEntities).REQUEST.getName(),@requestService.getRequest(#requestId).getProjectId(),\'READ\')")
@GetMapping("/{itfLiteRequestId}/downloadResponse")
public void downloadResponseAsFile(@PathVariable("itfLiteRequestId")
 UUID requestId,
 @RequestParam
 UUID executionId,
 javax.servlet.http.HttpServletResponse response)

Sends response as file.

Parameters:

requestId - request id

executionId - execution id