ONOSFW-171

O/S-SFC-ONOS scenario documentation

Change-Id: I51ae1cf736ea24ab6680f8edca1b2bf5dd598365
Signed-off-by: CNlucius <lukai1@huawei.com>

3 files changed, 0 insertions, 315 deletions

diff --git a/framework/src/onos/apps/proxyarp/pom.xml b/framework/src/onos/apps/proxyarp/pom.xml
deleted file mode 100644
index 28adaf8a..00000000
--- a/framework/src/onos/apps/proxyarp/pom.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  ~ Copyright 2014 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.
-  -->
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-
-    <parent>
-        <groupId>org.onosproject</groupId>
-        <artifactId>onos-apps</artifactId>
-        <version>1.4.0-rc1</version>
-        <relativePath>../pom.xml</relativePath>
-    </parent>
-
-    <artifactId>onos-app-proxyarp</artifactId>
-    <packaging>bundle</packaging>
-
-    <description>Proxy ARP/NDP application</description>
-
-    <properties>
-        <onos.app.name>org.onosproject.proxyarp</onos.app.name>
-    </properties>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.compendium</artifactId>
-        </dependency>
-    </dependencies>
-
-</project>
diff --git a/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/ProxyArp.java b/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/ProxyArp.java
deleted file mode 100644
index 2eb1d5ec..00000000
--- a/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/ProxyArp.java
+++ /dev/null
@@ -1,250 +0,0 @@
-/*
- * Copyright 2014-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.proxyarp;
-
-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.Modified;
-import org.apache.felix.scr.annotations.Property;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.ReferenceCardinality;
-import org.onlab.packet.Ethernet;
-import org.onlab.packet.ICMP6;
-import org.onlab.packet.IPv6;
-import org.onosproject.cfg.ComponentConfigService;
-import org.onosproject.core.ApplicationId;
-import org.onosproject.core.CoreService;
-import org.onosproject.net.flow.DefaultTrafficSelector;
-import org.onosproject.net.flow.TrafficSelector;
-import org.onosproject.net.packet.InboundPacket;
-import org.onosproject.net.packet.PacketContext;
-import org.onosproject.net.packet.PacketProcessor;
-import org.onosproject.net.packet.PacketService;
-import org.onosproject.net.proxyarp.ProxyArpService;
-import org.osgi.service.component.ComponentContext;
-import org.slf4j.Logger;
-
-import java.util.Dictionary;
-
-import static com.google.common.base.Strings.isNullOrEmpty;
-import static org.onlab.packet.Ethernet.TYPE_ARP;
-import static org.onlab.packet.Ethernet.TYPE_IPV6;
-import static org.onlab.packet.ICMP6.NEIGHBOR_ADVERTISEMENT;
-import static org.onlab.packet.ICMP6.NEIGHBOR_SOLICITATION;
-import static org.onlab.packet.IPv6.PROTOCOL_ICMP6;
-import static org.onosproject.net.packet.PacketPriority.CONTROL;
-import static org.slf4j.LoggerFactory.getLogger;
-
-/**
- * Sample reactive proxy arp application.
- */
-@Component(immediate = true)
-public class ProxyArp {
-
-    private final Logger log = getLogger(getClass());
-
-    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    protected PacketService packetService;
-
-    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    protected ProxyArpService proxyArpService;
-
-    private ProxyArpProcessor processor = new ProxyArpProcessor();
-
-    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    protected CoreService coreService;
-
-    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
-    protected ComponentConfigService cfgService;
-
-    private ApplicationId appId;
-
-    @Property(name = "ipv6NeighborDiscovery", boolValue = false,
-            label = "Enable IPv6 Neighbor Discovery; default is false")
-    protected boolean ipv6NeighborDiscovery = false;
-
-    @Activate
-    public void activate(ComponentContext context) {
-        cfgService.registerProperties(getClass());
-        appId = coreService.registerApplication("org.onosproject.proxyarp");
-
-        packetService.addProcessor(processor, PacketProcessor.director(1));
-        readComponentConfiguration(context);
-        requestPackets();
-
-        log.info("Started with Application ID {}", appId.id());
-    }
-
-    @Deactivate
-    public void deactivate() {
-        cfgService.unregisterProperties(getClass(), false);
-        withdrawIntercepts();
-        packetService.removeProcessor(processor);
-        processor = null;
-        log.info("Stopped");
-    }
-
-    @Modified
-    public void modified(ComponentContext context) {
-        readComponentConfiguration(context);
-        requestPackets();
-    }
-
-    /**
-     * Request packet in via PacketService.
-     */
-    private void requestPackets() {
-        TrafficSelector.Builder selectorBuilder =
-                DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_ARP);
-        packetService.requestPackets(selectorBuilder.build(),
-                                     CONTROL, appId);
-
-        selectorBuilder = DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_IPV6);
-        selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6);
-        selectorBuilder.matchIcmpv6Type(NEIGHBOR_SOLICITATION);
-        if (ipv6NeighborDiscovery) {
-            // IPv6 Neighbor Solicitation packet.
-            packetService.requestPackets(selectorBuilder.build(),
-                                         CONTROL, appId);
-        } else {
-            packetService.cancelPackets(selectorBuilder.build(),
-                                        CONTROL, appId);
-        }
-
-        // IPv6 Neighbor Advertisement packet.
-        selectorBuilder = DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_IPV6);
-        selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6);
-        selectorBuilder.matchIcmpv6Type(NEIGHBOR_ADVERTISEMENT);
-        if (ipv6NeighborDiscovery) {
-            packetService.requestPackets(selectorBuilder.build(),
-                                         CONTROL, appId);
-        } else {
-            packetService.cancelPackets(selectorBuilder.build(),
-                                        CONTROL, appId);
-        }
-
-
-    }
-
-    /**
-     * Cancel requested packet in via packet service.
-     */
-    private void withdrawIntercepts() {
-        TrafficSelector.Builder selectorBuilder =
-                DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_ARP);
-        packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId);
-        selectorBuilder = DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_IPV6);
-        selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6);
-        selectorBuilder.matchIcmpv6Type(NEIGHBOR_SOLICITATION);
-        packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId);
-        selectorBuilder = DefaultTrafficSelector.builder();
-        selectorBuilder.matchEthType(TYPE_IPV6);
-        selectorBuilder.matchIPProtocol(PROTOCOL_ICMP6);
-        selectorBuilder.matchIcmpv6Type(NEIGHBOR_ADVERTISEMENT);
-        packetService.cancelPackets(selectorBuilder.build(), CONTROL, appId);
-
-    }
-
-    /**
-     * Extracts properties from the component configuration context.
-     *
-     * @param context the component context
-     */
-    private void readComponentConfiguration(ComponentContext context) {
-        Dictionary<?, ?> properties = context.getProperties();
-        Boolean flag;
-
-        flag = isPropertyEnabled(properties, "ipv6NeighborDiscovery");
-        if (flag == null) {
-            log.info("IPv6 Neighbor Discovery is not configured, " +
-                             "using current value of {}", ipv6NeighborDiscovery);
-        } else {
-            ipv6NeighborDiscovery = flag;
-            log.info("Configured. IPv6 Neighbor Discovery is {}",
-                     ipv6NeighborDiscovery ? "enabled" : "disabled");
-        }
-    }
-
-    /**
-     * Check property name is defined and set to true.
-     *
-     * @param properties   properties to be looked up
-     * @param propertyName the name of the property to look up
-     * @return value when the propertyName is defined or return null
-     */
-    private static Boolean isPropertyEnabled(Dictionary<?, ?> properties,
-                                             String propertyName) {
-        Boolean value = null;
-        try {
-            String s = (String) properties.get(propertyName);
-            value = isNullOrEmpty(s) ? null : s.trim().equals("true");
-        } catch (ClassCastException e) {
-            // No propertyName defined.
-            value = null;
-        }
-        return value;
-    }
-
-    /**
-     * Packet processor responsible for forwarding packets along their paths.
-     */
-    private class ProxyArpProcessor implements PacketProcessor {
-
-        @Override
-        public void process(PacketContext context) {
-            // Stop processing if the packet has been handled, since we
-            // can't do any more to it.
-            if (context.isHandled()) {
-                return;
-            }
-
-            InboundPacket pkt = context.inPacket();
-            Ethernet ethPkt = pkt.parsed();
-            if (ethPkt == null) {
-                return;
-            }
-
-            if (ethPkt.getEtherType() == TYPE_ARP) {
-                //handle the arp packet.
-                proxyArpService.handlePacket(context);
-            } else if (ipv6NeighborDiscovery && ethPkt.getEtherType() == TYPE_IPV6) {
-                IPv6 ipv6Pkt = (IPv6) ethPkt.getPayload();
-                if (ipv6Pkt.getNextHeader() == IPv6.PROTOCOL_ICMP6) {
-                    ICMP6 icmp6Pkt = (ICMP6) ipv6Pkt.getPayload();
-                    if (icmp6Pkt.getIcmpType() == NEIGHBOR_SOLICITATION ||
-                        icmp6Pkt.getIcmpType() == NEIGHBOR_ADVERTISEMENT) {
-                        // handle ICMPv6 solicitations and advertisements
-                        proxyArpService.handlePacket(context);
-                    }
-                }
-            }
-
-            // FIXME why were we listening to IPv4 frames at all?
-            // Do not ARP for multicast packets.  Let mfwd handle them.
-            if (ethPkt.getEtherType() == Ethernet.TYPE_IPV4) {
-                if (ethPkt.getDestinationMAC().isMulticast()) {
-                    return;
-                }
-            }
-        }
-    }
-}
diff --git a/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/package-info.java b/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/package-info.java
deleted file mode 100644
index 812a7510..00000000
--- a/framework/src/onos/apps/proxyarp/src/main/java/org/onosproject/proxyarp/package-info.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/*
- * Copyright 2014 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.
- */
-
-/**
- * Proxy Arp  application that handles arp resolution for you.
- */
-package org.onosproject.proxyarp;