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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* 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.driver;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.ImmutableMap.copyOf;
/**
* Default implementation of extensible driver.
*/
public class DefaultDriver implements Driver {
private final String name;
private final Driver parent;
private final String manufacturer;
private final String hwVersion;
private final String swVersion;
private final Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours;
private final Map<String, String> properties;
/**
* Creates a driver with the specified name.
*
* @param name driver name
* @param parent optional parent driver
* @param manufacturer device manufacturer
* @param hwVersion device hardware version
* @param swVersion device software version
* @param behaviours device behaviour classes
* @param properties properties for configuration of device behaviour classes
*/
public DefaultDriver(String name, Driver parent, String manufacturer,
String hwVersion, String swVersion,
Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours,
Map<String, String> properties) {
this.name = checkNotNull(name, "Name cannot be null");
this.parent = parent;
this.manufacturer = checkNotNull(manufacturer, "Manufacturer cannot be null");
this.hwVersion = checkNotNull(hwVersion, "HW version cannot be null");
this.swVersion = checkNotNull(swVersion, "SW version cannot be null");
this.behaviours = copyOf(checkNotNull(behaviours, "Behaviours cannot be null"));
this.properties = copyOf(checkNotNull(properties, "Properties cannot be null"));
}
@Override
public Driver merge(Driver other) {
checkArgument(parent == null || Objects.equals(parent, other.parent()),
"Parent drivers are not the same");
// Merge the behaviours.
Map<Class<? extends Behaviour>, Class<? extends Behaviour>>
behaviours = Maps.newHashMap();
behaviours.putAll(this.behaviours);
other.behaviours().forEach(b -> behaviours.put(b, other.implementation(b)));
// Merge the properties.
ImmutableMap.Builder<String, String> properties = ImmutableMap.builder();
properties.putAll(this.properties).putAll(other.properties());
return new DefaultDriver(name, other.parent(), manufacturer, hwVersion, swVersion,
ImmutableMap.copyOf(behaviours), properties.build());
}
@Override
public String name() {
return name;
}
@Override
public String manufacturer() {
return manufacturer;
}
@Override
public String hwVersion() {
return hwVersion;
}
@Override
public String swVersion() {
return swVersion;
}
@Override
public Driver parent() {
return parent;
}
@Override
public Set<Class<? extends Behaviour>> behaviours() {
return behaviours.keySet();
}
@Override
public Class<? extends Behaviour> implementation(Class<? extends Behaviour> behaviour) {
return behaviours.get(behaviour);
}
@Override
public boolean hasBehaviour(Class<? extends Behaviour> behaviourClass) {
return behaviours.containsKey(behaviourClass) ||
(parent != null && parent.hasBehaviour(behaviourClass));
}
@Override
public <T extends Behaviour> T createBehaviour(DriverData data,
Class<T> behaviourClass) {
T behaviour = createBehaviour(data, null, behaviourClass);
if (behaviour != null) {
return behaviour;
} else if (parent != null) {
return parent.createBehaviour(data, behaviourClass);
}
throw new IllegalArgumentException(behaviourClass.getName() + " not supported");
}
@Override
public <T extends Behaviour> T createBehaviour(DriverHandler handler,
Class<T> behaviourClass) {
T behaviour = createBehaviour(handler.data(), handler, behaviourClass);
if (behaviour != null) {
return behaviour;
} else if (parent != null) {
return parent.createBehaviour(handler, behaviourClass);
}
throw new IllegalArgumentException(behaviourClass.getName() + " not supported");
}
// Creates an instance of behaviour primed with the specified driver data.
private <T extends Behaviour> T createBehaviour(DriverData data, DriverHandler handler,
Class<T> behaviourClass) {
//checkArgument(handler != null || !HandlerBehaviour.class.isAssignableFrom(behaviourClass),
// "{} is applicable only to handler context", behaviourClass.getName());
// Locate the implementation of the requested behaviour.
Class<? extends Behaviour> implementation = behaviours.get(behaviourClass);
if (implementation != null) {
// Create an instance of the behaviour and apply data as its context.
T behaviour = createBehaviour(behaviourClass, implementation);
behaviour.setData(data);
// If this is a handler behaviour, also apply handler as its context.
if (handler != null) {
((HandlerBehaviour) behaviour).setHandler(handler);
}
return behaviour;
}
return null;
}
@SuppressWarnings("unchecked")
private <T extends Behaviour> T createBehaviour(Class<T> behaviourClass,
Class<? extends Behaviour> implementation) {
try {
return (T) implementation.newInstance();
} catch (InstantiationException | IllegalAccessException e) {
// TODO: add a specific unchecked exception
throw new IllegalArgumentException("Unable to create behaviour", e);
}
}
@Override
public Set<String> keys() {
return properties.keySet();
}
@Override
public String value(String key) {
return properties.get(key);
}
@Override
public Map<String, String> properties() {
return properties;
}
@Override
public String toString() {
return toStringHelper(this)
.add("name", name)
.add("parent", parent)
.add("manufacturer", manufacturer)
.add("hwVersion", hwVersion)
.add("swVersion", swVersion)
.add("behaviours", behaviours)
.add("properties", properties)
.toString();
}
}
|
