dcae-analytics-cdap-common/src/main/java/org/onap/dcae/apod/analytics/cdap/common/validation/CDAPAppSettingsValidator.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.onap.dcae.apod.analytics.cdap.common.validation;
  22
  23 import org.onap.dcae.apod.analytics.cdap.common.settings.CDAPAppSettings;
  24 import org.onap.dcae.apod.analytics.common.validation.DCAEValidator;
  25 import org.onap.dcae.apod.analytics.common.validation.ValidationResponse;
  26
  27 /**
  28  * <p>
  29  *     Validates CDAP Application Settings (AppConfig, Preferences etc)
  30  * <p>
  31  *
  32  * @param <T> {@link CDAPAppSettings} DCAE Analytics App Settings (e.g. AppConfig, Preferences)
  33  * @param <R> {@link ValidationResponse} Validator response implementations
  34  *
  35  * @author Rajiv Singla . Creation Date: 11/2/2016.
  36  */
  37 public interface CDAPAppSettingsValidator<T extends CDAPAppSettings, R extends ValidationResponse>
  38         extends DCAEValidator {
  39
  40     /**
  41      * Validates DCAE Analytics App Settings and return Validation response which can be
  42      * checked for any app setting issues
  43      *
  44      * @param appSettings DCAE CDAP Application Settings (e.g. AppConfig, Preferences etc.)
  45      * @return validation response
  46      */
  47     R validateAppSettings(T appSettings);
  48
  49
  50 }
  51
  52