/
KapuaConfigurableService.java
61 lines (54 loc) · 2.03 KB
/
KapuaConfigurableService.java
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
/*******************************************************************************
* Copyright (c) 2016, 2022 Eurotech and/or its affiliates and others
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Eurotech - initial API and implementation
*******************************************************************************/
package org.eclipse.kapua.service.config;
import org.eclipse.kapua.KapuaException;
import org.eclipse.kapua.model.config.metatype.KapuaTocd;
import org.eclipse.kapua.model.id.KapuaId;
import org.eclipse.kapua.service.KapuaService;
import java.util.Map;
/**
* Configurable {@link KapuaService} definition.
* <p>
* Identifies a {@link KapuaService} with per-scope configurations
*
* @since 1.0.0
*/
public interface KapuaConfigurableService {
/**
* Gets the {@link KapuaTocd} for the given scope {@link KapuaId}.
*
* @param scopeId The scope {@link KapuaId}.
* @return The {@link KapuaTocd} for the given scope {@link KapuaId}.
* @throws KapuaException
* @since 1.0.0
*/
KapuaTocd getConfigMetadata(KapuaId scopeId) throws KapuaException;
/**
* Gets the {@link Map} properties values for the given scope {@link KapuaId}.
*
* @param scopeId The scope {@link KapuaId}.
* @return The {@link Map} properties values for the given scope {@link KapuaId}.
* @throws KapuaException
* @since 1.0.0
*/
Map<String, Object> getConfigValues(KapuaId scopeId) throws KapuaException;
/**
* Updates the {@link Map} properties values for the given scope {@link KapuaId}.
*
* @param scopeId The scope {@link KapuaId}.
* @param values The {@link Map} properties values to update
* @throws KapuaException
* @since 1.0.0
*/
void setConfigValues(KapuaId scopeId, KapuaId parentId, Map<String, Object> values) throws KapuaException;
}