org.openecomp.sdc.be.impl

Class ComponentsUtils

java.lang.Object

org.openecomp.sdc.be.impl.ComponentsUtils

@Component(value="componentUtils")
public class ComponentsUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ComponentsUtils()

Method Summary

Modifier and Type	Method and Description
<T> void	addDeserializer(org.codehaus.jackson.map.module.SimpleModule module, Class<T> clazz, org.codehaus.jackson.map.JsonDeserializer<T> deserializer)
void	auditAdminUserAction(AuditingActionEnum actionEnum, User modifier, User userBefore, User userAfter, ResponseFormat responseFormat)
void	auditAuthEvent(AuditingActionEnum actionEnum, String url, String user, String authStatus, String realm)
void	auditCategory(ResponseFormat responseFormat, User modifier, String categoryName, String subCategoryName, String groupingName, AuditingActionEnum actionEnum, String componentType)
void	auditComponent(ResponseFormat responseFormat, User modifier, Component component, String prevState, String prevVersion, AuditingActionEnum actionEnum, ComponentTypeEnum type, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditComponentAdmin(ResponseFormat responseFormat, User modifier, Component component, String prevState, String prevVersion, AuditingActionEnum actionEnum, ComponentTypeEnum type)
void	auditConsumerCredentialsEvent(AuditingActionEnum actionEnum, ConsumerDefinition consumer, ResponseFormat responseFormat, User modifier)
void	auditDistributionDownload(ResponseFormat responseFormat, AuditingActionEnum actionEnum, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditDistributionEngine(AuditingActionEnum actionEnum, String environmentName, String topicName, String role, String apiKey, String status)
void	auditDistributionNotification(AuditingActionEnum actionEnum, String serviceUUID, String resourceName, String resourceType, String currVersion, String modifierUid, String modifierName, String environmentName, String currState, String topicName, String distributionId, String description, String status)
void	auditDistributionStatusNotification(AuditingActionEnum actionEnum, String distributionId, String consumerId, String topicName, String resourceUrl, String statusTime, String status, String errorReason)
void	auditExternalCrudApiArtifact(ResponseFormat responseFormat, String componentType, String actionEnum, javax.servlet.http.HttpServletRequest request, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditExternalDeleteArtifact(ResponseFormat responseFormat, String componentType, javax.servlet.http.HttpServletRequest request, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditExternalDownloadArtifact(ResponseFormat responseFormat, String componentType, javax.servlet.http.HttpServletRequest request, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditExternalGetAsset(ResponseFormat responseFormat, AuditingActionEnum actionEnum, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditExternalUpdateArtifact(ResponseFormat responseFormat, String componentType, javax.servlet.http.HttpServletRequest request, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditExternalUploadArtifact(ResponseFormat responseFormat, String componentType, javax.servlet.http.HttpServletRequest request, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditGetCategoryHierarchy(AuditingActionEnum actionEnum, User modifier, String details, ResponseFormat responseFormat)
void	auditGetUebCluster(AuditingActionEnum actionEnum, String consumerId, String statusTime, String status, String description)
void	auditGetUsersList(AuditingActionEnum actionEnum, User modifier, String details, ResponseFormat responseFormat)
void	auditMissingInstanceId(AuditingActionEnum actionEnum, String status, String description)
void	auditRegisterOrUnRegisterEvent(AuditingActionEnum actionEnum, String consumerId, String apiPublicKey, String envName, String status, String statusDesc, String notifTopicName, String statusTopicName)
void	auditResource(ResponseFormat responseFormat, User modifier, Resource resource, String prevState, String prevVersion, AuditingActionEnum actionEnum, EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)
void	auditServiceDistributionDeployed(AuditingActionEnum actionEnum, String serviceName, String serviceVersion, String serviceUUID, String distributionId, String status, String desc, User modifier)
void	auditTopicACLKeys(AuditingActionEnum actionEnum, String envName, String topicName, String role, String apiPublicKey, String status)
void	auditUserAccess(AuditingActionEnum actionEnum, User user, ResponseFormat responseFormat)
ActionStatus	convertFromStorageResponse(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponse(StorageOperationStatus storageResponse, ComponentTypeEnum type)
ActionStatus	convertFromStorageResponseForAdditionalInformation(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForCapabilityType(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForConsumer(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForDataType(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForGroupType(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForLifecycleType(StorageOperationStatus storageResponse)
ActionStatus	convertFromStorageResponseForResourceInstance(StorageOperationStatus storageResponse, boolean isRelation)
ActionStatus	convertFromStorageResponseForResourceInstanceProperty(StorageOperationStatus storageResponse)
ActionStatus	convertFromToscaError(ToscaError toscaError)
<T> fj.data.Either<T,ResponseFormat>	convertJsonToObject(String data, User user, Class<T> clazz, AuditingActionEnum actionEnum)
<T> fj.data.Either<T,ResponseFormat>	convertJsonToObjectUsingObjectMapper(String data, User user, Class<T> clazz, AuditingActionEnum actionEnum, ComponentTypeEnum typeEnum)
IAuditingManager	getAuditingManager()
ResponseFormat	getInvalidContentErrorAndAudit(User user, AuditingActionEnum actionEnum)
ResponseFormat	getInvalidContentErrorAndAuditComponent(User user, AuditingActionEnum actionEnum, ComponentTypeEnum typeEnum)
ResponseFormat	getResponseFormat(ActionStatus actionStatus, String... params)
ResponseFormat	getResponseFormatAdditionalProperty(ActionStatus actionStatus)
ResponseFormat	getResponseFormatAdditionalProperty(ActionStatus actionStatus, AdditionalInfoParameterInfo additionalInfoParameterInfo, NodeTypeEnum nodeType, AdditionalInformationEnum labelOrValue)
ResponseFormat	getResponseFormatByArtifactId(ActionStatus actionStatus, String artifactId)
ResponseFormat	getResponseFormatByCapabilityType(ActionStatus actionStatus, CapabilityTypeDefinition capabilityType)
ResponseFormat	getResponseFormatByComponent(ActionStatus actionStatus, Component component, ComponentTypeEnum type)
ResponseFormat	getResponseFormatByDataType(ActionStatus actionStatus, DataTypeDefinition dataType, List<String> properties)
ResponseFormat	getResponseFormatByDE(ActionStatus actionStatus, String serviceId, String envName)
ResponseFormat	getResponseFormatByGroupType(ActionStatus actionStatus, GroupTypeDefinition groupType)
ResponseFormat	getResponseFormatByMissingArtifacts(ComponentTypeEnum componentType, Map<String,ArtifactDefinition> artifacts) " Error: Missing Mandatory Informational %s1 %s2 : %s3 " where %s1 - "resource"/"service" %s2 - "artifact"/ "artifacts" %s3 - Comma separated list of missing informational artifact types
ResponseFormat	getResponseFormatByPolicyType(ActionStatus actionStatus, PolicyTypeDefinition policyType)
ResponseFormat	getResponseFormatByResource(ActionStatus actionStatus, Resource resource) Returns the response format of resource error with respective variables according to actionStatus.
ResponseFormat	getResponseFormatByResource(ActionStatus actionStatus, String resourceName)
ResponseFormat	getResponseFormatByUser(ActionStatus actionStatus, User user) Returns the response format of resource error with respective variables according to actionStatus.
ResponseFormat	getResponseFormatByUserId(ActionStatus actionStatus, String userId)
ResponseFormat	getResponseFormatForResourceInstance(ActionStatus actionStatus, String serviceName, String resourceInstanceName)
ResponseFormat	getResponseFormatForResourceInstanceProperty(ActionStatus actionStatus, String resourceInstanceName)
void	Init()
static <T> T	parseJsonToObject(String data, Class<T> clazz)
void	setAuditingManager(IAuditingManager auditingManager)
fj.data.Either<Boolean,ResponseFormat>	validateStringMatchesPattern(User user, Component component, String value, Pattern pattern, ActionStatus badResult, AuditingActionEnum actionEnum)
Boolean	validateStringNotEmpty(String value)
fj.data.Either<Boolean,ResponseFormat>	validateStringNotEmpty(User user, Component component, String value, ActionStatus badResult, AuditingActionEnum actionEnum)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentsUtils

public ComponentsUtils()

Method Detail

Init

@PostConstruct
public void Init()

getAuditingManager

public IAuditingManager getAuditingManager()

setAuditingManager

public void setAuditingManager(IAuditingManager auditingManager)

convertJsonToObject

public <T> fj.data.Either<T,ResponseFormat> convertJsonToObject(String data,
                                                                User user,
                                                                Class<T> clazz,
                                                                AuditingActionEnum actionEnum)

parseJsonToObject

public static <T> T parseJsonToObject(String data,
                                      Class<T> clazz)

convertJsonToObjectUsingObjectMapper

public <T> fj.data.Either<T,ResponseFormat> convertJsonToObjectUsingObjectMapper(String data,
                                                                                 User user,
                                                                                 Class<T> clazz,
                                                                                 AuditingActionEnum actionEnum,
                                                                                 ComponentTypeEnum typeEnum)

addDeserializer

public <T> void addDeserializer(org.codehaus.jackson.map.module.SimpleModule module,
                                Class<T> clazz,
                                org.codehaus.jackson.map.JsonDeserializer<T> deserializer)

getResponseFormat

public ResponseFormat getResponseFormat(ActionStatus actionStatus,
                                        String... params)

getResponseFormatByResource

public ResponseFormat getResponseFormatByResource(ActionStatus actionStatus,
                                                  Resource resource)

Returns the response format of resource error with respective variables according to actionStatus. This is needed for cases where actionStatus is anonymously converted from storage operation, and the caller doesn't know what actionStatus he received. It's caller's Responsibility to fill the resource object passed to this function with needed fields. Note that RESOURCE_IN_USE case passes hardcoded "resource" string to the error parameter. This means that if Resource object will also be used for Service, this code needs to be refactored and we should tell Resource from Service.

Parameters:

actionStatus -

resource -

Returns:

getResponseFormatByResource

public ResponseFormat getResponseFormatByResource(ActionStatus actionStatus,
                                                  String resourceName)

getResponseFormatByCapabilityType

public ResponseFormat getResponseFormatByCapabilityType(ActionStatus actionStatus,
                                                        CapabilityTypeDefinition capabilityType)

getResponseFormatByUser

public ResponseFormat getResponseFormatByUser(ActionStatus actionStatus,
                                              User user)

Returns the response format of resource error with respective variables according to actionStatus. This is needed for cases where actionStatus is anynomously converted from storage operation, and the caller doesn't know what actionStatus he received. It's caller's responisibility to fill the passed resource object with needed fields.

Parameters:

actionStatus -

user -

Returns:

getResponseFormatByUserId

public ResponseFormat getResponseFormatByUserId(ActionStatus actionStatus,
                                                String userId)

getResponseFormatByDE

public ResponseFormat getResponseFormatByDE(ActionStatus actionStatus,
                                            String serviceId,
                                            String envName)

getResponseFormatByArtifactId

public ResponseFormat getResponseFormatByArtifactId(ActionStatus actionStatus,
                                                    String artifactId)

getInvalidContentErrorAndAudit

public ResponseFormat getInvalidContentErrorAndAudit(User user,
                                                     AuditingActionEnum actionEnum)

getInvalidContentErrorAndAuditComponent

public ResponseFormat getInvalidContentErrorAndAuditComponent(User user,
                                                              AuditingActionEnum actionEnum,
                                                              ComponentTypeEnum typeEnum)

auditResource

public void auditResource(ResponseFormat responseFormat,
                          User modifier,
                          Resource resource,
                          String prevState,
                          String prevVersion,
                          AuditingActionEnum actionEnum,
                          EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditDistributionDownload

public void auditDistributionDownload(ResponseFormat responseFormat,
                                      AuditingActionEnum actionEnum,
                                      EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalGetAsset

public void auditExternalGetAsset(ResponseFormat responseFormat,
                                  AuditingActionEnum actionEnum,
                                  EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalCrudApiArtifact

public void auditExternalCrudApiArtifact(ResponseFormat responseFormat,
                                         String componentType,
                                         String actionEnum,
                                         javax.servlet.http.HttpServletRequest request,
                                         EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalDownloadArtifact

public void auditExternalDownloadArtifact(ResponseFormat responseFormat,
                                          String componentType,
                                          javax.servlet.http.HttpServletRequest request,
                                          EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalUploadArtifact

public void auditExternalUploadArtifact(ResponseFormat responseFormat,
                                        String componentType,
                                        javax.servlet.http.HttpServletRequest request,
                                        EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalUpdateArtifact

public void auditExternalUpdateArtifact(ResponseFormat responseFormat,
                                        String componentType,
                                        javax.servlet.http.HttpServletRequest request,
                                        EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditExternalDeleteArtifact

public void auditExternalDeleteArtifact(ResponseFormat responseFormat,
                                        String componentType,
                                        javax.servlet.http.HttpServletRequest request,
                                        EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditCategory

public void auditCategory(ResponseFormat responseFormat,
                          User modifier,
                          String categoryName,
                          String subCategoryName,
                          String groupingName,
                          AuditingActionEnum actionEnum,
                          String componentType)

convertFromStorageResponse

public ActionStatus convertFromStorageResponse(StorageOperationStatus storageResponse)

convertFromStorageResponse

public ActionStatus convertFromStorageResponse(StorageOperationStatus storageResponse,
                                               ComponentTypeEnum type)

convertFromToscaError

public ActionStatus convertFromToscaError(ToscaError toscaError)

convertFromStorageResponseForCapabilityType

public ActionStatus convertFromStorageResponseForCapabilityType(StorageOperationStatus storageResponse)

convertFromStorageResponseForLifecycleType

public ActionStatus convertFromStorageResponseForLifecycleType(StorageOperationStatus storageResponse)

convertFromStorageResponseForResourceInstance

public ActionStatus convertFromStorageResponseForResourceInstance(StorageOperationStatus storageResponse,
                                                                  boolean isRelation)

getResponseFormatForResourceInstance

public ResponseFormat getResponseFormatForResourceInstance(ActionStatus actionStatus,
                                                           String serviceName,
                                                           String resourceInstanceName)

getResponseFormatForResourceInstanceProperty

public ResponseFormat getResponseFormatForResourceInstanceProperty(ActionStatus actionStatus,
                                                                   String resourceInstanceName)

convertFromStorageResponseForResourceInstanceProperty

public ActionStatus convertFromStorageResponseForResourceInstanceProperty(StorageOperationStatus storageResponse)

auditComponentAdmin

public void auditComponentAdmin(ResponseFormat responseFormat,
                                User modifier,
                                Component component,
                                String prevState,
                                String prevVersion,
                                AuditingActionEnum actionEnum,
                                ComponentTypeEnum type)

auditComponent

public void auditComponent(ResponseFormat responseFormat,
                           User modifier,
                           Component component,
                           String prevState,
                           String prevVersion,
                           AuditingActionEnum actionEnum,
                           ComponentTypeEnum type,
                           EnumMap<AuditingFieldsKeysEnum,Object> additionalParams)

auditDistributionEngine

public void auditDistributionEngine(AuditingActionEnum actionEnum,
                                    String environmentName,
                                    String topicName,
                                    String role,
                                    String apiKey,
                                    String status)

auditDistributionNotification

public void auditDistributionNotification(AuditingActionEnum actionEnum,
                                          String serviceUUID,
                                          String resourceName,
                                          String resourceType,
                                          String currVersion,
                                          String modifierUid,
                                          String modifierName,
                                          String environmentName,
                                          String currState,
                                          String topicName,
                                          String distributionId,
                                          String description,
                                          String status)

auditAuthEvent

public void auditAuthEvent(AuditingActionEnum actionEnum,
                           String url,
                           String user,
                           String authStatus,
                           String realm)

auditDistributionStatusNotification

public void auditDistributionStatusNotification(AuditingActionEnum actionEnum,
                                                String distributionId,
                                                String consumerId,
                                                String topicName,
                                                String resourceUrl,
                                                String statusTime,
                                                String status,
                                                String errorReason)

auditGetUebCluster

public void auditGetUebCluster(AuditingActionEnum actionEnum,
                               String consumerId,
                               String statusTime,
                               String status,
                               String description)

auditMissingInstanceId

public void auditMissingInstanceId(AuditingActionEnum actionEnum,
                                   String status,
                                   String description)

auditTopicACLKeys

public void auditTopicACLKeys(AuditingActionEnum actionEnum,
                              String envName,
                              String topicName,
                              String role,
                              String apiPublicKey,
                              String status)

auditRegisterOrUnRegisterEvent

public void auditRegisterOrUnRegisterEvent(AuditingActionEnum actionEnum,
                                           String consumerId,
                                           String apiPublicKey,
                                           String envName,
                                           String status,
                                           String statusDesc,
                                           String notifTopicName,
                                           String statusTopicName)

auditServiceDistributionDeployed

public void auditServiceDistributionDeployed(AuditingActionEnum actionEnum,
                                             String serviceName,
                                             String serviceVersion,
                                             String serviceUUID,
                                             String distributionId,
                                             String status,
                                             String desc,
                                             User modifier)

auditConsumerCredentialsEvent

public void auditConsumerCredentialsEvent(AuditingActionEnum actionEnum,
                                          ConsumerDefinition consumer,
                                          ResponseFormat responseFormat,
                                          User modifier)

auditGetUsersList

public void auditGetUsersList(AuditingActionEnum actionEnum,
                              User modifier,
                              String details,
                              ResponseFormat responseFormat)

auditAdminUserAction

public void auditAdminUserAction(AuditingActionEnum actionEnum,
                                 User modifier,
                                 User userBefore,
                                 User userAfter,
                                 ResponseFormat responseFormat)

auditUserAccess

public void auditUserAccess(AuditingActionEnum actionEnum,
                            User user,
                            ResponseFormat responseFormat)

auditGetCategoryHierarchy

public void auditGetCategoryHierarchy(AuditingActionEnum actionEnum,
                                      User modifier,
                                      String details,
                                      ResponseFormat responseFormat)

getResponseFormatByComponent

public ResponseFormat getResponseFormatByComponent(ActionStatus actionStatus,
                                                   Component component,
                                                   ComponentTypeEnum type)

validateStringNotEmpty

public fj.data.Either<Boolean,ResponseFormat> validateStringNotEmpty(User user,
                                                                     Component component,
                                                                     String value,
                                                                     ActionStatus badResult,
                                                                     AuditingActionEnum actionEnum)

validateStringNotEmpty

public Boolean validateStringNotEmpty(String value)

validateStringMatchesPattern

public fj.data.Either<Boolean,ResponseFormat> validateStringMatchesPattern(User user,
                                                                           Component component,
                                                                           String value,
                                                                           Pattern pattern,
                                                                           ActionStatus badResult,
                                                                           AuditingActionEnum actionEnum)

getResponseFormatByMissingArtifacts

public ResponseFormat getResponseFormatByMissingArtifacts(ComponentTypeEnum componentType,
                                                          Map<String,ArtifactDefinition> artifacts)

" Error: Missing Mandatory Informational %s1 %s2 : %s3 " where %s1 - "resource"/"service" %s2 - "artifact"/ "artifacts" %s3 - Comma separated list of missing informational artifact types

Parameters:

resource -

componentMissingMandatoryArtifacts -

value -

Returns:

convertFromStorageResponseForAdditionalInformation

public ActionStatus convertFromStorageResponseForAdditionalInformation(StorageOperationStatus storageResponse)

getResponseFormatAdditionalProperty

public ResponseFormat getResponseFormatAdditionalProperty(ActionStatus actionStatus,
                                                          AdditionalInfoParameterInfo additionalInfoParameterInfo,
                                                          NodeTypeEnum nodeType,
                                                          AdditionalInformationEnum labelOrValue)

getResponseFormatAdditionalProperty

public ResponseFormat getResponseFormatAdditionalProperty(ActionStatus actionStatus)

convertFromStorageResponseForConsumer

public ActionStatus convertFromStorageResponseForConsumer(StorageOperationStatus storageResponse)

convertFromStorageResponseForGroupType

public ActionStatus convertFromStorageResponseForGroupType(StorageOperationStatus storageResponse)

convertFromStorageResponseForDataType

public ActionStatus convertFromStorageResponseForDataType(StorageOperationStatus storageResponse)

getResponseFormatByGroupType

public ResponseFormat getResponseFormatByGroupType(ActionStatus actionStatus,
                                                   GroupTypeDefinition groupType)

getResponseFormatByPolicyType

public ResponseFormat getResponseFormatByPolicyType(ActionStatus actionStatus,
                                                    PolicyTypeDefinition policyType)

getResponseFormatByDataType

public ResponseFormat getResponseFormatByDataType(ActionStatus actionStatus,
                                                  DataTypeDefinition dataType,
                                                  List<String> properties)