blob: 41cf4df89f503643554e8e3a573588a4fdb27a6a (
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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019 Nordix Foundation.
* ================================================================================
* 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.basicmodel.handling;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import javax.xml.bind.annotation.adapters.XmlAdapter;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInfo;
import org.onap.policy.apex.model.basicmodel.concepts.AxKeyInformation;
/**
* This class implements a filter to prevent some keyinfo information being marshalled when a model is serialised.
*/
public class KeyInfoMarshalFilter extends XmlAdapter<AxKeyInformation, AxKeyInformation> {
private List<AxKey> filterList = new LinkedList<>();
/**
* Adds a key to the list to be filtered.
*
* @param key the key to add to the filter list
*/
public void addFilterKey(AxKey key) {
filterList.add(key);
}
/**
* Remove a key from the list to be filtered.
*
* @param key the key to remove from the filter list
* @return true if the passed key was in the filter list and has been removed.
*/
public boolean removeFilterKey(AxKey key) {
return filterList.remove(key);
}
/**
* Adds some keys to the list to be filtered.
*
* @param keys the keys to add to the filter list
*/
public void addFilterKeys(Collection<? extends AxKey> keys) {
filterList.addAll(keys);
}
/**
* Decide whether to unmarshall some keyinfos - Always.
*
* @param val the keyinfo
* @return the keyinfo
* @throws Exception if there is some problem unmarshalling
* @see javax.xml.bind.annotation.adapters.XmlAdapter#unmarshal(Object)
*/
@Override
public AxKeyInformation unmarshal(AxKeyInformation val) throws Exception {
return val;
}
/**
* Select which keyinfo entries will be marshalled - i.e. those not in the filter list.
*
* @param val the keyinfo
* @return the keyinfo
* @throws Exception if there is some problem with the marshalling
* @see javax.xml.bind.annotation.adapters.XmlAdapter#marshal(Object)
*/
@Override
public AxKeyInformation marshal(AxKeyInformation val) throws Exception {
if (val == null || val.getKeyInfoMap() == null || val.getKeyInfoMap().isEmpty() || filterList.isEmpty() ) {
return val;
}
//create a new keyinfo clone to avoid removing keyinfo entries from the original model
AxKeyInformation ret = new AxKeyInformation(val);
Map<AxArtifactKey, AxKeyInfo> retmap = new TreeMap<>(ret.getKeyInfoMap());
for (AxKey key : filterList) {
retmap.remove(key);
}
ret.setKeyInfoMap(retmap);
return ret;
}
}
|
