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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019 Nordix Foundation.
* 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.model.policymodel.handling;
import java.util.Map.Entry;
import java.util.Set;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextAlbum;
import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicy;
import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
import org.onap.policy.apex.model.policymodel.concepts.AxState;
import org.onap.policy.apex.model.policymodel.concepts.AxStateOutput;
import org.onap.policy.apex.model.policymodel.concepts.AxTask;
import org.onap.policy.common.utils.validation.Assertions;
/**
* This class analyses a policy model and shows what the usage of each context album, context item, data type, and event
* is.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public class PolicyAnalyser {
/**
* Perform an analysis on a policy model.
*
* @param policyModel The policy model
* @return the analysis result of the policy model
*/
public PolicyAnalysisResult analyse(final AxPolicyModel policyModel) {
Assertions.argumentNotNull(policyModel, "policyModel may not be null");
final PolicyAnalysisResult result = new PolicyAnalysisResult(policyModel);
for (final AxPolicy policy : policyModel.getPolicies().getPolicyMap().values()) {
for (final AxState state : policy.getStateMap().values()) {
analyseState(state, result);
}
}
for (final AxTask task : policyModel.getTasks().getTaskMap().values()) {
analyseTask(task, result);
}
for (final AxEvent event : policyModel.getEvents().getEventMap().values()) {
analyseEvent(event, result);
}
for (final AxContextAlbum contextAlbum : policyModel.getAlbums().getAll(null)) {
result.getContextSchemaUsage().get(contextAlbum.getItemSchema()).add(contextAlbum.getKey());
}
return result;
}
/**
* Perform an analysis on a single policy in a policy model.
*
* @param policyModel The policy model
* @param policy The policy
* @return the analysis result of the policy model
*/
public PolicyAnalysisResult analyse(final AxPolicyModel policyModel, final AxPolicy policy) {
Assertions.argumentNotNull(policyModel, "policyModel may not be null");
Assertions.argumentNotNull(policy, "policy may not be null");
final PolicyAnalysisResult result = new PolicyAnalysisResult(policyModel);
for (final AxState state : policy.getStateMap().values()) {
analyseState(state, result);
}
// Only analyse tasks used by this policy
for (final Entry<AxArtifactKey, Set<AxKey>> taskUsageEntry : result.getTaskUsage().entrySet()) {
// If the usage set is empty, then we skip the task as its not used in the policy
if (!taskUsageEntry.getValue().isEmpty()) {
analyseTask(policyModel.getTasks().getTaskMap().get(taskUsageEntry.getKey()), result);
}
}
// Only analyse events used by this policy, same approach as for tasks
for (final Entry<AxArtifactKey, Set<AxKey>> eventUsageEntry : result.getEventUsage().entrySet()) {
if (!eventUsageEntry.getValue().isEmpty()) {
analyseEvent(policyModel.getEvents().getEventMap().get(eventUsageEntry.getKey()), result);
}
}
// Only analyse context albums used by this policy, same approach as for tasks
for (final Entry<AxArtifactKey, Set<AxKey>> contextAlbumUsageEntry : result.getContextAlbumUsage().entrySet()) {
if (!contextAlbumUsageEntry.getValue().isEmpty()) {
final AxContextAlbum contextAlbum = policyModel.getAlbums().get(contextAlbumUsageEntry.getKey());
result.getContextSchemaUsage().get(contextAlbum.getItemSchema()).add(contextAlbum.getKey());
}
}
for (final AxEvent event : policyModel.getEvents().getEventMap().values()) {
analyseEvent(event, result);
}
for (final AxContextAlbum contextAlbum : policyModel.getAlbums().getAll(null)) {
result.getContextSchemaUsage().get(contextAlbum.getItemSchema()).add(contextAlbum.getKey());
}
return result;
}
/**
* Analyse the usage of concepts by a state.
*
* @param state the state to analyse
* @param result the result
*/
private void analyseState(final AxState state, final PolicyAnalysisResult result) {
// Event usage by state
result.getEventUsage().get(state.getTrigger()).add(state.getKey());
for (final AxStateOutput stateOutput : state.getStateOutputs().values()) {
result.getEventUsage().get(stateOutput.getOutgoingEvent()).add(state.getKey());
}
// State Context Usage
for (final AxArtifactKey contextAlbumKey : state.getContextAlbumReferences()) {
result.getContextAlbumUsage().get(contextAlbumKey).add(state.getKey());
}
// Task usage by state
for (final AxArtifactKey task : state.getTaskReferences().keySet()) {
result.getTaskUsage().get(task).add(state.getKey());
}
}
/**
* Analyse the usage of concepts by a task.
*
* @param task the task to analyse
* @param result the result
*/
private void analyseTask(final AxTask task, final PolicyAnalysisResult result) {
// Task Context Usage
for (final AxArtifactKey contextAlbumKey : task.getContextAlbumReferences()) {
result.getContextAlbumUsage().get(contextAlbumKey).add(task.getKey());
}
}
/**
* Analyse the usage of concepts by an event.
*
* @param event the event to analyse
* @param result the result of the analysis
*/
private void analyseEvent(final AxEvent event, final PolicyAnalysisResult result) {
// Event data type usage
for (final AxField eventField : event.getFields()) {
result.getContextSchemaUsage().get(eventField.getSchema()).add(event.getKey());
}
}
}
|
