main/src/main/java/org/onap/policy/pdpx/main/parameters/XacmlPdpParameterGroup.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pdpx.main.parameters;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ParameterGroup;
  25 import org.onap.policy.common.parameters.ValidationStatus;
  26 import org.onap.policy.common.utils.validation.ParameterValidationUtils;
  27
  28 /**
  29  * Class to hold all parameters needed for xacml pdp component.
  30  *
  31  */
  32 public class XacmlPdpParameterGroup implements ParameterGroup {
  33     private String name;
  34     private RestServerParameters restServerParameters;
  35
  36     /**
  37      * Create the xacml pdp parameter group.
  38      *
  39      * @param name the parameter group name
  40      */
  41     public XacmlPdpParameterGroup(final String name, final RestServerParameters restServerParameters) {
  42         this.name = name;
  43         this.restServerParameters = restServerParameters;
  44     }
  45
  46     /**
  47      * Return the name of this parameter group instance.
  48      *
  49      * @return name the parameter group name
  50      */
  51     @Override
  52     public String getName() {
  53         return name;
  54     }
  55
  56     /**
  57      * Set the name of this parameter group instance.
  58      *
  59      * @param name the parameter group name
  60      */
  61     @Override
  62     public void setName(String name) {
  63         this.name = name;
  64     }
  65
  66     /**
  67      * Return the restServerParameters of this parameter group instance.
  68      *
  69      * @return the restServerParameters
  70      */
  71     public RestServerParameters getRestServerParameters() {
  72         return restServerParameters;
  73     }
  74
  75     /**
  76      * Validate the parameter group.
  77      *
  78      * @return the result of the validation
  79      */
  80     @Override
  81     public GroupValidationResult validate() {
  82         final GroupValidationResult validationResult = new GroupValidationResult(this);
  83         if (!ParameterValidationUtils.validateStringParameter(name)) {
  84             validationResult.setResult("name", ValidationStatus.INVALID, "must be a non-blank string");
  85         }
  86         if (restServerParameters == null) {
  87             validationResult.setResult("restServerParameters", ValidationStatus.INVALID,
  88                     "must have restServerParameters to configure xacml pdp rest server");
  89         } else {
  90             validationResult.setResult("restServerParameters", restServerParameters.validate());
  91         }
  92         return validationResult;
  93     }
  94 }