flow specification.
Change-Id: Iacb8eae8fe7cce769a019ecffa6073c015ff80d1
diff --git a/apps/flowspec-api/BUCK b/apps/flowspec-api/BUCK
new file mode 100755
index 0000000..01efc7a
--- /dev/null
+++ b/apps/flowspec-api/BUCK
@@ -0,0 +1,11 @@
+BUNDLES = [
+ '//apps/flowspec-api/flowapi:onos-apps-flowspec-api-flowapi',
+
+]
+
+onos_app (
+ title = 'Flowspec API',
+ url = 'http://onosproject.org',
+ included_bundles = BUNDLES,
+ description = 'ONOS framework applications',
+)
diff --git a/apps/flowspec-api/flowapi/BUCK b/apps/flowspec-api/flowapi/BUCK
new file mode 100755
index 0000000..2596ffb
--- /dev/null
+++ b/apps/flowspec-api/flowapi/BUCK
@@ -0,0 +1,18 @@
+COMPILE_DEPS = [
+ '//utils/osgi:onlab-osgi',
+ '//utils/misc:onlab-misc',
+ '//lib:commons-io',
+ '//lib:guava',
+ '//lib:kryo',
+ '//lib:slf4j-api',
+]
+
+TEST_DEPS = [
+ '//lib:TEST_ADAPTERS',
+]
+
+osgi_jar_with_tests (
+ deps = COMPILE_DEPS,
+ test_deps = TEST_DEPS,
+ visibility = ['PUBLIC'],
+)
diff --git a/apps/flowspec-api/flowapi/pom.xml b/apps/flowspec-api/flowapi/pom.xml
new file mode 100755
index 0000000..c5f54767
--- /dev/null
+++ b/apps/flowspec-api/flowapi/pom.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ 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.
+ -->
+<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-app-flowspec-api</artifactId>
+ <version>1.9.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <artifactId>onos-app-flowspec-api-flowapi</artifactId>
+ <packaging>bundle</packaging>
+
+ <description>api bundle to be accessible across the layers</description>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onlab-misc</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava-testlib</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+</project>
diff --git a/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowContainer.java b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowContainer.java
new file mode 100755
index 0000000..9a253c4
--- /dev/null
+++ b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowContainer.java
@@ -0,0 +1,121 @@
+/*
+ * 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.flowapi;
+
+import com.google.common.base.MoreObjects;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Representation of Multi value flow container having custom rules.
+ */
+public final class ExtFlowContainer {
+
+ private List<ExtFlowTypes> container = new ArrayList<>();
+ private String deviceId;
+
+ /**
+ * Creates an object of type ExtFlowContainer.
+ *
+ * @param container flow container
+ */
+ public ExtFlowContainer(List<ExtFlowTypes> container) {
+ this.container = container;
+ }
+
+ /**
+ * Returns the ExtFlowContainer by setting its value.
+ *
+ * @param container flow container
+ * @return object of ExtFlowContainer
+ */
+ public static ExtFlowContainer of(List<ExtFlowTypes> container) {
+ return new ExtFlowContainer(container);
+ }
+
+ /**
+ * Returns the list of ExtFlowTypes value.
+ *
+ * @return list of ExtFlowTypes
+ */
+ public List<ExtFlowTypes> container() {
+ return container;
+ }
+
+ /**
+ * Returns the device Id.
+ *
+ * @return deviceId
+ */
+ public String deviceId() {
+ return deviceId;
+ }
+
+ /**
+ * Adds the flow type to the container list.
+ *
+ * @param obj of ExtFlowTypes type
+ */
+ public void add(ExtFlowTypes obj) {
+ container.add(obj);
+ }
+
+ /**
+ * Removes the flow type from the container list.
+ *
+ * @param obj of ExtFlowTypes type
+ */
+ public void remove(ExtFlowTypes obj) {
+ container.remove(obj);
+ }
+
+ /**
+ * Sets the device Id to this container.
+ *
+ * @param deviceId to be set to this container
+ */
+ public void setDeviceId(String deviceId) {
+ this.deviceId = deviceId;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(container);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (!(obj instanceof ExtFlowContainer)) {
+ return false;
+ }
+ final ExtFlowContainer other = (ExtFlowContainer) obj;
+ return Objects.equals(this.container, other.container)
+ && Objects.equals(this.deviceId, other.deviceId);
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(this)
+ .add("container", container)
+ .add("deviceId", deviceId)
+ .toString();
+ }
+}
diff --git a/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowTypes.java b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowTypes.java
new file mode 100755
index 0000000..80434d8
--- /dev/null
+++ b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/ExtFlowTypes.java
@@ -0,0 +1,120 @@
+/*
+ * 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.flowapi;
+
+/**
+ * Representation of BgpFlow container having custom rules.
+ */
+public interface ExtFlowTypes {
+
+ /**
+ * Bgp types.
+ */
+ public enum ExtType {
+
+ /** Extended flow rule key. */
+ EXT_FLOW_RULE_KEY(0),
+
+ /** IPv4 destination address. */
+ IPV4_DST_PFX(1),
+
+ /** IPv4 source address. */
+ IPV4_SRC_PFX(2),
+
+ /** IP protocol list. */
+ IP_PROTO_LIST(3),
+
+ /** Input port list. */
+ IN_PORT_LIST(4),
+
+ /** Destination port list. */
+ DST_PORT_LIST(5),
+
+ /** Source port list. */
+ SRC_PORT_LIST(6),
+
+ /** ICMP type list. */
+ ICMP_TYPE_LIST(7),
+
+ /** ICMP code list. */
+ ICMP_CODE_LIST(8),
+
+ /** TCP flag list. */
+ TCP_FLAG_LIST(9),
+
+ /** Packet length list. */
+ PACKET_LENGTH_LIST(10),
+
+ /** DSCP Value component. */
+ DSCP_VALUE_LIST(11),
+
+ /** Fragment list. */
+ FRAGMENT_LIST(12),
+
+ /** Wide community flags. */
+ WIDE_COMM_FLAGS(13),
+
+ /** Wide community hop count. */
+ WIDE_COMM_HOP_COUNT(14),
+
+ /** Wide community community attribute. */
+ WIDE_COMM_COMMUNITY(15),
+
+ /** Wide community context AS. */
+ WIDE_COMM_CONTEXT_AS(16),
+
+ /** Wide community local AS. */
+ WIDE_COMM_LOCAL_AS(17),
+
+ /** Wide community target prefixes. */
+ WIDE_COMM_TARGET(18),
+
+ /** Wide community extended target prefixes. */
+ WIDE_COMM_EXT_TARGET(19),
+
+ /** Wide community parameter. */
+ WIDE_COMM_PARAMETER(20),
+
+ /** Traffic filtering actions. */
+
+ TRAFFIC_RATE(0x8006),
+ TRAFFIC_ACTION(0x8007),
+ TRAFFIC_REDIRECT(0x8008),
+ TRAFFIC_MARKING(0x8009);
+
+ private int type;
+
+ /**
+ * Creates a new type.
+ *
+ * @param type type code
+ */
+ ExtType(int type) {
+ this.type = type;
+ }
+
+ /**
+ * Returns the type object for this type code.
+ *
+ * @return ExtType object
+ */
+ public int type() {
+ return (type);
+ }
+ }
+
+ ExtType type();
+}
diff --git a/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/package-info.java b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/package-info.java
new file mode 100755
index 0000000..f2999c5
--- /dev/null
+++ b/apps/flowspec-api/flowapi/src/main/java/org/onosproject/flowapi/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+
+/**
+ * API bundle.
+ */
+package org.onosproject.flowapi;
diff --git a/apps/flowspec-api/pom.xml b/apps/flowspec-api/pom.xml
new file mode 100755
index 0000000..f6c9926
--- /dev/null
+++ b/apps/flowspec-api/pom.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ 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.
+ -->
+<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.9.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <artifactId>onos-app-flowspec-api</artifactId>
+ <packaging>pom</packaging>
+
+ <description>ONOS flow spec applications</description>
+
+ <modules>
+ <module>flowapi</module>
+ </modules>
+ <dependencies>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onlab-junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava-testlib</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.easymock</groupId>
+ <artifactId>easymock</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onlab-osgi</artifactId>
+ <classifier>tests</classifier>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-api</artifactId>
+ <scope>test</scope>
+ <classifier>tests</classifier>
+ </dependency>
+ <dependency>
+ <groupId>org.glassfish.jersey.containers</groupId>
+ <artifactId>jersey-container-servlet</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.glassfish.jersey.test-framework</groupId>
+ <artifactId>jersey-test-framework-core</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.glassfish.jersey.test-framework.providers</groupId>
+ <artifactId>jersey-test-framework-provider-jetty</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/apps/pom.xml b/apps/pom.xml
index a5c3fe9..497e5cc 100644
--- a/apps/pom.xml
+++ b/apps/pom.xml
@@ -46,6 +46,7 @@
<module>reactive-routing</module>
<module>virtualbng</module>
<module>bgprouter</module>
+ <module>flowspec-api</module>
<module>test</module>
<module>segmentrouting</module>
<module>kafka-integration</module>