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;
24 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
25 import org.onap.policy.common.endpoints.parameters.TopicParameterGroup;
26 import org.onap.policy.common.parameters.GroupValidationResult;
27 import org.onap.policy.common.parameters.ParameterGroup;
28 import org.onap.policy.common.parameters.ValidationStatus;
29 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
32 * Class to hold all parameters needed for xacml pdp component.
35 public class XacmlPdpParameterGroup implements ParameterGroup {
36 private static final String PARAM_REST_SERVER = "restServerParameters";
37 private static final String PARAM_TOPIC_PARAMETER_GROUP = "topicParameterGroup";
38 private static final String PARAM_APPLICATION_PATH = "applicationPath";
40 private RestServerParameters restServerParameters;
41 private TopicParameterGroup topicParameterGroup;
42 private String applicationPath;
45 * Create the xacml pdp parameter group.
47 * @param name the parameter group name
49 public XacmlPdpParameterGroup(final String name, final RestServerParameters restServerParameters,
50 final TopicParameterGroup topicParameterGroup, final String applicationPath) {
52 this.restServerParameters = restServerParameters;
53 this.topicParameterGroup = topicParameterGroup;
54 this.applicationPath = applicationPath;
58 * Return the name of this parameter group instance.
60 * @return name the parameter group name
63 public String getName() {
68 * Set the name of this parameter group instance.
70 * @param name the parameter group name
73 public void setName(String name) {
78 * Return the restServerParameters of this parameter group instance.
80 * @return the restServerParameters
82 public RestServerParameters getRestServerParameters() {
83 return restServerParameters;
87 * Return the topicParameterGroup of this parameter group instance.
89 * @return the topicParameterGroup
91 public TopicParameterGroup getTopicParameterGroup() {
92 return topicParameterGroup;
96 * Returns the path where applications will store their data.
98 * @return String to the path
100 public String getApplicationPath() {
101 return applicationPath;
105 * Validate the parameter group.
107 * @return the result of the validation
110 public GroupValidationResult validate() {
111 final GroupValidationResult validationResult = new GroupValidationResult(this);
112 if (!ParameterValidationUtils.validateStringParameter(name)) {
113 validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
115 if (restServerParameters == null) {
116 validationResult.setResult(PARAM_REST_SERVER, ValidationStatus.INVALID,
117 "must have restServerParameters to configure xacml pdp rest server");
119 validationResult.setResult(PARAM_REST_SERVER, restServerParameters.validate());
121 if (topicParameterGroup == null) {
122 validationResult.setResult(PARAM_TOPIC_PARAMETER_GROUP, ValidationStatus.INVALID,
123 "must have topicParameterGroup to configure xacml pdp topic sink and source");
125 validationResult.setResult(PARAM_TOPIC_PARAMETER_GROUP, topicParameterGroup.validate());
128 // Validate the application path directory
130 if (applicationPath == null || applicationPath.isEmpty()) {
131 validationResult.setResult(PARAM_APPLICATION_PATH, ValidationStatus.INVALID,
132 "must have application path for applications to store policies and data.");
134 return validationResult;