[ONOS-5607] Add LISP router, controller and listener interfaces
Change-Id: If01738d1b0e4e264618392844d96a9cf31cbd7c7
diff --git a/protocols/lisp/api/src/main/java/org/onosproject/lisp/ctl/LispRouter.java b/protocols/lisp/api/src/main/java/org/onosproject/lisp/ctl/LispRouter.java
new file mode 100644
index 0000000..a6fa99f
--- /dev/null
+++ b/protocols/lisp/api/src/main/java/org/onosproject/lisp/ctl/LispRouter.java
@@ -0,0 +1,83 @@
+/*
+ * Copyright 2016-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.lisp.ctl;
+
+import io.netty.channel.Channel;
+import org.onlab.packet.IpAddress;
+import org.onosproject.lisp.msg.protocols.LispMessage;
+import org.onosproject.net.Device;
+
+/**
+ * Represents to provider facing side of a router.
+ */
+public interface LispRouter {
+
+ /**
+ * Writes the LISP control message to the channel.
+ *
+ * @param msg the message to be written
+ */
+ void sendMessage(LispMessage msg);
+
+ /**
+ * Handles the LISP control message from the channel.
+ *
+ * @param msg the message to be handled
+ */
+ void handleMessage(LispMessage msg);
+
+ /**
+ * Returns the router device type.
+ *
+ * @return device type
+ */
+ Device.Type deviceType();
+
+ /**
+ * Identifies the channel used to communicate with the router.
+ *
+ * @return string representation of the connection to the device
+ */
+ String channelId();
+
+ /**
+ * Sets the associated Netty channel for this router.
+ *
+ * @param channel the Netty channel
+ */
+ void setChannel(Channel channel);
+
+ /**
+ * Obtains a string version of the ID for this router.
+ *
+ * @return string representation of the device identifier
+ */
+ String stringId();
+
+ /**
+ * Obtains an IpAddress version of the ID for this router.
+ *
+ * @return raw IP address of the device identifier
+ */
+ IpAddress routerId();
+
+ /**
+ * Checks if the router is connected.
+ *
+ * @return whether the router is connected
+ */
+ boolean isConnected();
+}