aboutsummaryrefslogtreecommitdiffstats
path: root/core/core-engine/src/main/java/org/onap/policy/apex/core/engine/monitoring/EventMonitor.java
blob: ca564ca810c2b315995c8594db4ed2e8b045edc9 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 Bell Canada. 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.core.engine.monitoring;

import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * This class is used to monitor event parameter gets and sets.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class EventMonitor {
    // Logger for this class
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(EventMonitor.class);

    /**
     * Monitor get on an event parameter.
     *
     * @param eventParameter The event parameter to monitor
     * @param value the value of the event parameter
     * @param userArtifactStack the keys of the artifacts using the event at the moment
     */
    public void monitorGet(final AxField eventParameter, final Object value, final AxConcept[] userArtifactStack) {
        var monitorGetString = monitor("GET", userArtifactStack, eventParameter, value);
        LOGGER.trace(monitorGetString);
    }

    /**
     * Monitor set on an event parameter.
     *
     * @param eventParameter The event parameter to monitor
     * @param value the value of the event parameter
     * @param userArtifactStack the keys of the artifacts using the event at the moment
     */
    public void monitorSet(final AxField eventParameter, final Object value, final AxConcept[] userArtifactStack) {
        var monitorSetString = monitor("SET", userArtifactStack, eventParameter, value);
        LOGGER.trace(monitorSetString);
    }

    /**
     * Monitor remove on an event parameter.
     *
     * @param eventParameter The event parameter to monitor
     * @param removedValue the value of the event parameter
     * @param userArtifactStack the keys of the artifacts using the event at the moment
     */
    public void monitorRemove(final AxField eventParameter, final Object removedValue,
            final AxConcept[] userArtifactStack) {
        var monitorRemoveString = monitor("REMOVE", userArtifactStack, eventParameter, removedValue);
        LOGGER.trace(monitorRemoveString);
    }

    /**
     * Monitor the user artifact stack.
     *
     * @param preamble the preamble
     * @param userArtifactStack The user stack to print
     * @param eventParameter The event parameter that we are monitoring
     * @param value The value of the target object
     * @return the string
     */
    private String monitor(final String preamble, final AxConcept[] userArtifactStack, final AxField eventParameter,
            final Object value) {
        final var builder = new StringBuilder();

        builder.append(preamble);
        builder.append(",[");

        if (userArtifactStack != null) {
            var first = true;
            for (final AxConcept stackKey : userArtifactStack) {
                if (first) {
                    first = false;
                } else {
                    builder.append(',');
                }
                if (stackKey instanceof AxArtifactKey) {
                    builder.append(((AxArtifactKey) stackKey).getId());
                } else if (stackKey instanceof AxReferenceKey) {
                    builder.append(((AxReferenceKey) stackKey).getId());
                } else {
                    builder.append(stackKey.toString());
                }
            }
        }
        builder.append("],");

        builder.append(eventParameter.toString());
        builder.append("=");
        builder.append(value);

        return builder.toString();
    }
}