aboutsummaryrefslogtreecommitdiffstats
path: root/reception/src/main/java/org/onap/policy/distribution/reception/parameters/ReceptionHandlerParameters.java
blob: 3839c4497a96721a5dcdd6a2a22057e9d15ff821 (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
/*-
 * ============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 org.onap.policy.common.logging.flexlogger.FlexLogger;
import org.onap.policy.common.logging.flexlogger.Logger;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterGroup;
import org.onap.policy.common.parameters.ValidationStatus;

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

    private static final Logger LOGGER = FlexLogger.getLogger(ReceptionHandlerParameters.class);

    private String name;
    private String receptionHandlerType;
    private String receptionHandlerClassName;
    private String receptionHandlerConfigurationName;
    private PluginHandlerParameters pluginHandlerParameters;

    /**
     * Constructor for instantiating ReceptionHandlerParameters.
     *
     * @param receptionHandlerType the reception handler type
     * @param receptionHandlerClassName the reception handler class name
     * @param receptionHandlerConfigurationName the name of the configuration for the reception
     *        handler
     * @param pluginHandlerParameters the plugin handler parameters
     */
    public ReceptionHandlerParameters(final String receptionHandlerType, final String receptionHandlerClassName,
            final String receptionHandlerConfigurationName, final PluginHandlerParameters pluginHandlerParameters) {
        this.receptionHandlerType = receptionHandlerType;
        this.receptionHandlerClassName = receptionHandlerClassName;
        this.receptionHandlerConfigurationName = receptionHandlerConfigurationName;
        this.pluginHandlerParameters = pluginHandlerParameters;
    }

    /**
     * Return the receptionHandlerType of this ReceptionHandlerParameters instance.
     *
     * @return the receptionHandlerType
     */
    public String getReceptionHandlerType() {
        return receptionHandlerType;
    }

    /**
     * Return the receptionHandlerClassName of this ReceptionHandlerParameters instance.
     *
     * @return the receptionHandlerClassName
     */
    public String getReceptionHandlerClassName() {
        return receptionHandlerClassName;
    }

    /**
     * Return the name of the reception handler configuration for this ReceptionHandlerParameters
     * instance.
     *
     * @return the PssdConfigurationParametersGroup
     */
    public String getReceptionHandlerConfigurationName() {
        return receptionHandlerConfigurationName;
    }

    /**
     * Return the pluginHandlerParameters of this ReceptionHandlerParameters instance.
     *
     * @return the pluginHandlerParameters
     */
    public PluginHandlerParameters getPluginHandlerParameters() {
        return pluginHandlerParameters;
    }

    @Override
    public String getName() {
        return name + "_" + receptionHandlerType;
    }

    /**
     * Validate the reception handler parameters.
     *
     */
    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);
        if (receptionHandlerType == null || receptionHandlerType.trim().length() == 0) {
            validationResult.setResult("receptionHandlerType", ValidationStatus.INVALID, "must be a non-blank string");
        }
        if (receptionHandlerClassName == null || receptionHandlerClassName.trim().length() == 0) {
            validationResult.setResult("receptionHandlerClassName", ValidationStatus.INVALID,
                    "must be a non-blank string containing full class name of the reception handler");
        } else {
            validateReceptionHandlerClass(validationResult);
        }
        if (pluginHandlerParameters == null) {
            validationResult.setResult("pluginHandlerParameters", ValidationStatus.INVALID,
                    "must have a plugin handler");
        } else {
            validationResult.setResult("pluginHandlerParameters", pluginHandlerParameters.validate());
        }
        return validationResult;
    }

    private void validateReceptionHandlerClass(final GroupValidationResult validationResult) {
        try {
            Class.forName(receptionHandlerClassName);
        } catch (final ClassNotFoundException exp) {
            LOGGER.error("reception handler class not found in classpath", exp);
            validationResult.setResult("receptionHandlerClassName", ValidationStatus.INVALID,
                    "reception handler class not found in classpath");
        }
    }

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