2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
4 * Modifications Copyright (C) 2019 Nordix Foundation.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.pdpx.main.parameters;
26 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
27 import org.onap.policy.common.endpoints.parameters.TopicParameterGroup;
28 import org.onap.policy.common.parameters.GroupValidationResult;
29 import org.onap.policy.common.parameters.ParameterGroup;
30 import org.onap.policy.common.parameters.ValidationStatus;
31 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
34 * Class to hold all parameters needed for xacml pdp component.
38 public class XacmlPdpParameterGroup implements ParameterGroup {
39 private static final String PARAM_REST_SERVER = "restServerParameters";
40 private static final String PARAM_POLICY_API = "policyApiParameters";
41 private static final String PARAM_TOPIC_PARAMETER_GROUP = "topicParameterGroup";
42 private static final String PARAM_APPLICATION_PATH = "applicationPath";
47 private String pdpGroup;
48 private RestServerParameters restServerParameters;
49 private RestServerParameters policyApiParameters;
50 private TopicParameterGroup topicParameterGroup;
51 private String applicationPath;
54 * Create the xacml pdp parameter group.
56 * @param name the parameter group name
57 * @param pdpGroup the pdp group name
59 public XacmlPdpParameterGroup(final String name, final String pdpGroup,
60 final RestServerParameters restServerParameters, final RestServerParameters policyApiParameters,
61 final TopicParameterGroup topicParameterGroup, final String applicationPath) {
63 this.pdpGroup = pdpGroup;
64 this.restServerParameters = restServerParameters;
65 this.policyApiParameters = policyApiParameters;
66 this.topicParameterGroup = topicParameterGroup;
67 this.applicationPath = applicationPath;
71 * Validate the parameter group.
73 * @return the result of the validation
76 public GroupValidationResult validate() {
77 final GroupValidationResult validationResult = new GroupValidationResult(this);
78 if (!ParameterValidationUtils.validateStringParameter(name)) {
79 validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
81 if (!ParameterValidationUtils.validateStringParameter(pdpGroup)) {
82 validationResult.setResult("pdpGroup", ValidationStatus.INVALID, "must be a non-blank string");
84 if (restServerParameters == null) {
85 validationResult.setResult(PARAM_REST_SERVER, ValidationStatus.INVALID,
86 "must have restServerParameters to configure xacml pdp rest server");
88 validationResult.setResult(PARAM_REST_SERVER, restServerParameters.validate());
90 if (policyApiParameters == null) {
91 validationResult.setResult(PARAM_POLICY_API, ValidationStatus.INVALID,
92 "must have policyApiParameters to configure xacml pdp rest server");
94 // set the name - this only really matters for validation messages
95 policyApiParameters.setName(PARAM_POLICY_API);
96 validationResult.setResult(PARAM_POLICY_API, policyApiParameters.validate());
98 if (topicParameterGroup == null) {
99 validationResult.setResult(PARAM_TOPIC_PARAMETER_GROUP, ValidationStatus.INVALID,
100 "must have topicParameterGroup to configure xacml pdp topic sink and source");
102 validationResult.setResult(PARAM_TOPIC_PARAMETER_GROUP, topicParameterGroup.validate());
105 // Validate the application path directory
107 if (applicationPath == null || applicationPath.isEmpty()) {
108 validationResult.setResult(PARAM_APPLICATION_PATH, ValidationStatus.INVALID,
109 "must have application path for applications to store policies and data.");
111 return validationResult;