aboutsummaryrefslogtreecommitdiffstats
path: root/context/context-management/src/main/java/org/onap/policy/apex/context/monitoring/ContextMonitor.java
blob: 8e34ecb1bc5874d6751f36c78d9cebc3aa303fa4 (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. 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.context.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.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * This class is used to monitor context creates, deletes, gets, sets, locks and unlocks on context items in Apex
 * context albums.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class ContextMonitor {
    // Logger for this class
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(ContextMonitor.class);

    /**
     * Monitor an initiation on a context item.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param value The value of the item
     */
    public void monitorInit(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final Object value) {
        LOGGER.trace(monitor("INIT", null, albumKey, schemaKey, name, value));
    }

    /**
     * Monitor an initiation on a context item.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param value The value of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorInit(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final Object value, final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("INIT", userArtifactStack, albumKey, schemaKey, name, value));
    }

    /**
     * Monitor a deletion on a context item.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param value The value of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorDelete(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final Object value, final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("DEL", userArtifactStack, albumKey, schemaKey, name, value));
    }

    /**
     * Monitor get on a context item.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param value The value of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorGet(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final Object value, final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("GET", userArtifactStack, albumKey, schemaKey, name, value));
    }

    /**
     * Monitor set on a context item.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param value The value of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorSet(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final Object value, final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("SET", userArtifactStack, albumKey, schemaKey, name, value));
    }

    /**
     * Monitor a read lock on a key.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorReadLock(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("READLOCK", userArtifactStack, albumKey, schemaKey, name, null));
    }

    /**
     * Monitor a write lock on a key.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorWriteLock(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("WRITELOCK", userArtifactStack, albumKey, schemaKey, name, null));
    }

    /**
     * Monitor a read unlock on a key.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorReadUnlock(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("READUNLOCK", userArtifactStack, albumKey, schemaKey, name, null));
    }

    /**
     * Monitor a write unlock on a key.
     *
     * @param albumKey The item album
     * @param schemaKey The item schema
     * @param name The name of the item
     * @param userArtifactStack the keys of the artifacts using the context map at the moment
     */
    public void monitorWriteUnlock(final AxArtifactKey albumKey, final AxArtifactKey schemaKey, final String name,
            final AxConcept[] userArtifactStack) {
        LOGGER.trace(monitor("WRITEUNLOCK", userArtifactStack, albumKey, schemaKey, name, null));
    }

    /**
     * Monitor the user artifact stack.
     *
     * @param preamble the preamble
     * @param userArtifactStack The user stack to print
     * @param albumKey the album key
     * @param schemaKey the schema key
     * @param name the name
     * @param value the value
     * @return the string
     */
    private String monitor(final String preamble, final AxConcept[] userArtifactStack, final AxArtifactKey albumKey,
            final AxArtifactKey schemaKey, final String name, final Object value) {
        final StringBuilder builder = new StringBuilder();

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

        if (userArtifactStack != null) {
            boolean 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(albumKey.getID());
        builder.append(',');
        builder.append(schemaKey.getID());
        builder.append(',');
        builder.append(name);

        if (value != null) {
            builder.append(',');
            builder.append(value.toString());
        }

        return builder.toString();
    }
}