cleaning mcast route data type in preperation for the backing store

moving package to API with BETA tag

Change-Id: I62a611dcb67b6b4d3ee6f90ed2e963ea345b7d6e

-<?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-SNAPSHOT</version>
-        <relativePath>../pom.xml</relativePath>
-    </parent>
-
-    <artifactId>onos-app-mcast</artifactId>
-    <packaging>bundle</packaging>
-
-    <description>Multicast RIB</description>
-
-    <properties>
-        <onos.app.name>org.onosproject.mcast</onos.app.name>
-    </properties>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.compendium</artifactId>
-        </dependency>
-    </dependencies>
-
-</project>

@@ -61,7 +61,6 @@
         <module>mfwd</module>
         <module>mfwd</module>
         <module>igmp</module>
         <module>igmp</module>
         <module>pim</module>
         <module>pim</module>
-        <module>mcast</module>
   </modules>
   </modules>
 
 
     <properties>
     <properties>

@@ -13,8 +13,9 @@
  * See the License for the specific language governing permissions and
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * limitations under the License.
  */
  */
-package org.onosproject.mcast;
+package org.onosproject.net.mcast;
 
 
+import com.google.common.annotations.Beta;
 import org.onosproject.event.AbstractEvent;
 import org.onosproject.event.AbstractEvent;
 import org.onosproject.net.ConnectPoint;
 import org.onosproject.net.ConnectPoint;
 
 
@@ -24,6 +25,7 @@ import java.util.Optional;
  * An entity representing a multicast event. Event either add or remove
  * An entity representing a multicast event. Event either add or remove
  * sinks or sources.
  * sinks or sources.
  */
  */
+@Beta
 public class McastEvent extends AbstractEvent<McastEvent.Type, McastRoute> {
 public class McastEvent extends AbstractEvent<McastEvent.Type, McastRoute> {
 
 
     private final Optional<ConnectPoint> sink;
     private final Optional<ConnectPoint> sink;

@@ -13,12 +13,14 @@
  * See the License for the specific language governing permissions and
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * limitations under the License.
  */
  */
-package org.onosproject.mcast;
+package org.onosproject.net.mcast;
 
 
+import com.google.common.annotations.Beta;
 import org.onosproject.event.EventListener;
 import org.onosproject.event.EventListener;
 
 
 /**
 /**
  * A listener interface for multicast events.
  * A listener interface for multicast events.
  */
  */
+@Beta
 public interface McastListener extends EventListener<McastEvent> {
 public interface McastListener extends EventListener<McastEvent> {
 }
 }

@@ -13,22 +13,46 @@
  * See the License for the specific language governing permissions and
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * limitations under the License.
  */
  */
-package org.onosproject.mcast;
+package org.onosproject.net.mcast;
 
 
+import com.google.common.annotations.Beta;
+import com.google.common.base.Objects;
 import org.onlab.packet.IpPrefix;
 import org.onlab.packet.IpPrefix;
 
 
+import static com.google.common.base.MoreObjects.toStringHelper;
+
 /**
 /**
  * An entity representing a multicast route consisting of a source
  * An entity representing a multicast route consisting of a source
  * and a multicast group address.
  * and a multicast group address.
  */
  */
+@Beta
 public class McastRoute {
 public class McastRoute {
 
 
-    public final IpPrefix source;
-    public final IpPrefix group;
+    public enum Type {
+        /**
+         * Route originates from PIM.
+         */
+        PIM,
+
+        /**
+         * Route originates from IGMP.
+         */
+        IGMP,
+
+        /**
+         * Route originates from other config (ie. REST, CLI).
+         */
+        STATIC
+    }
+
+    private final IpPrefix source;
+    private final IpPrefix group;
+    private final Type type;
 
 
-    public McastRoute(IpPrefix source, IpPrefix group) {
+    public McastRoute(IpPrefix source, IpPrefix group, Type type) {
         this.source = source;
         this.source = source;
         this.group = group;
         this.group = group;
+        this.type = type;
     }
     }
 
 
     /**
     /**
@@ -49,4 +73,41 @@ public class McastRoute {
         return group;
         return group;
     }
     }
 
 
+    /**
+     * Obtains how this route was created.
+     * @return a type of route
+
+     */
+    public Type type() {
+        return type;
+    }
+
+    @Override
+    public String toString() {
+        return toStringHelper(this)
+                .add("source", source)
+                .add("group", group)
+                .add("origin", type)
+                .toString();
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        McastRoute that = (McastRoute) o;
+        return Objects.equal(source, that.source) &&
+                Objects.equal(group, that.group) &&
+                Objects.equal(type, that.type);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(source, group, type);
+    }
+
 }
 }

@@ -13,8 +13,9 @@
  * See the License for the specific language governing permissions and
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * limitations under the License.
  */
  */
-package org.onosproject.mcast;
+package org.onosproject.net.mcast;
 
 
+import com.google.common.annotations.Beta;
 import org.onosproject.net.ConnectPoint;
 import org.onosproject.net.ConnectPoint;
 
 
 import java.util.List;
 import java.util.List;
@@ -22,6 +23,7 @@ import java.util.List;
 /**
 /**
  * A service interface for maintaining multicast information.
  * A service interface for maintaining multicast information.
  */
  */
+@Beta
 public interface MulticastRouteTable {
 public interface MulticastRouteTable {
 
 
     /**
     /**