ONOS-3692 Southbound Rest provider and protocol
Change-Id: I74a5752d4fce1df88828fa6c531979ab7c30a26a
t
diff --git a/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/DefaultRestSBDevice.java b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/DefaultRestSBDevice.java
new file mode 100644
index 0000000..baf26cb
--- /dev/null
+++ b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/DefaultRestSBDevice.java
@@ -0,0 +1,110 @@
+/*
+ * Copyright 2016 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.protocol.rest;
+
+import com.google.common.base.Preconditions;
+import org.onlab.packet.IpAddress;
+import org.onosproject.net.DeviceId;
+
+import java.util.Objects;
+
+/**
+ * Default implementation for Rest devices.
+ */
+public class DefaultRestSBDevice implements RestSBDevice {
+ private static final String REST = "rest";
+ private static final String COLON = ":";
+ private final IpAddress ip;
+ private final int port;
+ private final String name;
+ private final String password;
+ private boolean isActive;
+ private String protocol;
+
+ public DefaultRestSBDevice(IpAddress ip, int port, String name, String password,
+ String protocol, boolean isActive) {
+ Preconditions.checkNotNull(ip, "IP address cannot be null");
+ Preconditions.checkArgument(port > 0, "Port address cannot be negative");
+ Preconditions.checkNotNull(protocol, "protocol address cannot be null");
+ this.ip = ip;
+ this.port = port;
+ this.name = name;
+ this.password = password;
+ this.isActive = isActive;
+ this.protocol = protocol;
+ }
+
+ @Override
+ public IpAddress ip() {
+ return ip;
+ }
+
+ @Override
+ public int port() {
+ return port;
+ }
+
+ @Override
+ public String name() {
+ return name;
+ }
+
+ @Override
+ public String password() {
+ return password;
+ }
+
+ @Override
+ public DeviceId deviceId() {
+ return DeviceId.deviceId(REST + COLON + ip + COLON + port);
+ }
+
+ @Override
+ public void setActive(boolean active) {
+ isActive = active;
+ }
+
+ @Override
+ public boolean isActive() {
+ return isActive;
+ }
+
+ @Override
+ public String protocol() {
+ return protocol;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (obj == this) {
+ return true;
+ }
+ if (!(obj instanceof RestSBDevice)) {
+ return false;
+ }
+ RestSBDevice device = (RestSBDevice) obj;
+ return this.name.equals(device.name()) && this.ip.equals(device.ip()) &&
+ this.port == device.port();
+
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(ip, port);
+ }
+
+}
diff --git a/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBController.java b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBController.java
new file mode 100644
index 0000000..28d5617
--- /dev/null
+++ b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBController.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright 2016 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.protocol.rest;
+
+import org.onlab.packet.IpAddress;
+import org.onosproject.net.DeviceId;
+
+import java.io.InputStream;
+import java.util.Map;
+
+/**
+ * Abstraction of an REST controller. Serves as a one stop shop for obtaining
+ * Rest southbound devices and (un)register listeners.
+ */
+public interface RestSBController {
+
+ /**
+ * Returns all the devices known to this controller.
+ *
+ * @return map of devices
+ */
+ Map<DeviceId, RestSBDevice> getDevices();
+
+ /**
+ * Returns a device by node identifier.
+ *
+ * @param deviceInfo node identifier
+ * @return RestSBDevice rest device
+ */
+ RestSBDevice getDevice(DeviceId deviceInfo);
+
+ /**
+ * Returns a device by Ip and Port.
+ *
+ * @param ip device ip
+ * @param port device port
+ * @return RestSBDevice rest device
+ */
+ RestSBDevice getDevice(IpAddress ip, int port);
+
+ /**
+ * Adds a device to the device map.
+ *
+ * @param device to be added
+ */
+ void addDevice(RestSBDevice device);
+
+ /**
+ * Removes the device from the devices map.
+ *
+ * @param device to be removed
+ */
+ void removeDevice(RestSBDevice device);
+
+ /**
+ * Does a REST POST request with specified parameters to the device.
+ *
+ * @param device device to make the request to
+ * @param request url of the request
+ * @param payload payload of the request as an InputStream
+ * @param mediaType type of content in the payload i.e. application/json
+ * @return true if operation returned 200, 201, 202, false otherwise
+ */
+ boolean post(DeviceId device, String request, InputStream payload, String mediaType);
+
+ /**
+ * Does a REST PUT request with specified parameters to the device.
+ *
+ * @param device device to make the request to
+ * @param request resource path of the request
+ * @param payload payload of the request as an InputStream
+ * @param mediaType type of content in the payload i.e. application/json
+ * @return true if operation returned 200, 201, 202, false otherwise
+ */
+ boolean put(DeviceId device, String request, InputStream payload, String mediaType);
+
+ /**
+ * Does a REST GET request with specified parameters to the device.
+ *
+ * @param device device to make the request to
+ * @param request url of the request
+ * @param mediaType format to retrieve the content in
+ * @return an inputstream of data from the reply.
+ */
+ InputStream get(DeviceId device, String request, String mediaType);
+
+ /**
+ * Does a REST DELETE request with specified parameters to the device.
+ *
+ * @param device device to make the request to
+ * @param request url of the request
+ * @param payload payload of the request as an InputStream
+ * @param mediaType type of content in the payload i.e. application/json
+ * @return true if operation returned 200 false otherwise
+ */
+ boolean delete(DeviceId device, String request, InputStream payload, String mediaType);
+
+}
diff --git a/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBDevice.java b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBDevice.java
new file mode 100644
index 0000000..6b76989
--- /dev/null
+++ b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/RestSBDevice.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2016 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.protocol.rest;
+
+import org.onlab.packet.IpAddress;
+import org.onosproject.net.DeviceId;
+
+/**
+ * Represents an abstraction of a Rest Device in ONOS.
+ */
+public interface RestSBDevice {
+ /**
+ * Returns the ip of this device.
+ *
+ * @return ip
+ */
+ IpAddress ip();
+
+ /**
+ * Returns the password of this device.
+ *
+ * @return port
+ */
+ int port();
+
+ /**
+ * Returns the name of this device.
+ *
+ * @return name
+ */
+ String name();
+
+ /**
+ * Returns the password of this device.
+ *
+ * @return password
+ */
+ String password();
+
+ /**
+ * Returns the ONOS deviceID for this device.
+ *
+ * @return DeviceId
+ */
+ DeviceId deviceId();
+
+ /**
+ * Sets or unsets the state of the device.
+ *
+ * @param active boolean
+ */
+ void setActive(boolean active);
+
+ /**
+ * Returns the state of this device.
+ *
+ * @return state
+ */
+ boolean isActive();
+
+ /**
+ * Returns the protocol for the REST request, usually HTTP o HTTPS.
+ *
+ * @return protocol
+ */
+ String protocol();
+
+}
diff --git a/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/package-info.java b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/package-info.java
new file mode 100644
index 0000000..a2ad7b6
--- /dev/null
+++ b/protocols/rest/api/src/main/java/org/onosproject/protocol/rest/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2016 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.
+ */
+
+/**
+ * REST southbound protocols libraries.
+ */
+package org.onosproject.protocol.rest;