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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*
* ============LICENSE_START=======================================================
* policy-management
* ================================================================================
* Copyright (C) 2017-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.drools.persistence;
import java.nio.file.Path;
import java.util.List;
import java.util.Properties;
/**
* System Configuration.
*/
public interface SystemPersistence {
/**
* configuration directory.
*/
String DEFAULT_CONFIGURATION_DIR = "config";
/**
* Persistence Manager. For now it is a file-based properties management, In the future, it will
* probably be DB based, so manager implementation will change.
*/
SystemPersistence manager = new FileSystemPersistence();
/**
* sets a configuration directory and ensures it exists.
*
* @param configDir configuration directory or null to use the default one
*/
void setConfigurationDir(String configDir);
/**
* sets the default configuration directory and ensures it exists.
*/
void setConfigurationDir();
/**
* get configuration directory path.
*
* @return configuration directory path
*/
Path getConfigurationPath();
/**
* backs up a controller configuration.
*
* @param controllerName the controller name
* @return true if the configuration is backed up
*/
boolean backupController(String controllerName);
/**
* backs up a topic configuration.
*
* @param topicName the controller name
* @return true if the configuration is backed up
*/
boolean backupTopic(String topicName);
/**
* persists controller configuration.
*
* @param controllerName the controller name
* @param configuration object containing the configuration
*
* @return true if storage is succesful, false otherwise
* @throws IllegalArgumentException if the configuration cannot be handled by the persistence
* manager
*/
boolean storeController(String controllerName, Object configuration);
/**
* persists topic configuration.
*
* @param topicName the controller name
* @param configuration object containing the configuration
*
* @return true if storage is succesful, false otherwise
* @throws IllegalArgumentException if the configuration cannot be handled by the persistence
* manager
*/
boolean storeTopic(String topicName, Object configuration);
/**
* delete controller configuration.
*
* @param controllerName the controller name
* @return true if storage is succesful, false otherwise
*/
boolean deleteController(String controllerName);
/**
* delete topic configuration.
*
* @param topicName the topic name
* @return true if storage is succesful, false otherwise
*/
boolean deleteTopic(String topicName);
/**
* get controllers configuration.
*
* @return list of controllers properties
*/
List<Properties> getControllerProperties();
/**
* get controller properties.
*
* @param controllerName controller name
* @return properties for this controller
*
* @throws IllegalArgumentException if the controller name does not lead to a properties
* configuration
*/
Properties getControllerProperties(String controllerName);
/**
* get topic configuration.
*
* @return list of topic properties
*/
List<Properties> getTopicProperties();
/**
* get topic properties.
*
* @param topicName topic name
* @return properties for this topic
*
* @throws IllegalArgumentException if topicName is invalid
*/
Properties getTopicProperties(String topicName);
/**
* get environments.
*
*/
List<Properties> getEnvironmentProperties();
/**
* get environment properties.
*
* @param environmentName name
*/
Properties getEnvironmentProperties(String environmentName);
/**
* get the engine properties.
*
* @return the engine properties
*/
Properties getEngineProperties();
/**
* get properties by name.
*
* @param name name
* @return properties
*
* @throws IllegalArgumentException if the name does not lead to a properties configuration
*/
Properties getProperties(String name);
/**
* get system properties configuration.
*
* @param name name
* @return properties
*/
Properties getSystemProperties(String name);
/**
* get system properties configuration list.
*
* @return list of system properties
*/
List<Properties> getSystemProperties();
}
|
