summaryrefslogtreecommitdiffstats
path: root/artifactbroker/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/handling/sdc/SdcReceptionHandlerConfigurationParameterGroup.java
blob: 16cb6127587014bc4192b6c8b8f6e0c5e1ba46ab (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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Intel. 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.handling.sdc;

import java.util.List;

import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.utils.validation.ParameterValidationUtils;
import org.onap.policy.distribution.reception.parameters.ReceptionHandlerConfigurationParameterGroup;

/**
 * This class handles reading, parsing and validating of the Policy SDC Service Distribution parameters from Json
 * format, which strictly adheres to the interface:IConfiguration, defined by SDC SDK.
 */
public class SdcReceptionHandlerConfigurationParameterGroup extends ReceptionHandlerConfigurationParameterGroup {

    private final String sdcAddress;
    private final String user;
    private final String password;
    private final int pollingInterval;
    private final int pollingTimeout;
    private final int retryDelay;
    private final int httpsProxyPort;
    private final int httpProxyPort;
    private final String httpsProxyHost;
    private final String httpProxyHost;
    private final String consumerId;
    private final List<String> artifactTypes;
    private final String consumerGroup;
    private final String environmentName;
    private final String keyStorePath;
    private final String keyStorePassword;
    private final boolean activeServerTlsAuth;
    private final boolean isFilterInEmptyResources;
    private final boolean isUseHttpsWithSDC;

    /**
     * The constructor for instantiating {@link SdcReceptionHandlerConfigurationParameterGroup} class.
     *
     * @param builder the SDC configuration builder
     */
    public SdcReceptionHandlerConfigurationParameterGroup(
            final SdcReceptionHandlerConfigurationParameterBuilder builder) {
        sdcAddress = builder.getSdcAddress();
        user = builder.getUser();
        password = builder.getPassword();
        pollingInterval = builder.getPollingInterval();
        pollingTimeout = builder.getPollingTimeout();
        retryDelay = builder.getRetryDelay();
        httpsProxyPort = builder.getHttpsProxyPort();
        httpsProxyHost = builder.getHttpsProxyHost();
        httpProxyPort = builder.getHttpProxyPort();
        httpProxyHost = builder.getHttpProxyHost();
        consumerId = builder.getConsumerId();
        artifactTypes = builder.getArtifactTypes();
        consumerGroup = builder.getConsumerGroup();
        environmentName = builder.getEnvironmentName();
        keyStorePath = builder.getKeystorePath();
        keyStorePassword = builder.getKeystorePassword();
        activeServerTlsAuth = builder.isActiveserverTlsAuth();
        isFilterInEmptyResources = builder.isFilterinEmptyResources();
        isUseHttpsWithSDC = builder.getIsUseHttpsWithSDC();

    }

    public String getSdcAddress() {
        return sdcAddress;
    }

    public String getUser() {
        return user;
    }

    public String getPassword() {
        return password;
    }

    public int getPollingInterval() {
        return pollingInterval;
    }

    public int getPollingTimeout() {
        return pollingTimeout;
    }

    public int getRetryDelay() {
        return retryDelay;
    }

    public String getConsumerId() {
        return consumerId;
    }

    public List<String> getArtifactTypes() {
        return artifactTypes;
    }

    public String getConsumerGroup() {
        return consumerGroup;
    }

    public String getEnvironmentName() {
        return environmentName;
    }

    public String getKeyStorePassword() {
        return keyStorePassword;
    }

    public boolean isActiveServerTlsAuth() {
        return activeServerTlsAuth;
    }

    public String getKeyStorePath() {
        return keyStorePath;
    }

    public boolean isFilterInEmptyResources() {
        return isFilterInEmptyResources;
    }

    public boolean isUseHttpsWithSDC() {
        return isUseHttpsWithSDC;
    }

    public int getHttpsProxyPort() {
        return httpsProxyPort;
    }

    public String getHttpsProxyHost() {
        return httpsProxyHost;
    }

    public int getHttpProxyPort() {
        return httpProxyPort;
    }

    public String getHttpProxyHost() {
        return httpProxyHost;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public GroupValidationResult validate() {
        final GroupValidationResult validationResult = new GroupValidationResult(this);
        validateStringElement(validationResult, sdcAddress, "sdcAddress");
        validateStringElement(validationResult, user, "user");
        validateStringElement(validationResult, consumerId, "consumerId");
        validateStringElement(validationResult, consumerGroup, "consumerGroup");
        validateStringElement(validationResult, keyStorePath, "keyStorePath");
        validateStringElement(validationResult, keyStorePassword, "keyStorePassword");
        validateIntElement(validationResult, pollingInterval, "pollingInterval");
        validateIntElement(validationResult, pollingTimeout, "pollingTimeout");
        validateIntElement(validationResult, retryDelay, "retryDelay");
        validateStringListElement(validationResult, artifactTypes, "artifactTypes");
        return validationResult;
    }

    /**
     * Validate the integer Element.
     *
     * @param validationResult the result object
     * @param element the element to validate
     * @param elementName the element name for error message
     */
    private void validateIntElement(final GroupValidationResult validationResult, final int element,
            final String elementName) {
        if (!ParameterValidationUtils.validateIntParameter(element)) {
            validationResult.setResult(elementName, ValidationStatus.INVALID,
                    elementName + " must be a positive integer");
        }
    }

    /**
     * Validate the String List Element.
     *
     * @param validationResult the result object
     * @param element the element to validate
     * @param elementName the element name for error message
     */
    private void validateStringListElement(final GroupValidationResult validationResult, final List<String> element,
            final String elementName) {
        for (final String temp : element) {
            if (!ParameterValidationUtils.validateStringParameter(temp)) {
                validationResult.setResult(elementName, ValidationStatus.INVALID,
                        "the string of " + elementName + "must be a non-blank string");
            }
        }
    }

    /**
     * Validate the string element.
     *
     * @param validationResult the result object
     * @param element the element to validate
     * @param elementName the element name for error message
     */
    private void validateStringElement(final GroupValidationResult validationResult, final String element,
            final String elementName) {
        if (!ParameterValidationUtils.validateStringParameter(element)) {
            validationResult.setResult(elementName, ValidationStatus.INVALID,
                    elementName + " must be a non-blank string");
        }
    }
}