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
|
/*
* Copyright 2015 Open Networking Laboratory
*
* 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.
*/
package org.onosproject.net.config;
import com.fasterxml.jackson.databind.JsonNode;
import org.onosproject.store.Store;
import java.util.Set;
/**
* Mechanism for distributing and storing network configuration information.
*/
public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkConfigStoreDelegate> {
/**
* Adds a new configuration factory.
*
* @param configFactory configuration factory to add
*/
void addConfigFactory(ConfigFactory configFactory);
/**
* Removes a configuration factory.
*
* @param configFactory configuration factory to remove
*/
void removeConfigFactory(ConfigFactory configFactory);
/**
* Returns the configuration factory for the specified configuration class.
*
* @param configClass configuration class
* @param <S> type of subject
* @param <C> type of configuration
* @return configuration factory or null
*/
<S, C extends Config<S>> ConfigFactory<S, C> getConfigFactory(Class<C> configClass);
/**
* Returns set of subjects of the specified class, which have some
* network configuration associated with them.
*
* @param subjectClass subject class
* @param <S> type of subject
* @return set of subject
*/
<S> Set<S> getSubjects(Class<S> subjectClass);
/**
* Returns set of subjects of the specified class, which have the
* specified class of network configuration associated with them.
*
* @param subjectClass subject class
* @param configClass configuration class
* @param <S> type of subject
* @param <C> type of configuration
* @return set of subject
*/
<S, C extends Config<S>> Set<S> getSubjects(Class<S> subjectClass, Class<C> configClass);
/**
* Returns set of configuration classes available for the specified subject.
*
* @param subject configuration subject
* @param <S> type of subject
* @return set of configuration classes
*/
<S> Set<Class<? extends Config<S>>> getConfigClasses(S subject);
/**
* Get the configuration of the given class and for the specified subject.
*
* @param subject configuration subject
* @param configClass configuration class
* @param <S> type of subject
* @param <C> type of configuration
* @return configuration object
*/
<S, C extends Config<S>> C getConfig(S subject, Class<C> configClass);
/**
* Creates a new configuration of the given class for the specified subject.
*
* @param subject configuration subject
* @param configClass configuration class
* @param <S> type of subject
* @param <C> type of configuration
* @return configuration object
*/
<S, C extends Config<S>> C createConfig(S subject, Class<C> configClass);
/**
* Applies configuration for the specified subject and configuration
* class using the raw JSON object. If configuration already exists, it
* will be updated.
*
* @param subject configuration subject
* @param configClass configuration class
* @param json raw JSON node containing the configuration data
* @param <S> type of subject
* @param <C> type of configuration
* @return configuration object
* @throws IllegalArgumentException if the supplied JSON node contains
* invalid data
*/
<S, C extends Config<S>> C applyConfig(S subject, Class<C> configClass,
JsonNode json);
/**
* Clears the configuration of the given class for the specified subject.
*
* @param subject configuration subject
* @param configClass configuration class
* @param <S> type of subject
* @param <C> type of configuration
*/
<S, C extends Config<S>> void clearConfig(S subject, Class<C> configClass);
}
|
