ConfigFlowRuleProgrammable
- FlowRuleProgrammable implementation which acts as it has accepted any FlowRule request.
-- To be used for a device which exist in-line transparently (e.g., Amplifier ONOS-6067)
Change-Id: Ief09297eb900b804b1c8eb4d6705bbad85a552ad
diff --git a/drivers/optical/src/main/java/org/onosproject/driver/optical/config/ConfigFlowRuleProgrammable.java b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/ConfigFlowRuleProgrammable.java
new file mode 100644
index 0000000..8675d32
--- /dev/null
+++ b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/ConfigFlowRuleProgrammable.java
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2017-present 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.driver.optical.config;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+import java.util.Collection;
+import java.util.LinkedHashSet;
+import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.config.NetworkConfigService;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.net.flow.DefaultFlowEntry;
+import org.onosproject.net.flow.FlowEntry;
+import org.onosproject.net.flow.FlowRule;
+import org.onosproject.net.flow.FlowRuleProgrammable;
+
+import com.google.common.annotations.Beta;
+import com.google.common.collect.ImmutableSet;
+
+import org.onosproject.net.flow.FlowEntry.FlowEntryState;
+import org.slf4j.Logger;
+
+// TODO consider relocating
+/**
+ * {@link FlowRuleProgrammable} which pretends it accepted the requests.
+ *
+ * Can be useful, when you need to send totally different flow rules
+ * down to the Device.
+ */
+@Beta
+public class ConfigFlowRuleProgrammable
+ extends AbstractHandlerBehaviour
+ implements FlowRuleProgrammable {
+
+ private static final Logger log = getLogger(ConfigFlowRuleProgrammable.class);
+
+
+ @Override
+ public Collection<FlowEntry> getFlowEntries() {
+ Set<FlowRule> flowtable = getFlowTable(getFlowTableConfig());
+ return flowtable.stream()
+ .map(fr -> new DefaultFlowEntry(fr, FlowEntryState.ADDED))
+ .collect(Collectors.toList());
+ }
+
+ @Override
+ public Collection<FlowRule> applyFlowRules(Collection<FlowRule> rules) {
+ log.trace("applyFlowRules: {}", rules);
+
+ Optional<FlowTableConfig> config = createFlowTableConfig();
+ Set<FlowRule> table = new LinkedHashSet<>(getFlowTable(config));
+ table.addAll(rules);
+ config.map(cfg -> cfg.flowtable(table))
+ .ifPresent(cfg -> cfg.apply());
+ log.trace("Updated flowtable: {}", table);
+ return table;
+ }
+
+ @Override
+ public Collection<FlowRule> removeFlowRules(Collection<FlowRule> rules) {
+ log.trace("removeFlowRules: {}", rules);
+ Optional<FlowTableConfig> config = getFlowTableConfig();
+ Set<FlowRule> table = new LinkedHashSet<>(getFlowTable(config));
+ table.removeAll(rules);
+ config.map(cfg -> cfg.flowtable(table))
+ .ifPresent(cfg -> cfg.apply());
+ log.trace("Updated flowtable: {}", table);
+ return table;
+ }
+
+ private Set<FlowRule> getFlowTable(Optional<FlowTableConfig> cfg) {
+ Set<FlowRule> flowtable = cfg
+ .map(FlowTableConfig::flowtable)
+ .orElse(ImmutableSet.of());
+ return flowtable;
+ }
+
+ private Optional<FlowTableConfig> createFlowTableConfig() {
+ NetworkConfigService netcfg = handler().get(NetworkConfigService.class);
+ DeviceId did = data().deviceId();
+ return Optional.ofNullable(netcfg.addConfig(did, FlowTableConfig.class));
+ }
+
+ private Optional<FlowTableConfig> getFlowTableConfig() {
+ NetworkConfigService netcfg = handler().get(NetworkConfigService.class);
+ DeviceId did = data().deviceId();
+ return Optional.ofNullable(netcfg.getConfig(did, FlowTableConfig.class));
+ }
+
+}
diff --git a/drivers/optical/src/main/java/org/onosproject/driver/optical/config/FlowTableConfig.java b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/FlowTableConfig.java
new file mode 100644
index 0000000..7bd1688
--- /dev/null
+++ b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/FlowTableConfig.java
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2017-present 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.driver.optical.config;
+
+import java.util.Set;
+
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.config.BaseConfig;
+import org.onosproject.net.flow.FlowRule;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.ImmutableSet.Builder;
+
+/**
+ * Config to store FlowTable.
+ *
+ * Used by ConfigFlowRuleProgrammable
+ */
+public class FlowTableConfig extends BaseConfig<DeviceId> {
+
+ /**
+ * Configuration key for {@link FlowTableConfig}.
+ */
+ public static final String CONFIG_KEY = "flowtable";
+
+ public static final String ENTRIES = "entries";
+
+
+ @Override
+ public boolean isValid() {
+ return hasField(ENTRIES);
+ }
+
+
+ public Set<FlowRule> flowtable() {
+ JsonNode ents = object.path(ENTRIES);
+ if (!ents.isArray()) {
+
+ return ImmutableSet.of();
+ }
+ ArrayNode entries = (ArrayNode) ents;
+
+ Builder<FlowRule> builder = ImmutableSet.builder();
+ entries.forEach(entry -> builder.add(decode(entry, FlowRule.class)));
+ return builder.build();
+ }
+
+ public FlowTableConfig flowtable(Set<FlowRule> table) {
+ JsonCodec<FlowRule> codec = codec(FlowRule.class);
+ ArrayNode entries = codec.encode(table, this);
+ object.set(ENTRIES, entries);
+ return this;
+ }
+
+ /**
+ * Create a {@link FlowTableConfig}.
+ * <p>
+ * Note: created instance needs to be initialized by #init(..) before using.
+ */
+ public FlowTableConfig() {
+ super();
+ }
+
+ /**
+ * Create a {@link FlowTableConfig} for specified Device.
+ * <p>
+ * Note: created instance is not bound to NetworkConfigService,
+ * cannot use {@link #apply()}. Must be passed to the service
+ * using NetworkConfigService#applyConfig
+ *
+ * @param did DeviceId
+ */
+ public FlowTableConfig(DeviceId did) {
+ ObjectMapper mapper = new ObjectMapper();
+ init(did, CONFIG_KEY, mapper.createObjectNode(), mapper, null);
+ }
+}
diff --git a/drivers/optical/src/main/java/org/onosproject/driver/optical/config/package-info.java b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/package-info.java
new file mode 100644
index 0000000..ca8add2
--- /dev/null
+++ b/drivers/optical/src/main/java/org/onosproject/driver/optical/config/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright 2017-present 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.
+ */
+/**
+ * Config used in optical driver.
+ */
+package org.onosproject.driver.optical.config;
diff --git a/drivers/optical/src/main/java/org/onosproject/drivers/optical/OpticalDriversLoader.java b/drivers/optical/src/main/java/org/onosproject/drivers/optical/OpticalDriversLoader.java
index 89872e4..4c1dc4f 100644
--- a/drivers/optical/src/main/java/org/onosproject/drivers/optical/OpticalDriversLoader.java
+++ b/drivers/optical/src/main/java/org/onosproject/drivers/optical/OpticalDriversLoader.java
@@ -16,10 +16,24 @@
package org.onosproject.drivers.optical;
+import static org.onosproject.net.config.basics.SubjectFactories.DEVICE_SUBJECT_FACTORY;
+
+import java.util.List;
+import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.onosproject.driver.optical.config.FlowTableConfig;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.config.ConfigFactory;
+import org.onosproject.net.config.NetworkConfigRegistry;
+import org.onosproject.net.config.NetworkConfigRegistryAdapter;
import org.onosproject.net.driver.AbstractDriverLoader;
import org.onosproject.net.optical.OpticalDevice;
+import com.google.common.collect.ImmutableList;
+
/**
* Loader for other optical device drivers.
*/
@@ -30,7 +44,40 @@
@SuppressWarnings("unused")
private OpticalDevice optical;
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected NetworkConfigRegistry registry = new NetworkConfigRegistryAdapter();
+
+
+
+ private final List<ConfigFactory> factories = ImmutableList.of(
+ new ConfigFactory<DeviceId, FlowTableConfig>(DEVICE_SUBJECT_FACTORY,
+ FlowTableConfig.class,
+ FlowTableConfig.CONFIG_KEY) {
+ @Override
+ public FlowTableConfig createConfig() {
+ return new FlowTableConfig();
+ }
+
+ });
+
+
public OpticalDriversLoader() {
super("/optical-drivers.xml");
}
+
+ @Activate
+ @Override
+ protected void activate() {
+ factories.forEach(registry::registerConfigFactory);
+
+ super.activate();
+ }
+
+ @Deactivate
+ @Override
+ protected void deactivate() {
+ factories.forEach(registry::unregisterConfigFactory);
+ super.deactivate();
+ }
+
}
diff --git a/drivers/optical/src/main/resources/optical-drivers.xml b/drivers/optical/src/main/resources/optical-drivers.xml
index ca4016f..203278f 100644
--- a/drivers/optical/src/main/resources/optical-drivers.xml
+++ b/drivers/optical/src/main/resources/optical-drivers.xml
@@ -68,6 +68,11 @@
manufacturer="Oplink a Molex company" hwVersion="protection-switch" swVersion="of-agent-1.0">
<behaviour api="org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver"
impl="org.onosproject.driver.optical.handshaker.OplinkSwitchHandshaker"/>
+
+ <!-- Transparent in-line device ignore all FlowRules -->
+ <behaviour api="org.onosproject.net.flow.FlowRuleProgrammable"
+ impl="org.onosproject.driver.optical.config.ConfigFlowRuleProgrammable"/>
+
</driver>
<driver name="oplk-edfa" extends="default"
@@ -78,6 +83,11 @@
impl="org.onosproject.driver.optical.query.OplinkEdfaLambdaQuery"/>
<behaviour api="org.onosproject.net.behaviour.PowerConfig"
impl="org.onosproject.driver.optical.power.OplinkEdfaPowerConfig"/>
+
+ <!-- Transparent in-line device ignore all FlowRules -->
+ <behaviour api="org.onosproject.net.flow.FlowRuleProgrammable"
+ impl="org.onosproject.driver.optical.config.ConfigFlowRuleProgrammable"/>
+
</driver>
</drivers>