aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-tca/src/main/java/org/onap/dcae/apod/analytics/tca/processor/TCACEFPolicyEventNameFilter.java
blob: 73cbe78f12f41e793c2ea3043ef77c6d9ba68e89 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *          http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  ============================LICENSE_END===========================================
 */

package org.onap.dcae.apod.analytics.tca.processor;

import com.google.common.base.Joiner;
import org.onap.dcae.apod.analytics.model.domain.cef.EventListener;
import org.onap.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy;

import java.util.List;

import static org.onap.dcae.apod.analytics.tca.utils.TCAUtils.getPolicyEventNamesSupplier;

/**
 * <p>
 *     TCA Processor that acts like a filter to filter out messages which does not belong to TCA Policy Event Name
 *     <br>
 *     Pre Conditions: CEF Event Listener must be present
 * </p>
 *
 * @author Rajiv Singla . Creation Date: 11/9/2016.
 */
public class TCACEFPolicyEventNameFilter extends AbstractTCAECEFPolicyProcessor {

    private static final long serialVersionUID = 1L;

    @Override
    public String getProcessorDescription() {
        return "Filters out CEF Messages which does not match Policy Functional Roles";
    }

    @Override
    public TCACEFProcessorContext processMessage(TCACEFProcessorContext processorContext) {

        // Safe to get event Listener here without null check as pre processor will validate if
        // event listener is indeed present
        final EventListener eventListener = processorContext.getCEFEventListener();

        String cefMessageEventName;

        if (eventListener.getEvent() != null &&
                eventListener.getEvent().getCommonEventHeader() != null &&
                eventListener.getEvent().getCommonEventHeader().getEventName() != null) {
            cefMessageEventName = eventListener.getEvent().getCommonEventHeader().getEventName();
        } else {
            String terminationMessage = "Invalid CEF Message.Common Event Header Event Name not present.";
            setTerminatingProcessingMessage(terminationMessage, processorContext);
            return processorContext;
        }

        // Determine Policy Functional Roles
        final TCAPolicy tcaPolicy = processorContext.getTCAPolicy();
        final List<String> policyEventNames = getPolicyEventNamesSupplier(tcaPolicy).get();
        final String policyEventNamesString = Joiner.on(",").join(policyEventNames);

        // If Policy event names contains CEF message event names then continue processing
        if (policyEventNames.contains(cefMessageEventName)) {
            final String finishMessage = String.format(
                    "Policy Event Name and CEF Message Event Name match successful." +
                            "Message EventName: %s, Policy Event Names: %s",
                    cefMessageEventName, policyEventNamesString);
            setFinishedProcessingMessage(finishMessage, processorContext);
        } else {
            // If Policy event names does not contain CEF message event names then terminate processing
            final String terminatingMessage = String.format(
                    "Policy Event name and CEF Message Event name match unsuccessful." +
                            "Message EventName: %s, Policy Event Names: %s",
                    cefMessageEventName, policyEventNamesString);
            setTerminatingProcessingMessage(terminatingMessage, processorContext);
        }

        return processorContext;
    }
}