org.openecomp.dcae.apod.analytics.tca.utils

Class TCAUtils

java.lang.Object

org.openecomp.dcae.apod.analytics.model.util.AnalyticsModelJsonUtils

org.openecomp.dcae.apod.analytics.tca.utils.TCAUtils

public abstract class TCAUtils
extends org.openecomp.dcae.apod.analytics.model.util.AnalyticsModelJsonUtils

Utility Helper methods for TCA sub module only. Extends AnalyticsModelJsonUtils to get pre configured Json Object Mapper understand serialization and deserialization of CEF Message and TCA Policy

Author:

Rajiv Singla. Creation Date: 10/24/2016.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<TCAVESAlertEntity,String>	MAP_ALERT_ENTITY_TO_ALERT_STRING_FUNCTION Function that extracts alert message string from TCAVESAlertEntity

Fields inherited from class org.openecomp.dcae.apod.analytics.model.util.AnalyticsModelJsonUtils

ANALYTICS_MODEL_OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
TCAUtils()

Method Summary

Modifier and Type	Method and Description
static TCACEFProcessorContext	computeThresholdViolations(TCACEFProcessorContext processorContext) Computes threshold violations
static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole	createNewMetricsPerFunctionalRole(Map.Entry<String,Map<String,String>> functionalRolesEntry) Create new MetricsPerFunctionalRole instance with policy Name, policy Version and policy Scope extracted from given functionalRolesEntry
static org.openecomp.dcae.apod.analytics.model.facade.tca.TCAVESResponse	createNewTCAVESResponse(TCACEFProcessorContext processorContext, String tcaAppName) Creates TCAVESResponse object
static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold	createNewThreshold(Map<String,String> thresholdMap) Creates new instance of TCA Policy Threshold with values extracted from thresholdMap
static List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole>	createTCAPolicyMetricsPerFunctionalRoleList(Map<String,Map<String,String>> functionalRolesMap) Creates TCAPolicy Metrics per Functional Role list
static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole	createViolatedMetrics(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy, org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold violatedThreshold, String functionalRole) Creates MetricsPerFunctionalRole object which contains violated thresholds
static List<String>	extractAlertFromAlertEntities(Collection<TCAVESAlertEntity> alertEntities) Extracts alert message strings from TCAVESAlertEntity
static Map<String,Map<String,String>>	extractSubTree(Map<String,String> actualMap, int startIndex, int endIndex, String delimiter) Converts a flattened key/value map which has keys delimited by a given delimiter.
static TCACEFProcessorContext	filterCEFMessage(String cefMessage, org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy) Creates a GenericMessageChainProcessor of TCACEFJsonProcessor, TCACEFPolicyDomainFilter and TCACEFPolicyFunctionalRoleFilters to filter out messages which does not match policy domain or functional role
static Map<String,String>	filterMapByKeyNamePrefix(Map<String,String> actualMap, String keyNamePrefix) Provides a view of underlying map that filters out entries with keys starting with give prefix
static org.apache.commons.lang3.tuple.Pair<String,String>	getDomainAndFunctionalRole(TCACEFProcessorContext processorContext) Extract Domain and functional Role from processor context if present
static Map<String,List<Long>>	getJsonPathValue(String message, Set<String> jsonFieldPaths) Extracts json path values for given json Field Paths from using Json path notation.
static com.google.common.collect.Table<String,String,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold>>	getPolicyFRThresholdsTable(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy) Creates a Table to lookup thresholds of a TCAPolicy by its Functional Role and Threshold Field path
static com.google.common.base.Supplier<com.google.common.collect.Table<String,String,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold>>>	getPolicyFRThresholdsTableSupplier(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy) A Supplier which caches Policy Functional Role and Threshold Field Path Thresholds lookup table
static List<String>	getPolicyFunctionalRoles(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy) Extracts TCAPolicy Functional Roles
static com.google.common.base.Supplier<List<String>>	getPolicyFunctionalRoleSupplier(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy) A Supplier which caches TCAPolicy Functional Roles as they are not expected to change during runtime
static TCAAppPreferences	getValidatedTCAAppPreferences(co.cask.cdap.api.RuntimeContext runtimeContext) Parses and validates Runtime Arguments to TCAAppPreferences object
static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy	getValidatedTCAPolicyPreferences(co.cask.cdap.api.RuntimeContext runtimeContext) Converts Runtime Arguments to TCAPolicyPreferences object
static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold	prioritizeThresholdViolations(Map<String,org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold> violatedThresholdsMap) Prioritize Threshold to be reported in case there was multiple TCA violations in a single CEF message.
static com.google.common.base.Function<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole,String>	tcaFunctionalRoleExtractorFunction() Function that extracts MetricsPerFunctionalRole.getFunctionalRole() from MetricsPerFunctionalRole
static com.google.common.base.Function<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole>>	tcaPolicyMetricsExtractorFunction() Function that extracts TCAPolicy.getMetricsPerFunctionalRole() from TCAPolicy
static com.google.common.base.Optional<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold>	thresholdCalculator(List<Long> messageFieldValues, List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold> fieldThresholds) Computes if any CEF Message Fields have violated any Policy Thresholds.
static TCAAppPreferences	updateDMaaPPubSubValues(Map<String,String> runtimeArguments, TCAAppPreferences tcaAppPreferences) Updates DMaaP Subscriber and Publisher Urls if present in runtime arguments.

Methods inherited from class org.openecomp.dcae.apod.analytics.model.util.AnalyticsModelJsonUtils

readValue, readValue, readValue, writeValueAsString

Methods inherited from class java.lang.Object

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

Field Detail

MAP_ALERT_ENTITY_TO_ALERT_STRING_FUNCTION

public static final com.google.common.base.Function<TCAVESAlertEntity,String> MAP_ALERT_ENTITY_TO_ALERT_STRING_FUNCTION

Function that extracts alert message string from TCAVESAlertEntity

Constructor Detail

TCAUtils

public TCAUtils()

Method Detail

tcaPolicyMetricsExtractorFunction

public static com.google.common.base.Function<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole>> tcaPolicyMetricsExtractorFunction()

Function that extracts TCAPolicy.getMetricsPerFunctionalRole() from TCAPolicy

Returns:

TCA Policy Metrics Per Functional Roles List

tcaFunctionalRoleExtractorFunction

public static com.google.common.base.Function<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole,String> tcaFunctionalRoleExtractorFunction()

Function that extracts MetricsPerFunctionalRole.getFunctionalRole() from MetricsPerFunctionalRole

Returns:

Functional role or a Metrics Per Functional Role object

getPolicyFunctionalRoles

public static List<String> getPolicyFunctionalRoles(@Nonnull
                                                    org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy)

Extracts TCAPolicy Functional Roles

Parameters:

tcaPolicy - TCA Policy

Returns:

List of functional Roles in the tca Policy

getPolicyFunctionalRoleSupplier

public static com.google.common.base.Supplier<List<String>> getPolicyFunctionalRoleSupplier(@Nonnull
                                                                                            org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy)

A Supplier which caches TCAPolicy Functional Roles as they are not expected to change during runtime

Parameters:

tcaPolicy - TCA Policy

Returns:

a Supplier that memoize the Functional roles

getPolicyFRThresholdsTable

public static com.google.common.collect.Table<String,String,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold>> getPolicyFRThresholdsTable(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy)

Creates a Table to lookup thresholds of a TCAPolicy by its Functional Role and Threshold Field path

Parameters:

tcaPolicy - TCA Policy

Returns:

A table with Keys of functional role and field path containing List of threshold as values

getPolicyFRThresholdsTableSupplier

public static com.google.common.base.Supplier<com.google.common.collect.Table<String,String,List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold>>> getPolicyFRThresholdsTableSupplier(org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy)

A Supplier which caches Policy Functional Role and Threshold Field Path Thresholds lookup table

Parameters:

tcaPolicy - TCA Policy

Returns:

Cached Supplier for table with Keys of functional role and field path containing thresholds as values

getValidatedTCAAppPreferences

public static TCAAppPreferences getValidatedTCAAppPreferences(co.cask.cdap.api.RuntimeContext runtimeContext)

Parses and validates Runtime Arguments to TCAAppPreferences object

Parameters:

runtimeContext - Runtime Context

Returns:

validated runtime arguments as TCAAppPreferences object

updateDMaaPPubSubValues

public static TCAAppPreferences updateDMaaPPubSubValues(Map<String,String> runtimeArguments,
                                                        TCAAppPreferences tcaAppPreferences)

Updates DMaaP Subscriber and Publisher Urls if present in runtime arguments. Maps runtime arguments property - dmaap.in.event-input.dmaapUrl to Subscriber host, port and topic Maps runtime arguments property - dmaap.out.alert-output.dmaapUrl to Publisher host, port and topic

Parameters:

runtimeArguments - Runtime arguments passed in to TCA App by controller

tcaAppPreferences - TCA App Preferences

Returns:

TCA App Preferences which updated Publisher and Subscriber host,port and topic values

filterCEFMessage

public static TCACEFProcessorContext filterCEFMessage(@Nullable
                                                      String cefMessage,
                                                      @Nonnull
                                                      org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy)

Creates a GenericMessageChainProcessor of TCACEFJsonProcessor, TCACEFPolicyDomainFilter and TCACEFPolicyFunctionalRoleFilters to filter out messages which does not match policy domain or functional role

Parameters:

cefMessage - CEF Message

tcaPolicy - TCA Policy

Returns:

Message Process Context after processing filter chain

getJsonPathValue

public static Map<String,List<Long>> getJsonPathValue(@Nonnull
                                                      String message,
                                                      @Nonnull
                                                      Set<String> jsonFieldPaths)

Extracts json path values for given json Field Paths from using Json path notation. Assumes that values extracted are always long

Parameters:

message - CEF Message

jsonFieldPaths - Json Field Paths

Returns:

Map containing key as json path and values as values associated with that json path

thresholdCalculator

public static com.google.common.base.Optional<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold> thresholdCalculator(List<Long> messageFieldValues,
                                                                                                                                       List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold> fieldThresholds)

Computes if any CEF Message Fields have violated any Policy Thresholds. For the same policy field path it applies threshold in order of their severity and record the first threshold per message field path

Parameters:

messageFieldValues - Field Path Values extracted from CEF Message

fieldThresholds - Policy Thresholds for Field Path

Returns:

Optional of violated threshold for a field path

prioritizeThresholdViolations

public static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold prioritizeThresholdViolations(Map<String,org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold> violatedThresholdsMap)

Prioritize Threshold to be reported in case there was multiple TCA violations in a single CEF message. Grabs first highest priority violated threshold

Parameters:

violatedThresholdsMap - Map containing field Path and associated violated Thresholds

Returns:

First Highest priority violated threshold

createViolatedMetrics

public static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole createViolatedMetrics(@Nonnull
                                                                                                                       org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy tcaPolicy,
                                                                                                                       @Nonnull
                                                                                                                       org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold violatedThreshold,
                                                                                                                       @Nonnull
                                                                                                                       String functionalRole)

Creates MetricsPerFunctionalRole object which contains violated thresholds

Parameters:

tcaPolicy - TCA Policy

violatedThreshold - Violated thresholds

functionalRole - Functiona Role

Returns:

MetricsPerFunctionalRole object containing one highest severity violated threshold

computeThresholdViolations

public static TCACEFProcessorContext computeThresholdViolations(TCACEFProcessorContext processorContext)

Computes threshold violations

Parameters:

processorContext - Filtered processor Context

Returns:

processor context with any threshold violations

createNewTCAVESResponse

public static org.openecomp.dcae.apod.analytics.model.facade.tca.TCAVESResponse createNewTCAVESResponse(TCACEFProcessorContext processorContext,
                                                                                                        String tcaAppName)

Creates TCAVESResponse object

Parameters:

processorContext - processor Context with violations

tcaAppName - TCA App Name

Returns:

TCA VES Response Message

getDomainAndFunctionalRole

public static org.apache.commons.lang3.tuple.Pair<String,String> getDomainAndFunctionalRole(@Nullable
                                                                                            TCACEFProcessorContext processorContext)

Extract Domain and functional Role from processor context if present

Parameters:

processorContext - processor context

Returns:

Tuple of domain and functional role

extractAlertFromAlertEntities

public static List<String> extractAlertFromAlertEntities(Collection<TCAVESAlertEntity> alertEntities)

Extracts alert message strings from TCAVESAlertEntity

Parameters:

alertEntities - collection of alert entities

Returns:

List of alert message strings

getValidatedTCAPolicyPreferences

public static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy getValidatedTCAPolicyPreferences(co.cask.cdap.api.RuntimeContext runtimeContext)

Converts Runtime Arguments to TCAPolicyPreferences object

Parameters:

runtimeContext - CDAP Runtime Arguments

Returns:

TCA Policy Preferences

createTCAPolicyMetricsPerFunctionalRoleList

public static List<org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole> createTCAPolicyMetricsPerFunctionalRoleList(Map<String,Map<String,String>> functionalRolesMap)

Creates TCAPolicy Metrics per Functional Role list

Parameters:

functionalRolesMap - Map containing functional Roles as key and corresponding values

Returns:

List of MetricsPerFunctionalRole

createNewThreshold

public static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold createNewThreshold(Map<String,String> thresholdMap)

Creates new instance of TCA Policy Threshold with values extracted from thresholdMap

Parameters:

thresholdMap - threshold map with threshold values

Returns:

new instance of TCA Policy Threshold

createNewMetricsPerFunctionalRole

public static org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole createNewMetricsPerFunctionalRole(Map.Entry<String,Map<String,String>> functionalRolesEntry)

Create new MetricsPerFunctionalRole instance with policy Name, policy Version and policy Scope extracted from given functionalRolesEntry

Parameters:

functionalRolesEntry - Functional Role Entry

Returns:

new instance of MetricsPerFunctionalRole

extractSubTree

public static Map<String,Map<String,String>> extractSubTree(Map<String,String> actualMap,
                                                            int startIndex,
                                                            int endIndex,
                                                            String delimiter)

Converts a flattened key/value map which has keys delimited by a given delimiter. The start Index and end index extract the sub-key value and returns a new map containing sub-keys and values.

Parameters:

actualMap - actual Map

startIndex - start index

endIndex - end index

delimiter - delimiter

Returns:

Map with new sub tree map

filterMapByKeyNamePrefix

public static Map<String,String> filterMapByKeyNamePrefix(Map<String,String> actualMap,
                                                          String keyNamePrefix)

Provides a view of underlying map that filters out entries with keys starting with give prefix

Parameters:

actualMap - Target map that needs to be filtered

keyNamePrefix - key prefix

Returns:

a view of actual map which only show entries which have give prefix