blob: db6995c51ff26d21a70d6d8de60d3d6252e61e70 (
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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2018 Ericsson. 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.parameters;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
/**
* The parameter service makes ONAP PF parameter groups available to all classes in a JVM.
*
* <p>The reason for having a parameter service is to avoid having to pass parameters down long call chains in modules
* such as PDPs and editors. The parameter service makes correct and verified parameters available statically.
*
* <p>The parameter service must be used with care because changing a parameter set anywhere in a JVM will affect all
* users of those parameters anywhere in the JVM.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public abstract class ParameterService {
// The map holding the parameters
private static Map<String, ParameterGroup> parameterGroupMap = new ConcurrentHashMap<>();
/**
* This class is an abstract static class that cannot be extended.
*/
private ParameterService() {
}
/**
* Register a parameter group with the parameter service.
*
* @param parameterGroup the parameter group
*/
public static void register(final ParameterGroup parameterGroup) {
if (!parameterGroupMap.containsKey(parameterGroup.getName())) {
parameterGroupMap.put(parameterGroup.getName(), parameterGroup);
} else {
throw new ParameterRuntimeException(
"\"" + parameterGroup.getName() + "\" already registered in parameter service");
}
}
/**
* Remove a parameter group from the parameter service.
*
* @param parameterGroupName the name of the parameter group
*/
public static void deregister(final String parameterGroupName) {
if (parameterGroupMap.containsKey(parameterGroupName)) {
parameterGroupMap.remove(parameterGroupName);
} else {
throw new ParameterRuntimeException("\"" + parameterGroupName + "\" not registered in parameter service");
}
}
/**
* Get a parameter group from the parameter service.
*
* @param parameterGroupName the name of the parameter group
* @return The parameter group
*/
public static ParameterGroup get(final String parameterGroupName) {
final ParameterGroup parameterGroup = parameterGroupMap.get(parameterGroupName);
if (parameterGroup == null) {
throw new ParameterRuntimeException("\"" + parameterGroupName + "\" not found in parameter service");
}
return parameterGroup;
}
/**
* Check if a parameter group is defined on the parameter service.
*
* @param parameterGroupName the name of the parameter group
* @return true if the parameter is defined
*/
public static boolean contains(final String parameterGroupName) {
return parameterGroupMap.containsKey(parameterGroupName) && parameterGroupMap.get(parameterGroupName) != null;
}
/**
* Get all parameter groups.
*
* @return The entries
*/
public static Set<Entry<String, ParameterGroup>> getAll() {
return parameterGroupMap.entrySet();
}
/**
* Clear all parameter groups in the parameter service.
*/
public static void clear() {
parameterGroupMap.clear();
}
}
|
