aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-cdap-common/src/main/java/org/onap/dcae/apod/analytics/cdap/common/utils/ValidationUtils.java
blob: bfd7b3122fc8c58e939de470605fd7bd60b9d5f6 (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
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 AT&T Intellectual Property. 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.
 *  ============================LICENSE_END===========================================
 */

package org.onap.dcae.apod.analytics.cdap.common.utils;


import org.onap.dcae.apod.analytics.cdap.common.exception.CDAPSettingsException;
import org.onap.dcae.apod.analytics.cdap.common.settings.CDAPAppSettings;
import org.onap.dcae.apod.analytics.cdap.common.validation.CDAPAppSettingsValidator;
import org.onap.dcae.apod.analytics.common.validation.ValidationResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Utility methods to validate null checks, empty string etc
 *
 * @author Rajiv Singla . Creation Date: 10/24/2016.
 */
public abstract class ValidationUtils {

    private static final Logger LOG = LoggerFactory.getLogger(ValidationUtils.class);

    private ValidationUtils() {

    }

    /**
     * Checks if String is empty. For null string true is returned
     *
     * @param stringValue string value
     * @return returns true is string is empty or null
     */
    public static boolean isEmpty(@Nullable final String stringValue) {
        return stringValue == null || stringValue.isEmpty() || stringValue.trim().isEmpty();
    }


    /**
     * Checks if String value is present. A null, empty, or blank values of string
     * are considered not present.
     *
     * @param stringValue string value to check if it is present or not
     *
     * @return true if string value is not null, empty or blank
     */
    public static boolean isPresent(@Nullable final String stringValue) {
        return !isEmpty(stringValue);
    }


    /**
     * Provides common functionality to Validates CDAP App Settings. Throws Runtime exception if validation fails
     *
     * @param appSettings app Settings e.g. App Config, App Preferences etc
     * @param appSettingsValidator app Settings validator
     *
     * @param <T> Settings type e.g. AppConfig or AppPreferences
     * @param <R> Validation Response type
     * @param <V> Validator Type
     */
    public static <T extends CDAPAppSettings, R extends ValidationResponse,
            V extends CDAPAppSettingsValidator<T, R>> void validateSettings(@Nonnull final T appSettings,
                                                                            @Nonnull final V appSettingsValidator) {
        checkNotNull(appSettings, "App Settings must not be null");
        checkNotNull(appSettingsValidator, "App Settings validator must not be null");

        final String appSettingsClassName = appSettings.getClass().getSimpleName();
        final String appSettingsClassValidator = appSettingsValidator.getClass().getSimpleName();

        LOG.debug("Validating App Settings for: {}, with App Settings Validator: {} ",
                appSettingsClassName, appSettingsClassValidator);

        final R validationResponse = appSettingsValidator.validateAppSettings(appSettings);

        // If setting validation fails throw an exception
        if (validationResponse.hasErrors()) {
            throw new CDAPSettingsException(
                    validationResponse.getAllErrorMessage(), LOG, new IllegalArgumentException());
        }

        LOG.debug("App Settings Validation Successful for app Settings: {} with validator: {}", appSettingsClassName,
                appSettingsClassValidator);
    }

}