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

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