Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.cfg; |
| 17 | |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 19 | import org.onosproject.store.Store; |
| 20 | |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 21 | import java.util.Set; |
| 22 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 23 | /** |
| 24 | * Service for storing and distributing system-wide configurations for various |
| 25 | * software components. |
| 26 | */ |
| 27 | public interface ComponentConfigStore |
| 28 | extends Store<ComponentConfigEvent, ComponentConfigStoreDelegate> { |
| 29 | |
| 30 | /** |
| 31 | * Sets the value of the specified configuration property. |
| 32 | * |
| 33 | * @param componentName component name |
| 34 | * @param name property name |
| 35 | * @param value new property value |
| 36 | */ |
| 37 | void setProperty(String componentName, String name, String value); |
| 38 | |
| 39 | /** |
| 40 | * Clears the value of the specified configuration property thus making |
| 41 | * the property take on its default value. |
| 42 | * |
| 43 | * @param componentName component name |
| 44 | * @param name property name |
| 45 | */ |
| 46 | void unsetProperty(String componentName, String name); |
| 47 | |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 48 | |
| 49 | /** |
Thomas Vachuska | 611f466 | 2018-02-27 11:30:09 -0800 | [diff] [blame] | 50 | * Returns set of component configuration property names. This includes |
| 51 | * only the names of properties whose values depart from their default. |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 52 | * |
| 53 | * @param component component name |
Thomas Vachuska | 611f466 | 2018-02-27 11:30:09 -0800 | [diff] [blame] | 54 | * @return set of property names whose values are set to non-default values |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 55 | */ |
| 56 | default Set<String> getProperties(String component) { |
| 57 | return ImmutableSet.of(); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Returns the string value of the given component configuration property. |
Thomas Vachuska | 611f466 | 2018-02-27 11:30:09 -0800 | [diff] [blame] | 62 | * For properties whose values are set to their default this may return null. |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 63 | * |
| 64 | * @param component component name |
Thomas Vachuska | 611f466 | 2018-02-27 11:30:09 -0800 | [diff] [blame] | 65 | * @param name property name; null if no property found or if value |
| 66 | * is default |
Thomas Vachuska | 9f6bd52 | 2018-02-12 15:53:01 -0800 | [diff] [blame] | 67 | * @return set of property names |
| 68 | */ |
| 69 | default String getProperty(String component, String name) { |
| 70 | return null; |
| 71 | } |
| 72 | |
Thomas Vachuska | 6d697f1 | 2015-03-08 20:59:50 -0700 | [diff] [blame] | 73 | } |