aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/distribution/main/parameters/RestServerParameters.java
blob: 4685b7d1b28136f5b29d9a4f30e45c3fb2dba07f (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
148
149
150
/*-
 * ============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.main.parameters;

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.common.utils.validation.ParameterValidationUtils;

/**
 * Class to hold all parameters needed for distribution rest server.
 *
 * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
 */
public class RestServerParameters implements ParameterGroup {
    private String name;
    private String host;
    private int port;
    private String userName;
    private String password;
    private boolean https;

    /**
     * Constructor for instantiating RestServerParameters.
     *
     * @param host the host name
     * @param port the port
     * @param userName the user name
     * @param password the password
     * @param https the https
     */
    public RestServerParameters(final String host, final int port, final String userName, final String password,
                                final boolean https) {
        super();
        this.host = host;
        this.port = port;
        this.userName = userName;
        this.password = password;
        this.https = https;
    }

    /**
     * Return the name of this RestServerParameters instance.
     *
     * @return name the name of this RestServerParameters
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * Return the host of this RestServerParameters instance.
     *
     * @return the host
     */
    public String getHost() {
        return host;
    }

    /**
     * Return the port of this RestServerParameters instance.
     *
     * @return the port
     */
    public int getPort() {
        return port;
    }

    /**
     * Return the user name of this RestServerParameters instance.
     *
     * @return the userName
     */
    public String getUserName() {
        return userName;
    }

    /**
     * Return the password of this RestServerParameters instance.
     *
     * @return the password
     */
    public String getPassword() {
        return password;
    }

    /**
     * Return the https of this RestServerParameters instance.
     *
     * @return the password
     */
    public boolean isHttps() {
        return https;
    }

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

    /**
     * Validate the rest server parameters.
     *
     * @return the result of the validation
     */
    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);
        if (!ParameterValidationUtils.validateStringParameter(host)) {
            validationResult.setResult("host", ValidationStatus.INVALID,
                    "must be a non-blank string containing hostname/ipaddress of the distribution rest server");
        }
        if (!ParameterValidationUtils.validateStringParameter(userName)) {
            validationResult.setResult("userName", ValidationStatus.INVALID,
                    "must be a non-blank string containing userName for distribution rest server credentials");
        }
        if (!ParameterValidationUtils.validateStringParameter(password)) {
            validationResult.setResult("password", ValidationStatus.INVALID,
                    "must be a non-blank string containing password for distribution rest server credentials");
        }
        if (!ParameterValidationUtils.validateIntParameter(port)) {
            validationResult.setResult("port", ValidationStatus.INVALID,
                    "must be a positive integer containing port of the distribution rest server");
        }
        return validationResult;
    }
}