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

Class SystemController

java.lang.Object

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

org.qubership.automation.itf.ui.controls.common.AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

org.qubership.automation.itf.ui.controls.entities.system.SystemController

All Implemented Interfaces:

EntityController<UISystem>

@RestController
public class SystemController
extends AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Field Summary

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

LOGGER

Constructor Summary

Constructors

Constructor and Description
SystemController()

Method Summary

Modifier and Type	Method and Description
org.qubership.automation.itf.core.model.jpa.system.System	_beforeUpdate(UISystem uiObject, org.qubership.automation.itf.core.model.jpa.system.System object) do something before update the object.
void	_deleteSubObjects(org.qubership.automation.itf.core.model.jpa.system.System object) delete all sub objects in deleted the object.
Class<org.qubership.automation.itf.core.model.jpa.system.System>	_getGenericUClass() must be return generic UClass.
org.qubership.automation.itf.core.model.common.Storable	_getParent(String parentId) logic how to find a parent for id.
UISystem	_newInstanceTClass(org.qubership.automation.itf.core.model.jpa.system.System object) create new UIObject class.
protected void	checkVersion(org.qubership.automation.itf.core.model.jpa.system.System object, UISystem uiObject)
UIObject	create(String parentId, UUID projectUuid, UIObject requestBody) TODO Add JavaDoc.
org.qubership.automation.itf.core.model.communication.message.delete.DeleteEntityResultMessage<String,UIObject>	delete(Boolean ignoreUsages, String deleteObjectsReq, BigInteger projectId, UUID projectUuid) TODO Add JavaDoc.
UISystem	feignGetById(String id)
List<? extends UIObject>	getAll(String parentId, UUID projectUuid)
List<? extends UIECIObject>	getAll(UUID projectUuid, BigInteger projectId) Get all systems by project id.
List<org.qubership.automation.itf.core.model.IdNamePair>	getAllSimple(UUID projectUuid, BigInteger projectId) Get all simple Systems (id, name only) by project id.
UISystem	getById(String id, UUID projectUuid)
Collection<UIIdentifiedObject>	getOutOperationsBySystem(BigInteger id) Get all outbound operations by the system ID as json array of {name, id, className} objects.
Collection<UIIdentifiedObject>	getSystemsByProjectId(UUID projectId) Get all systems by the project UUID as json array of {name, id, className} objects.
Map<String,Object>	getUsages(String id, UUID projectUuid) TODO Add JavaDoc.
UISystem	update(UISystem uiSystem, UUID projectUuid)

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

_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

SystemController

public SystemController()

Method Detail

getAll

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"READ\")")
 @RequestMapping(value="/system/all",
                method=GET)
public List<? extends UIECIObject> getAll(@RequestParam(value="projectUuid")
                                                                                                                                                                                                                    UUID projectUuid,
                                                                                                                                                                                                                    @RequestParam
                                                                                                                                                                                                                    BigInteger projectId)

Get all systems by project id.

getAllSimple

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"READ\")")
 @RequestMapping(value="/system/allSimple",
                method=GET)
public List<org.qubership.automation.itf.core.model.IdNamePair> getAllSimple(@RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                             UUID projectUuid,
                                                                                                                                                                                                                                                             @RequestParam
                                                                                                                                                                                                                                                             BigInteger projectId)

Get all simple Systems (id, name only) by project id.

getAll

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"READ\")")
 @RequestMapping(value="/system/allbyparent",
                method=GET)
public List<? extends UIObject> getAll(@RequestParam(value="parentId",defaultValue="0")
                                                                                                                                                                                                                         String parentId,
                                                                                                                                                                                                                         @RequestParam(value="projectUuid")
                                                                                                                                                                                                                         UUID projectUuid)

getById

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"READ\")")
 @RequestMapping(value="/system",
                method=GET)
public UISystem getById(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                              String id,
                                                                                                                                                                                              @RequestParam(value="projectUuid")
                                                                                                                                                                                              UUID projectUuid)

feignGetById

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

getSystemsByProjectId

@Transactional(readOnly=true)
 @RequestMapping(value="/systems",
                method=GET)
public Collection<UIIdentifiedObject> getSystemsByProjectId(@RequestParam
                                                                                                                                                         UUID projectId)

Get all systems by the project UUID as json array of {name, id, className} objects. Currently, it is used from Itf-Lite to support 'Export to ITF' UI.

Returns:

array of {name, id, className} objects.

getOutOperationsBySystem

@Transactional(readOnly=true)
 @RequestMapping(value="/system/{id}/operations",
                method=GET)
public Collection<UIIdentifiedObject> getOutOperationsBySystem(@PathVariable
                                                                                                                                                                           BigInteger id)

Get all outbound operations by the system ID as json array of {name, id, className} objects. Currently, it is used from Itf-Lite to support 'Export to ITF' UI.

Returns:

array of {name, id, className} objects.

create

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"CREATE\")")
 @RequestMapping(value="/system",
                method=POST)
public UIObject create(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                 String parentId,
                                                                                                                                                                                 @RequestParam(value="projectUuid")
                                                                                                                                                                                 UUID projectUuid,
                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                 UIObject requestBody)

TODO Add JavaDoc.

delete

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"DELETE\")")
 @RequestMapping(value="/system",
                method=DELETE,
                produces="application/json")
public org.qubership.automation.itf.core.model.communication.message.delete.DeleteEntityResultMessage<String,UIObject> delete(@RequestParam(value="ignoreUsages",defaultValue="false")
                                                                                                                                                                                                                                                                                                                                       Boolean ignoreUsages,
                                                                                                                                                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                                                                                                                                                       String deleteObjectsReq,
                                                                                                                                                                                                                                                                                                                                       @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                                                       BigInteger projectId,
                                                                                                                                                                                                                                                                                                                                       @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                       UUID projectUuid)

TODO Add JavaDoc.

update

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"UPDATE\")")
 @RequestMapping(value="/system",
                method=PUT)
public UISystem update(@RequestBody
                                                                                                                                                                                UISystem uiSystem,
                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                UUID projectUuid)

_getGenericUClass

public Class<org.qubership.automation.itf.core.model.jpa.system.System> _getGenericUClass()

Description copied from class: AbstractController

must be return generic UClass.

Specified by:

_getGenericUClass in class AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Returns:

UClass

_newInstanceTClass

public UISystem _newInstanceTClass(org.qubership.automation.itf.core.model.jpa.system.System object)

Description copied from class: AbstractController

create new UIObject class.

Specified by:

_newInstanceTClass in class AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Parameters:

object - storable for create an object extends UIObject

Returns:

an object extends UIObject

_getParent

public 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<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Parameters:

parentId - parent identify

Returns:

parent

_beforeUpdate

public org.qubership.automation.itf.core.model.jpa.system.System _beforeUpdate(UISystem uiObject,
                                                                               org.qubership.automation.itf.core.model.jpa.system.System object)

Description copied from class: AbstractController

do something before update the object.

Overrides:

_beforeUpdate in class AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Parameters:

uiObject - have param for update

object - updatable object

Returns:

updatable object

_deleteSubObjects

public void _deleteSubObjects(org.qubership.automation.itf.core.model.jpa.system.System object)

Description copied from class: AbstractController

delete all sub objects in deleted the object.

Overrides:

_deleteSubObjects in class AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>

Parameters:

object - parent object

getUsages

@Transactional(readOnly=true)
 @PreAuthorize(value="@entityAccess.checkAccess(#projectUuid, \"READ\")")
 @RequestMapping(value="/system/usages",
                method=GET,
                produces="application/json")
public Map<String,Object> getUsages(@RequestParam(value="id")
                                                                                                                                                                                                                                                              String id,
                                                                                                                                                                                                                                                              @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                              UUID projectUuid)

TODO Add JavaDoc.

checkVersion

protected void checkVersion(org.qubership.automation.itf.core.model.jpa.system.System object,
                            UISystem uiObject)

Overrides:

checkVersion in class AbstractController<UISystem,org.qubership.automation.itf.core.model.jpa.system.System>