org.qubership.automation.itf.ui.controls.entities.situation

Class SituationController

java.lang.Object

org.qubership.automation.itf.ui.controls.common.AbstractStorableController<U>

org.qubership.automation.itf.ui.controls.common.AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

org.qubership.automation.itf.ui.controls.entities.situation.SituationController

All Implemented Interfaces:

EntityController<UISituation>

@RestController
public class SituationController
extends AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

Field Summary

Fields inherited from class org.qubership.automation.itf.ui.controls.common.AbstractController

LOGGER

Constructor Summary

Constructors

Constructor and Description
SituationController()

Method Summary

Modifier and Type	Method and Description
protected org.qubership.automation.itf.core.model.jpa.system.stub.Situation	_beforeUpdate(UISituation uiSituation, org.qubership.automation.itf.core.model.jpa.system.stub.Situation situation) do something before update the object.
protected Class<org.qubership.automation.itf.core.model.jpa.system.stub.Situation>	_getGenericUClass() must be return generic UClass.
protected org.qubership.automation.itf.core.model.common.Storable	_getParent(String parentId) logic how to find a parent for id.
protected UISituation	_newInstanceTClass(org.qubership.automation.itf.core.model.jpa.system.stub.Situation object) create new UIObject class.
void	_update(UISituation uiSituation)
protected void	checkVersion(org.qubership.automation.itf.core.model.jpa.system.stub.Situation object, UISituation uiObject)
UISituation	create(String parentId, UUID projectUuid, UISituation uiAddSituationReq) Creates situation under parent operation (identified by parentId).
String	createBvCaseOnSituation(String situationId, BigInteger projectId, String bvTcId, UUID projectUuid) Create BV testcase linked with the situation (identified by situationId), or link existing BV testcase with the situation - in case bvLink is provided.
UISituation	createTemplateAndSituation(String id, UISituationExtended uiAddSituationReq, UUID projectUuid) Creates situation under parent operation (identified by id).
List<UIObject>	delete(UIIds uiDeleteObjectReq, BigInteger projectId, UUID projectUuid) Delete situation(s) by ids.
void	deleteOrUnlinkBvCaseOnSituation(String situationId, BigInteger projectId, Boolean isDeleting, UUID projectUuid) Delete or unlink BV testcase from the situation (identified by situationId).
UISituation	feignGetById(String id) ATPII-30543: this request was added because the page formation on the monitoring tab goes through feign client(row - 508, MonitoringController.class).
UISituation	getById(String id, UUID projectUuid) Get Situation by id.
Set<String>	getLabels(BigInteger projectId, UUID projectUuid) Get all 'situation'-labels by project id.
Set<UIParsingRule>	getParsingRules(String id, UUID projectUuid) Get situation's parsing rules.
String[]	getScripts(String id, UUID projectUuid) Get situation scripts.
UIListImpl	getSituations(String parentId, boolean isFull, BigInteger projectId, UUID projectUuid) Get List of Situations.
List<Object[]>	getSituationsWithBvLinks(BigInteger projectId, UUID projectUuid) Get situations (with parent operation and system info) using BV testcases.
UISituation	refresh(UISituation uiSituation)
void	setSelf(SituationController self)
UISituation	update(UISituation uiSituation, UUID projectUuid) Update Situation based on uiSituation object received.

Methods inherited from class org.qubership.automation.itf.ui.controls.common.AbstractController

_deleteSubObjects, _isObjectSuitable, asListUIObject, beforeStoreUpdated, create, create, create, create, create, create, delete, delete, delete, delete, getAll, getAll, getAllSimple, getAllSuitable, getAllWithEciParams, getById, manager, setSimple, storeUpdated, update, update, updateUIObject, usageInfoListAsString

Methods inherited from class org.qubership.automation.itf.ui.controls.common.AbstractStorableController

haveUsages

Methods inherited from class java.lang.Object

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

Constructor Detail

SituationController

public SituationController()

Method Detail

setSelf

@Autowired
public void setSelf(SituationController self)

getSituations

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation/all",
                method=GET)
public UIListImpl getSituations(@RequestParam(value="parent",defaultValue="0")
                                                                                                                                                                                                                                                                                                String parentId,
                                                                                                                                                                                                                                                                                                @RequestParam(value="isFull",defaultValue="true")
                                                                                                                                                                                                                                                                                                boolean isFull,
                                                                                                                                                                                                                                                                                                @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                BigInteger projectId,
                                                                                                                                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                UUID projectUuid)
                                                                                                                                                                                                                                                                                         throws Exception

Get List of Situations.

Parameters:

parentId - parent id

isFull - logical operator used for filling full structure or simple

projectId - inner project id

projectUuid - project UUID

Returns:

UIListImpl If parentId = 0 - All situations inside project (by projectId) Otherwise - All situations under parent operation (by parentId)

Throws:

Exception

getById

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation",
                method=GET)
public UISituation getById(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                                                                                                                       String id,
                                                                                                                                                                                                                                                                                       @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                       UUID projectUuid)

Get Situation by id.

Parameters:

id - object id

projectUuid - project UUID

Returns:

UISituation for the situation found

feignGetById

@Transactional(readOnly=true)
 @RequestMapping(value="/situation/{id}",
                method=GET)
public UISituation feignGetById(@PathVariable(value="id")
                                                                                                                                    String id)

ATPII-30543: this request was added because the page formation on the monitoring tab goes through feign client(row - 508, MonitoringController.class).

Parameters:

id - situation id

Returns:

UISituation for the situation found

create

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'CREATE\')")
 @RequestMapping(value="/situation",
                method=POST)
public UISituation create(@RequestParam(value="operation",defaultValue="0")
                                                                                                                                                                                                                                                                          String parentId,
                                                                                                                                                                                                                                                                          @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                          UUID projectUuid,
                                                                                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                                                                                          UISituation uiAddSituationReq)
                                                                                                                                                                                                                                                                   throws Exception

Creates situation under parent operation (identified by parentId).

Parameters:

parentId - parent id

projectUuid - project UUID

Returns:

UISituation for the situation created

Throws:

Exception

createTemplateAndSituation

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'CREATE\') and @entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'CREATE\')")
 @RequestMapping(value="/createTemplateAndSituation",
                method=POST)
public UISituation createTemplateAndSituation(@RequestParam(value="operation",defaultValue="0")
                                                                                                                                                                                                                                                                                                                                                                                                                                                         String id,
                                                                                                                                                                                                                                                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                         UISituationExtended uiAddSituationReq,
                                                                                                                                                                                                                                                                                                                                                                                                                                                         @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                                                                                                                                         UUID projectUuid)

Creates situation under parent operation (identified by id). Creates a new Template, fills its fields. Fills situation.

Parameters:

id - operation id

uiAddSituationReq - UISituationExtended

projectUuid - project UUID

Returns:

UISituation for the situation created

update

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'UPDATE\')")
 @RequestMapping(value="/situation",
                method=PUT)
public UISituation update(@RequestBody
                                                                                                                                                                                                                                                         UISituation uiSituation,
                                                                                                                                                                                                                                                         @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                         UUID projectUuid)

Update Situation based on uiSituation object received.

Parameters:

uiSituation - UISituation ui situation

projectUuid - project UUID

Returns:

UISituation new object constructed from updated Situation

_update

@Transactional
public void _update(UISituation uiSituation)

refresh

@Transactional(readOnly=true)
public UISituation refresh(UISituation uiSituation)

getScripts

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation/scripts",
                method=GET)
public String[] getScripts(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                                                                                                                               String id,
                                                                                                                                                                                                                                                                                               @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                               UUID projectUuid)

Get situation scripts.

Parameters:

id - situation id

projectUuid - project UUID

Returns:

String[] array of scripts

delete

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'DELETE\')")
 @RequestMapping(value="/situation",
                method=DELETE)
public List<UIObject> delete(@RequestBody
                                                                                                                                                                                                                                                                               UIIds uiDeleteObjectReq,
                                                                                                                                                                                                                                                                               @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                               BigInteger projectId,
                                                                                                                                                                                                                                                                               @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                               UUID projectUuid)

Delete situation(s) by ids. Usages checking is performed. If at least one situation has usages, deletion is cancelled, and IllegalArgumentException is thrown.

Parameters:

uiDeleteObjectReq - UIIds ids object to delete

projectId - inner project id

projectUuid - project UUID

Returns:

List of UIObject for deleted objects

createBvCaseOnSituation

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'CREATE\')")
 @RequestMapping(value="/situation/integration/bv",
                method=GET,
                produces="text/plain")
public String createBvCaseOnSituation(@RequestParam(value="situationId")
                                                                                                                                                                                                                                                                                                                                           String situationId,
                                                                                                                                                                                                                                                                                                                                           @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                                                           BigInteger projectId,
                                                                                                                                                                                                                                                                                                                                           @RequestParam(value="bvTcId",required=false)
                                                                                                                                                                                                                                                                                                                                           String bvTcId,
                                                                                                                                                                                                                                                                                                                                           @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                           UUID projectUuid)
                                                                                                                                                                                                                                                                                                                                    throws IOException

Create BV testcase linked with the situation (identified by situationId), or link existing BV testcase with the situation - in case bvLink is provided.

Parameters:

situationId - situation id

bvTcId - bv testcase uuid

projectId - inner project id

projectUuid - project UUID

Returns:

BV testcase link

Throws:

IOException

deleteOrUnlinkBvCaseOnSituation

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'DELETE\')")
 @RequestMapping(value="/situation/integration/bv",
                method=DELETE)
public void deleteOrUnlinkBvCaseOnSituation(@RequestParam(value="situationId")
                                                                                                                                                                                                                                                                                                             String situationId,
                                                                                                                                                                                                                                                                                                             @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                             BigInteger projectId,
                                                                                                                                                                                                                                                                                                             @RequestParam(value="isDeleting")
                                                                                                                                                                                                                                                                                                             Boolean isDeleting,
                                                                                                                                                                                                                                                                                                             @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                             UUID projectUuid)
                                                                                                                                                                                                                                                                                                      throws IOException

Delete or unlink BV testcase from the situation (identified by situationId).

Parameters:

situationId - situation id

isDeleting - logical operator used for deleting integration

projectId - inner project id

projectUuid - project UUID

Throws:

IOException

getSituationsWithBvLinks

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation/getSituationsWithBvLinks",
                method=GET)
public List<Object[]> getSituationsWithBvLinks(@RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                                                    BigInteger projectId,
                                                                                                                                                                                                                                                                                                                                    @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                    UUID projectUuid)

Get situations (with parent operation and system info) using BV testcases.

Parameters:

projectId - inner project id

projectUuid - project UUID

Returns:

list with situations

getParsingRules

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation/parsingRules",
                method=GET)
public Set<UIParsingRule> getParsingRules(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                                                                                                                                                   String id,
                                                                                                                                                                                                                                                                                                                   @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                   UUID projectUuid)

Get situation's parsing rules.

Parameters:

id - situation id

projectUuid - project UUID

Returns:

set UIParsingRule parsing rule

getLabels

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).SITUATION.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/situation/label",
                method=GET)
public Set<String> getLabels(@RequestParam(value="projectId")
                                                                                                                                                                                                                                                                BigInteger projectId,
                                                                                                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                UUID projectUuid)

Get all 'situation'-labels by project id.

Parameters:

projectId - inner project id

projectUuid - project UUID

Returns:

set with labels

_beforeUpdate

protected org.qubership.automation.itf.core.model.jpa.system.stub.Situation _beforeUpdate(UISituation uiSituation,
                                                                                          org.qubership.automation.itf.core.model.jpa.system.stub.Situation situation)

Description copied from class: AbstractController

do something before update the object.

Overrides:

_beforeUpdate in class AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

Parameters:

uiSituation - have param for update

situation - updatable object

Returns:

updatable object

_getGenericUClass

protected Class<org.qubership.automation.itf.core.model.jpa.system.stub.Situation> _getGenericUClass()

Description copied from class: AbstractController

must be return generic UClass.

Specified by:

_getGenericUClass in class AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

Returns:

UClass

_newInstanceTClass

protected UISituation _newInstanceTClass(org.qubership.automation.itf.core.model.jpa.system.stub.Situation object)

Description copied from class: AbstractController

create new UIObject class.

Specified by:

_newInstanceTClass in class AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

Parameters:

object - storable for create an object extends UIObject

Returns:

an object extends UIObject

_getParent

protected org.qubership.automation.itf.core.model.common.Storable _getParent(String parentId)

Description copied from class: AbstractController

logic how to find a parent for id.

Specified by:

_getParent in class AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>

Parameters:

parentId - parent identify

Returns:

parent

checkVersion

protected void checkVersion(org.qubership.automation.itf.core.model.jpa.system.stub.Situation object,
                            UISituation uiObject)

Overrides:

checkVersion in class AbstractController<UISituation,org.qubership.automation.itf.core.model.jpa.system.stub.Situation>