aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/utils/PropertyUtils.java
blob: 265346c909af2c6dcacc4646e776bf3691999f2a (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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2019 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.policy.common.endpoints.utils;

import java.util.Properties;
import org.apache.commons.lang3.StringUtils;

/**
 * Utilities for extracting property values and converting them to other types.
 */
public class PropertyUtils {
    /**
     * Properties on which to work.
     */
    private Properties properties;

    /**
     * Prefix to prepend to property names.
     */
    private String prefix;

    /**
     * Function to invoke if a property value is invalid.
     */
    private TriConsumer<String, String, Exception> invalidHandler;


    /**
     * Constructs the object.
     *
     * @param properties properties on which to work
     * @param prefix prefix to prepend to property names
     * @param invalidHandler function to invoke if a property value is invalid
     */
    public PropertyUtils(Properties properties, String prefix, TriConsumer<String, String, Exception> invalidHandler) {
        this.properties = properties;
        this.prefix = prefix;
        this.invalidHandler = invalidHandler;
    }

    /**
     * Gets a string property.
     *
     * @param propName name of the property whose value is to be retrieved
     * @param defaultValue value to use if the property value is empty or does not exist
     * @return the property's value
     */
    public String getString(String propName, String defaultValue) {
        String propValue = getProperty(propName);
        return (StringUtils.isBlank(propValue) ? defaultValue : propValue);
    }

    /**
     * Gets a boolean property.
     *
     * @param propName name of the property whose value is to be retrieved
     * @param defaultValue value to use if the property value is empty or does not exist
     * @return the property's value
     */
    public boolean getBoolean(String propName, boolean defaultValue) {
        String propValue = getProperty(propName);

        if (!StringUtils.isBlank(propValue)) {
            return Boolean.parseBoolean(propValue);
        }

        return defaultValue;
    }

    /**
     * Gets an integer property.
     *
     * @param propName name of the property whose value is to be retrieved
     * @param defaultValue value to use if the property value is empty or does not exist
     * @return the property's value
     */
    public int getInteger(String propName, int defaultValue) {
        String propValue = getProperty(propName);

        if (!StringUtils.isBlank(propValue)) {
            try {
                return Integer.parseInt(propValue);

            } catch (NumberFormatException nfe) {
                invalidHandler.accept(getFullName(propName), propValue, nfe);
            }
        }

        return defaultValue;
    }


    /**
     * Gets a property's value.
     *
     * @param propName name of the property whose value is to be retrieved
     * @return the property's value, or {@code null} if it does not exist
     */
    private String getProperty(String propName) {
        return properties.getProperty(getFullName(propName));
    }

    /**
     * Gets the full property name, with the prefix prepended.
     *
     * @param propName property name, without the prefix
     * @return the full property name
     */
    private String getFullName(String propName) {
        return prefix + propName;
    }

    @FunctionalInterface
    public static interface TriConsumer<A,B,C> {
        public void accept(A propName, B propValue, C exception);
    }
}