Package org.qubership.atp.environments.service.rest.server

Class EnvironmentController

java.lang.Object

org.qubership.atp.environments.service.rest.server.EnvironmentController

@RequestMapping("/api")
@RestController
public class EnvironmentController
extends Object

Constructor Summary

Constructors

Constructor	Description
EnvironmentController(EnvironmentService service, SystemService systemService, ConcurrentModificationService concurrentModificationService, ContextRepository contextRepository)	Constructor.

Method Summary

Modifier and Type	Method	Description
Environment	copy(UUID environmentId, EnvironmentDto environmentDto)	Copy environment.
Environment	createEnvironment(EnvironmentDto environmentDto)	Create environment.
System	createSystem(UUID environmentId, CreateSystemDto createSystemDto)
void	deleteEnvironment(UUID environmentId)
org.springframework.http.ResponseEntity<List<SystemVersionResponse>>	detailedUpdateVersion(UUID environmentId)	Getting a detailed system version check response with text of check error.
List<Environment>	findBySearchRequest(BaseSearchRequestDto searchRequest)
List<Environment>	getAll()
Environment	getEnvironment(UUID environmentId)
org.springframework.http.ResponseEntity<List<Connection>>	getEnvironmentConnections(UUID environmentId)	Method returns systems list.
org.springframework.http.ResponseEntity<String>	getEnvironmentNameById(UUID environmentId)	Method returns environment name.
org.springframework.http.ResponseEntity<List<Environment>>	getEnvironmentsByRequest(EnvironmentsWithFilterRequest request, Integer page, Integer size)
List<System>	getEnvironmentSystems(UUID environmentId, String systemType)	Method returns systems list.
Environment	getEnvironmentTsg3(UUID environmentId)
org.springframework.http.ResponseEntity<String>	getPublicHtmlVersion(List<UUID> environmentIds)	Method returns html-tables with system versions.
List<System>	getSystemsShort(UUID environmentId)	Method returns list of systems in abbreviated form ({"id":"","name":""}).
Collection<System>	getSystemV2(UUID environmentId, String systemType)	Getting a system with the ability to expand information on the environments and system categories.
Environment	temporary(UUID environmentId, List<SystemTemporaryDto> systemUpdateList)
org.springframework.http.ResponseEntity	updateEnvironment(EnvironmentDto environmentDto)	TODO Make javadoc documentation for this method.
org.springframework.http.ResponseEntity<List<System>>	updateVersion(UUID environmentId)

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentController

@Autowired
public EnvironmentController(EnvironmentService service,
 SystemService systemService,
 ConcurrentModificationService concurrentModificationService,
 ContextRepository contextRepository)

Constructor.

Method Details

getAll

@GetMapping("/environments")
public List<Environment> getAll()

findBySearchRequest

@PostMapping("/environments/search")
public List<Environment> findBySearchRequest(@RequestBody
 BaseSearchRequestDto searchRequest)
                                      throws Exception

Throws:

Exception

getEnvironment

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/environments/{environmentId}")
public Environment getEnvironment(@PathVariable("environmentId")
 UUID environmentId)

getEnvironmentNameById

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/environments/{environmentId}/name")
public org.springframework.http.ResponseEntity<String> getEnvironmentNameById(@PathVariable("environmentId")
 UUID environmentId)

Method returns environment name.

getEnvironmentTsg3

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'UPDATE\')")
@GetMapping("/environments/{environmentId}/systems/update-versions")
public Environment getEnvironmentTsg3(@PathVariable("environmentId")
 UUID environmentId)

getEnvironmentsByRequest

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),#request.getProjectId(),\'READ\')")
@PostMapping("/environments/filter")
public org.springframework.http.ResponseEntity<List<Environment>> getEnvironmentsByRequest(@RequestBody
 EnvironmentsWithFilterRequest request,
 @RequestParam(value="page",required=false)
 Integer page,
 @RequestParam(value="size",required=false)
 Integer size)

getEnvironmentSystems

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).SYSTEM.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/environments/{environmentId}/systems")
public List<System> getEnvironmentSystems(@PathVariable("environmentId")
 UUID environmentId,
 @RequestParam(value="system_type",required=false)
 String systemType)

Method returns systems list.

getEnvironmentConnections

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).CONNECTION.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/environments/{environmentId}/connections")
public org.springframework.http.ResponseEntity<List<Connection>> getEnvironmentConnections(@PathVariable("environmentId")
 UUID environmentId)

Method returns systems list.

getPublicHtmlVersion

@RequestMapping(value="/public/v1/environments/{environmentIds}/systems/htmlVersions",
                method=GET,
                produces="text/plain")
public org.springframework.http.ResponseEntity<String> getPublicHtmlVersion(@PathVariable("environmentIds")
 List<UUID> environmentIds)

Method returns html-tables with system versions.

getSystemsShort

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).SYSTEM.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/environments/{environmentId}/systems/short")
public List<System> getSystemsShort(@PathVariable("environmentId")
 UUID environmentId)

Method returns list of systems in abbreviated form ({"id":"","name":""}).

getSystemV2

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).SYSTEM.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'READ\')")
@GetMapping("/v2/environments/{environmentId}/systems")
public Collection<System> getSystemV2(@PathVariable("environmentId")
 UUID environmentId,
 @RequestParam(value="system_type",required=false)
 String systemType)

Getting a system with the ability to expand information on the environments and system categories.

createEnvironment

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),#environmentDto.getProjectId(),\'CREATE\')")
@PostMapping("/environments")
public Environment createEnvironment(@RequestBody
 EnvironmentDto environmentDto)

Create environment.

createSystem

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).SYSTEM.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId), \'CREATE\')")
@PostMapping("/environments/{environmentId}")
public System createSystem(@PathVariable("environmentId")
 UUID environmentId,
 @RequestBody
 CreateSystemDto createSystemDto)

copy

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),#environmentDto.getProjectId(),\'CREATE\')")
@PostMapping("/environments/{environmentId}/copy")
public Environment copy(@PathVariable("environmentId")
 UUID environmentId,
 @RequestBody
 EnvironmentDto environmentDto)

Copy environment.

temporary

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'CREATE\')")
@PostMapping("/environments/{environmentId}/temporary")
public Environment temporary(@PathVariable("environmentId")
 UUID environmentId,
 @RequestBody
 List<SystemTemporaryDto> systemUpdateList)

updateVersion

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).SYSTEM.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'UPDATE\')")
@GetMapping("/environments/{environmentId}/version")
public org.springframework.http.ResponseEntity<List<System>> updateVersion(@PathVariable("environmentId")
 UUID environmentId)

detailedUpdateVersion

@PreAuthorize("@entityAccess.checkAccess(@environmentService.getProjectIdByEnvironmentId(#environmentId).toString(),\'UPDATE\')")
@GetMapping("/v2/environments/{environmentId}/version")
public org.springframework.http.ResponseEntity<List<SystemVersionResponse>> detailedUpdateVersion(@PathVariable("environmentId")
 UUID environmentId)

Getting a detailed system version check response with text of check error.

updateEnvironment

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),#environmentDto.getProjectId(),\'UPDATE\')")
@PutMapping("/environments")
public org.springframework.http.ResponseEntity updateEnvironment(@RequestBody
 EnvironmentDto environmentDto)

TODO Make javadoc documentation for this method.

deleteEnvironment

@PreAuthorize("@entityAccess.checkAccess(T(org.qubership.atp.environments.enums.UserManagementEntities).ENVIRONMENT.getName(),@environmentService.getProjectIdByEnvironmentId(#environmentId),\'DELETE\')")
@DeleteMapping("/environments/{environmentId}")
@ResponseStatus(NO_CONTENT)
public void deleteEnvironment(@PathVariable("environmentId")
 UUID environmentId)