dcae-analytics-tca/src/main/java/org/openecomp/dcae/apod/analytics/tca/processor/TCACEFPolicyEventNameFilter.java

   1 /*\r
   2  * ===============================LICENSE_START======================================\r
   3  *  dcae-analytics\r
   4  * ================================================================================\r
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   8  *  you may not use this file except in compliance with the License.\r
   9  *   You may obtain a copy of the License at\r
  10  *\r
  11  *          http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  *  Unless required by applicable law or agreed to in writing, software\r
  14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  *  See the License for the specific language governing permissions and\r
  17  *  limitations under the License.\r
  18  *  ============================LICENSE_END===========================================\r
  19  */\r
  20 \r
  21 package org.openecomp.dcae.apod.analytics.tca.processor;\r
  22 \r
  23 import com.google.common.base.Joiner;\r
  24 import org.openecomp.dcae.apod.analytics.model.domain.cef.EventListener;\r
  25 import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy;\r
  26 \r
  27 import java.util.List;\r
  28 \r
  29 import static org.openecomp.dcae.apod.analytics.tca.utils.TCAUtils.getPolicyEventNamesSupplier;\r
  30 \r
  31 /**\r
  32  * <p>\r
  33  *     TCA Processor that acts like a filter to filter out messages which does not belong to TCA Policy Event Name\r
  34  *     <br>\r
  35  *     Pre Conditions: CEF Event Listener must be present\r
  36  * </p>\r
  37  *\r
  38  * @author Rajiv Singla . Creation Date: 11/9/2016.\r
  39  */\r
  40 public class TCACEFPolicyEventNameFilter extends AbstractTCAECEFPolicyProcessor {\r
  41 \r
  42     private static final long serialVersionUID = 1L;\r
  43 \r
  44     @Override\r
  45     public String getProcessorDescription() {\r
  46         return "Filters out CEF Messages which does not match Policy Functional Roles";\r
  47     }\r
  48 \r
  49     @Override\r
  50     public TCACEFProcessorContext processMessage(TCACEFProcessorContext processorContext) {\r
  51 \r
  52         // Safe to get event Listener here without null check as pre processor will validate if\r
  53         // event listener is indeed present\r
  54         final EventListener eventListener = processorContext.getCEFEventListener();\r
  55 \r
  56         String cefMessageEventName;\r
  57 \r
  58         if (eventListener.getEvent() != null &&\r
  59                 eventListener.getEvent().getCommonEventHeader() != null &&\r
  60                 eventListener.getEvent().getCommonEventHeader().getEventName() != null) {\r
  61             cefMessageEventName = eventListener.getEvent().getCommonEventHeader().getEventName();\r
  62         } else {\r
  63             String terminationMessage = "Invalid CEF Message.Common Event Header Event Name not present.";\r
  64             setTerminatingProcessingMessage(terminationMessage, processorContext);\r
  65             return processorContext;\r
  66         }\r
  67 \r
  68         // Determine Policy Functional Roles\r
  69         final TCAPolicy tcaPolicy = processorContext.getTCAPolicy();\r
  70         final List<String> policyEventNames = getPolicyEventNamesSupplier(tcaPolicy).get();\r
  71         final String policyEventNamesString = Joiner.on(",").join(policyEventNames);\r
  72 \r
  73         // If Policy event names contains CEF message event names then continue processing\r
  74         if (policyEventNames.contains(cefMessageEventName)) {\r
  75             final String finishMessage = String.format(\r
  76                     "Policy Event Name and CEF Message Event Name match successful." +\r
  77                             "Message EventName: %s, Policy Event Names: %s",\r
  78                     cefMessageEventName, policyEventNamesString);\r
  79             setFinishedProcessingMessage(finishMessage, processorContext);\r
  80         } else {\r
  81             // If Policy event names does not contain CEF message event names then terminate processing\r
  82             final String terminatingMessage = String.format(\r
  83                     "Policy Event name and CEF Message Event name match unsuccessful." +\r
  84                             "Message EventName: %s, Policy Event Names: %s",\r
  85                     cefMessageEventName, policyEventNamesString);\r
  86             setTerminatingProcessingMessage(terminatingMessage, processorContext);\r
  87         }\r
  88 \r
  89         return processorContext;\r
  90     }\r
  91 }\r