1 files changed, 104 insertions, 0 deletions
diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/KeyInfoMarshalFilter.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/KeyInfoMarshalFilter.java
new file mode 100644
index 000000000..41cf4df89
--- /dev/null
+++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/handling/KeyInfoMarshalFilter.java
@@ -0,0 +1,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;
+    }
+}