aboutsummaryrefslogtreecommitdiffstats
path: root/reception/src/main/java/org/onap/policy/distribution/reception/parameters/PluginHandlerParameters.java
blob: bd0ad900311d703da339e891684bb0449b9b13b7 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 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.distribution.reception.parameters;

import java.util.Map;
import java.util.Map.Entry;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.distribution.forwarding.parameters.PolicyForwarderParameters;

/**
 * Class to hold all the plugin handler parameters.
 *
 * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
 */
public class PluginHandlerParameters implements ParameterGroup {

    private static final String PLUGIN_HANDLER = "_PluginHandler";

    private String name;
    private Map<String, PolicyDecoderParameters> policyDecoders;
    private Map<String, PolicyForwarderParameters> policyForwarders;

    /**
     * Constructor for instantiating PluginHandlerParameters.
     *
     * @param policyDecoders the map of policy decoders
     * @param policyForwarders the map of policy forwarders
     */
    public PluginHandlerParameters(final Map<String, PolicyDecoderParameters> policyDecoders,
            final Map<String, PolicyForwarderParameters> policyForwarders) {
        this.policyDecoders = policyDecoders;
        this.policyForwarders = policyForwarders;
    }

    /**
     * Return the policyDecoders of this PluginHandlerParameters instance.
     *
     * @return the policyDecoders
     */
    public Map<String, PolicyDecoderParameters> getPolicyDecoders() {
        return policyDecoders;
    }

    /**
     * Return the policyForwarders of this PluginHandlerParameters instance.
     *
     * @return the policyForwarders
     */
    public Map<String, PolicyForwarderParameters> getPolicyForwarders() {
        return policyForwarders;
    }

    @Override
    public String getName() {
        return name + PLUGIN_HANDLER;
    }

    /**
     * Validate the plugin handler parameters.
     *
     */
    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);
        if (policyDecoders == null || policyDecoders.size() == 0) {
            validationResult.setResult("policyDecoders", ValidationStatus.INVALID,
                    "must have at least one policy decoder");
        } else {
            for (final Entry<String, PolicyDecoderParameters> nestedGroupEntry : policyDecoders.entrySet()) {
                validationResult.setResult("policyDecoders", nestedGroupEntry.getKey(),
                        nestedGroupEntry.getValue().validate());
            }
        }
        if (policyForwarders == null || policyForwarders.size() == 0) {
            validationResult.setResult("policyForwarders", ValidationStatus.INVALID,
                    "must have at least one policy forwarder");
        } else {
            for (final Entry<String, PolicyForwarderParameters> nestedGroupEntry : policyForwarders.entrySet()) {
                validationResult.setResult("policyForwarders", nestedGroupEntry.getKey(),
                        nestedGroupEntry.getValue().validate());
            }
        }
        return validationResult;
    }

    /**
     * Set the name of this group.
     *
     * @param name the name to set.
     */
    @Override
    public void setName(final String name) {
        this.name = name;
    }
}