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

Class TemplateController

java.lang.Object

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

org.qubership.automation.itf.ui.controls.common.AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

org.qubership.automation.itf.ui.controls.entities.template.TemplateController

All Implemented Interfaces:

EntityController<UITemplate>

@RestController
 @Transactional(readOnly=true)
public class TemplateController
extends AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

Field Summary

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

LOGGER

Constructor Summary

Constructors

Constructor and Description
TemplateController()

Method Summary

Modifier and Type	Method and Description
protected org.qubership.automation.itf.core.model.jpa.message.template.Template	_beforeUpdate(UITemplate editRequest, org.qubership.automation.itf.core.model.jpa.message.template.Template template) do something before update the object.
protected Class<org.qubership.automation.itf.core.model.jpa.message.template.Template>	_getGenericUClass() must be return generic UClass.
protected org.qubership.automation.itf.core.util.provider.TemplateProvider	_getParent(String templateId) logic how to find a parent for id.
protected UITemplate	_newInstanceTClass(org.qubership.automation.itf.core.model.jpa.message.template.Template object) create new UIObject class.
UITemplate	create(String parentId, UUID projectUuid, Class<? extends org.qubership.automation.itf.core.util.provider.TemplateProvider> type)
List<List<UIObject>>	delete(Boolean ignoreUsages, UIIds uiDeleteObjectReq, UUID projectUuid) Delete Templates by template Ids list given.
List<? extends UIObject>	getAll(UUID projectUuid, BigInteger projectId) Get all Templates under the Project.
UITemplate	getById(BigInteger id, UUID projectUuid)
UITemplate	getByName(String name, BigInteger projectId, UUID projectUuid) Find Templates by Name under the project.
List<org.qubership.automation.itf.core.model.jpa.message.template.SystemTemplate>	getIdAndName(UUID projectUuid, BigInteger projectId, BigInteger systemId, BigInteger transportId) Get {id, name} list of SystemTemplates under the parent System (for drop-down lists in diameter transport).
List<? extends UIObject>	getTemplateOnOperationAndSystem(String id, UUID projectUuid) Get Template List under parent Operation and its System.
List<org.qubership.automation.itf.core.model.IdNamePair>	getTemplateOnOperationAndSystemFiltered(String id, String name, BigInteger projectId, UUID projectUuid) Returns operation and system templates filtering by name.
Map<String,Object>	getUsages(BigInteger id, UUID projectUuid) Find Template usages.
UITemplate	update(UITemplate uiTemplate, UUID projectUuid)

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

_deleteSubObjects, _isObjectSuitable, asListUIObject, beforeStoreUpdated, checkVersion, 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

TemplateController

public TemplateController()

Method Detail

getAll

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template/all",
                method=GET)
public List<? extends UIObject> getAll(@RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                      UUID projectUuid,
                                                                                                                                                                                                                                                                      @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                      BigInteger projectId)

Get all Templates under the Project.

getIdAndName

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template/allIdAndName",
                method=GET)
public List<org.qubership.automation.itf.core.model.jpa.message.template.SystemTemplate> getIdAndName(@RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                              UUID projectUuid,
                                                                                                                                                                                                                                                                                                                                              @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                                                              BigInteger projectId,
                                                                                                                                                                                                                                                                                                                                              @RequestParam(value="systemId",required=false)
                                                                                                                                                                                                                                                                                                                                              BigInteger systemId,
                                                                                                                                                                                                                                                                                                                                              @RequestParam(value="transportId",required=false)
                                                                                                                                                                                                                                                                                                                                              BigInteger transportId)

Get {id, name} list of SystemTemplates under the parent System (for drop-down lists in diameter transport).

getTemplateOnOperationAndSystem

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template/onOperationAndSystem",
                method=GET)
public List<? extends UIObject> getTemplateOnOperationAndSystem(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                                                                                                                                                String id,
                                                                                                                                                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                UUID projectUuid)

Get Template List under parent Operation and its System.

getTemplateOnOperationAndSystemFiltered

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template/onOperationAndSystemFiltered",
                method=GET)
public List<org.qubership.automation.itf.core.model.IdNamePair> getTemplateOnOperationAndSystemFiltered(@RequestParam(value="id")
                                                                                                                                                                                                                                                                                                                                                                String id,
                                                                                                                                                                                                                                                                                                                                                                @RequestParam(value="name")
                                                                                                                                                                                                                                                                                                                                                                String name,
                                                                                                                                                                                                                                                                                                                                                                @RequestParam(value="projectId")
                                                                                                                                                                                                                                                                                                                                                                BigInteger projectId,
                                                                                                                                                                                                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                                                UUID projectUuid)

Returns operation and system templates filtering by name. Applies if the project setting 'many.objects.ui.mode' is true.

Parameters:

id - situation id

name - template name for filtering

projectId - ITF project id

projectUuid - ATP project UUID

getById

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template",
                method=GET)
public UITemplate getById(@RequestParam(value="id",defaultValue="0")
                                                                                                                                                                                                                                                     BigInteger id,
                                                                                                                                                                                                                                                     @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                     UUID projectUuid)

create

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'CREATE\')")
 @RequestMapping(value="/template",
                method=POST)
public UITemplate create(@RequestParam(value="selectedId")
                                                                                                                                                                                                                                                                       String parentId,
                                                                                                                                                                                                                                                                       @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                       UUID projectUuid,
                                                                                                                                                                                                                                                                       @RequestParam(value="type")
                                                                                                                                                                                                                                                                       Class<? extends org.qubership.automation.itf.core.util.provider.TemplateProvider> type)

update

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'UPDATE\')")
 @RequestMapping(value="/template",
                method=PUT)
public UITemplate update(@RequestBody
                                                                                                                                                                                                                                                                      UITemplate uiTemplate,
                                                                                                                                                                                                                                                                      @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                      UUID projectUuid)

delete

@Transactional
 @PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'DELETE\')")
 @RequestMapping(value="/template",
                method=DELETE,
                produces="application/json")
public List<List<UIObject>> delete(@RequestParam(value="ignoreUsages",defaultValue="false")
                                                                                                                                                                                                                                                                                                                                Boolean ignoreUsages,
                                                                                                                                                                                                                                                                                                                                @RequestBody
                                                                                                                                                                                                                                                                                                                                UIIds uiDeleteObjectReq,
                                                                                                                                                                                                                                                                                                                                @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                                UUID projectUuid)

Delete Templates by template Ids list given. Check for usages or not, depending on 'ignoreUsages' parameter.

getByName

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/templateByName",
                method=GET)
public UITemplate getByName(@RequestParam(value="name")
                                                                                                                                                                                                                                                             String name,
                                                                                                                                                                                                                                                             @RequestParam(value="projectId")
                                                                                                                                                                                                                                                             BigInteger projectId,
                                                                                                                                                                                                                                                             @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                             UUID projectUuid)

Find Templates by Name under the project.

getUsages

@PreAuthorize(value="@entityAccess.checkAccess(T(org.qubership.automation.itf.ui.util.UserManagementEntities).TEMPLATE.getName(),#projectUuid, \'READ\')")
 @RequestMapping(value="/template/usages",
                method=GET,
                produces="application/json")
public Map<String,Object> getUsages(@RequestParam(value="id")
                                                                                                                                                                                                                                                                                                                   BigInteger id,
                                                                                                                                                                                                                                                                                                                   @RequestParam(value="projectUuid")
                                                                                                                                                                                                                                                                                                                   UUID projectUuid)

Find Template usages.

_beforeUpdate

protected org.qubership.automation.itf.core.model.jpa.message.template.Template _beforeUpdate(UITemplate editRequest,
                                                                                              org.qubership.automation.itf.core.model.jpa.message.template.Template template)

Description copied from class: AbstractController

do something before update the object.

Overrides:

_beforeUpdate in class AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

Parameters:

editRequest - have param for update

template - updatable object

Returns:

updatable object

_getGenericUClass

protected Class<org.qubership.automation.itf.core.model.jpa.message.template.Template> _getGenericUClass()

Description copied from class: AbstractController

must be return generic UClass.

Specified by:

_getGenericUClass in class AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

Returns:

UClass

_newInstanceTClass

protected UITemplate _newInstanceTClass(org.qubership.automation.itf.core.model.jpa.message.template.Template object)

Description copied from class: AbstractController

create new UIObject class.

Specified by:

_newInstanceTClass in class AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

Parameters:

object - storable for create an object extends UIObject

Returns:

an object extends UIObject

_getParent

protected org.qubership.automation.itf.core.util.provider.TemplateProvider _getParent(String templateId)

Description copied from class: AbstractController

logic how to find a parent for id.

Specified by:

_getParent in class AbstractController<UITemplate,org.qubership.automation.itf.core.model.jpa.message.template.Template>

Parameters:

templateId - parent identify

Returns:

parent