aboutsummaryrefslogtreecommitdiffstats
path: root/runtime-controlloop/src/main/java/org/onap/policy/clamp/controlloop/runtime/main/parameters/ClRuntimeParameterHandler.java
blob: a463ad1719bcb01874399f6abb7a2219d858fb78 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2021 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.clamp.controlloop.runtime.main.parameters;

import java.io.File;
import javax.ws.rs.core.Response;
import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
import org.onap.policy.clamp.controlloop.runtime.main.startstop.ClRuntimeCommandLineArguments;
import org.onap.policy.common.parameters.ValidationResult;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;

/**
 * This class handles reading, parsing and validating of control loop runtime parameters from JSON files.
 */
public class ClRuntimeParameterHandler {

    private static final Coder CODER = new StandardCoder();

    /**
     * Read the parameters from the parameter file.
     *
     * @param arguments the arguments passed to control loop runtime
     * @return the parameters read from the configuration file
     * @throws ControlLoopException on parameter exceptions
     */
    public ClRuntimeParameterGroup getParameters(final ClRuntimeCommandLineArguments arguments)
            throws ControlLoopException {
        ClRuntimeParameterGroup clRuntimeParameterGroup = null;

        // Read the parameters
        try {
            // Read the parameters from JSON
            File file = new File(arguments.getFullConfigurationFilePath());
            clRuntimeParameterGroup = CODER.decode(file, ClRuntimeParameterGroup.class);
        } catch (final CoderException e) {
            throw new ControlLoopException(
                    Response.Status.NOT_ACCEPTABLE, "error reading parameters from \""
                            + arguments.getConfigurationFilePath() + "\"\n" + "(" + e.getClass().getSimpleName() + ")",
                    e);
        }

        // The JSON processing returns null if there is an empty file
        if (clRuntimeParameterGroup == null) {
            throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE,
                    "no parameters found in \"" + arguments.getConfigurationFilePath() + "\"");
        }

        // validate the parameters
        final ValidationResult validationResult = clRuntimeParameterGroup.validate();
        if (!validationResult.isValid()) {
            throw new ControlLoopException(Response.Status.NOT_ACCEPTABLE, "validation error(s) on parameters from \""
                    + arguments.getConfigurationFilePath() + "\"\n" + validationResult.getResult());
        }

        return clRuntimeParameterGroup;
    }
}