[ONOSFW-127] Container class for Port Pair

Change-Id: Ibd13dff2ceae9ca85c1d9a01ad23935f175c7e6d

3 files changed, 432 insertions, 0 deletions

diff --git a/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/DefaultPortPair.java b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/DefaultPortPair.java
new file mode 100644
index 00000000..ed480fb7
--- /dev/null
+++ b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/DefaultPortPair.java
@@ -0,0 +1,200 @@
+/*
+ * 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.vtnrsc.sfc;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.Objects;
+
+import org.onosproject.vtnrsc.TenantId;
+
+/**
+ * Implementation of port pair.
+ */
+public final class DefaultPortPair implements PortPair {
+
+    private final PortPairId portPairId;
+    private final TenantId tenantId;
+    private final String name;
+    private final String description;
+    private final String ingress;
+    private final String egress;
+
+    /**
+     * Default constructor to create Port Pair.
+     *
+     * @param portPairId port pair id
+     * @param tenantId tenant id
+     * @param name name of port pair
+     * @param description description of port pair
+     * @param ingress ingress port
+     * @param egress egress port
+     */
+    private DefaultPortPair(PortPairId portPairId, TenantId tenantId,
+                            String name, String description,
+                            String ingress, String egress) {
+
+        this.portPairId = portPairId;
+        this.tenantId = tenantId;
+        this.name = name;
+        this.description = description;
+        this.ingress = ingress;
+        this.egress = egress;
+    }
+
+    @Override
+    public PortPairId portPairId() {
+        return portPairId;
+    }
+
+    @Override
+    public TenantId tenantId() {
+        return tenantId;
+    }
+
+    @Override
+    public String name() {
+        return name;
+    }
+
+    @Override
+    public String description() {
+        return description;
+    }
+
+    @Override
+    public String ingress() {
+        return ingress;
+    }
+
+    @Override
+    public String egress() {
+        return egress;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(portPairId, tenantId, name, description,
+                            ingress, egress);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj instanceof DefaultPortPair) {
+            DefaultPortPair that = (DefaultPortPair) obj;
+            return Objects.equals(portPairId, that.portPairId) &&
+                    Objects.equals(tenantId, that.tenantId) &&
+                    Objects.equals(name, that.name) &&
+                    Objects.equals(description, that.description) &&
+                    Objects.equals(ingress, that.ingress) &&
+                    Objects.equals(egress, that.egress);
+        }
+        return false;
+    }
+
+    @Override
+    public boolean exactMatch(PortPair portPair) {
+        return this.equals(portPair) &&
+                Objects.equals(this.portPairId, portPair.portPairId()) &&
+                Objects.equals(this.tenantId, portPair.tenantId());
+    }
+
+    @Override
+    public String toString() {
+        return toStringHelper(this)
+                .add("id", portPairId.toString())
+                .add("tenantId", tenantId.tenantId())
+                .add("name", name)
+                .add("description", description)
+                .add("ingress", ingress)
+                .add("egress", egress)
+                .toString();
+    }
+
+    /**
+     * To create an instance of the builder.
+     *
+     * @return instance of builder
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    /**
+     * Builder class for Port pair.
+     */
+    public static final class Builder implements PortPair.Builder {
+
+        private PortPairId portPairId;
+        private TenantId tenantId;
+        private String name;
+        private String description;
+        private String ingress;
+        private String egress;
+
+        @Override
+        public Builder setId(PortPairId portPairId) {
+            this.portPairId = portPairId;
+            return this;
+        }
+
+        @Override
+        public Builder setTenantId(TenantId tenantId) {
+            this.tenantId = tenantId;
+            return this;
+        }
+
+        @Override
+        public Builder setName(String name) {
+            this.name = name;
+            return this;
+        }
+
+        @Override
+        public Builder setDescription(String description) {
+            this.description = description;
+            return this;
+        }
+
+        @Override
+        public Builder setIngress(String ingress) {
+            this.ingress = ingress;
+            return this;
+        }
+
+        @Override
+        public Builder setEgress(String egress) {
+            this.egress = egress;
+            return this;
+        }
+
+        @Override
+        public PortPair build() {
+
+            checkNotNull(portPairId, "Port pair id cannot be null");
+            checkNotNull(tenantId, "Tenant id cannot be null");
+            checkNotNull(ingress, "Ingress of a port pair cannot be null");
+            checkNotNull(egress, "Egress of a port pair cannot be null");
+
+            return new DefaultPortPair(portPairId, tenantId, name, description,
+                                       ingress, egress);
+        }
+    }
+}
diff --git a/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPair.java b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPair.java
new file mode 100644
index 00000000..e3df941d
--- /dev/null
+++ b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPair.java
@@ -0,0 +1,140 @@
+/*
+ * 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.vtnrsc.sfc;
+
+import org.onosproject.vtnrsc.TenantId;
+
+/**
+ * Abstraction of an entity providing Port Pair information.
+ * A port pair represents a service function instance.
+ */
+public interface PortPair {
+
+    /**
+     * Returns the ID of this port Pair.
+     *
+     * @return the port pair id
+     */
+    PortPairId portPairId();
+
+    /**
+     * Returns the tenant id of this port pair.
+     *
+     * @return an tenant id
+     */
+    TenantId tenantId();
+
+    /**
+     * Returns the description of this port pair.
+     *
+     * @return description of port pair
+     */
+    String name();
+
+    /**
+     * Returns the description of this port pair.
+     *
+     * @return description of port pair
+     */
+    String description();
+
+    /**
+     * Returns the ingress port of this port pair.
+     *
+     * @return ingress of port pair
+     */
+    String ingress();
+
+    /**
+     * Returns the egress port of this port pair.
+     *
+     * @return egress of port pair
+     */
+    String egress();
+
+    /**
+     * Returns whether this port pair is an exact match to the port pair given
+     * in the argument.
+     * <p>
+     * Exact match means the Port port pairs match with the given port pair.
+     * It does not consider the port pair id, name and description.
+     * </p>
+     * @param portPair other port pair to match against
+     * @return true if the port pairs are an exact match, otherwise false
+     */
+    boolean exactMatch(PortPair portPair);
+
+    /**
+     * A port pair builder..
+     */
+    interface Builder {
+
+        /**
+         * Assigns the port pair id to this object.
+         *
+         * @param portPairId the port pair id
+         * @return this the builder object
+         */
+        Builder setId(PortPairId portPairId);
+
+        /**
+         * Assigns tenant id to this object.
+         *
+         * @param tenantId tenant id of the port pair
+         * @return this the builder object
+         */
+        Builder setTenantId(TenantId tenantId);
+
+        /**
+         * Assigns the name to this object.
+         *
+         * @param name name of the port pair
+         * @return this the builder object
+         */
+        Builder setName(String name);
+
+        /**
+         * Assigns the description to this object.
+         *
+         * @param description description of the port pair
+         * @return this the builder object
+         */
+        Builder setDescription(String description);
+
+        /**
+         * Assigns the ingress port to this object.
+         *
+         * @param port ingress port of the port pair
+         * @return this the builder object
+         */
+        Builder setIngress(String port);
+
+        /**
+         * Assigns the egress port to this object.
+         *
+         * @param port egress port of the port pair
+         * @return this the builder object
+         */
+        Builder setEgress(String port);
+
+        /**
+         * Builds a port pair object.
+         *
+         * @return a port pair.
+         */
+        PortPair build();
+    }
+}
diff --git a/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPairId.java b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPairId.java
new file mode 100644
index 00000000..0209c23e
--- /dev/null
+++ b/framework/src/onos/apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/sfc/PortPairId.java
@@ -0,0 +1,92 @@
+/*
+ * 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.vtnrsc.sfc;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.UUID;
+
+import com.google.common.base.Objects;
+
+/**
+ * Representation of a Port Pair ID.
+ */
+public final class PortPairId {
+
+    private final UUID portPairId;
+
+    /**
+     * Private constructor for port pair id.
+     *
+     * @param id UUID id of port pair
+     */
+    private PortPairId(UUID id) {
+        checkNotNull(id, "Port chain id can not be null");
+        this.portPairId = id;
+    }
+
+    /**
+     * Constructor to create port pair id from UUID.
+     *
+     * @param id UUID of port pair id
+     * @return object of port pair id
+     */
+    public static PortPairId portPairId(UUID id) {
+        return new PortPairId(id);
+    }
+
+    /**
+     * Constructor to create port pair id from string.
+     *
+     * @param id port pair id in string
+     * @return object of port pair id
+     */
+    public static PortPairId portPairId(String id) {
+        return new PortPairId(UUID.fromString(id));
+    }
+
+    /**
+     * Returns teh value of port pair id.
+     *
+     * @return port pair id
+     */
+    public UUID value() {
+        return portPairId;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+
+        if (obj.getClass()  == this.getClass()) {
+            PortPairId that = (PortPairId) obj;
+            return Objects.equal(this.portPairId, that.portPairId);
+        }
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(this.portPairId);
+    }
+
+    @Override
+    public String toString() {
+        return portPairId.toString();
+    }
+}