Merge branch 'release-1.0.X' into develop

[lispflowmapping.git] / mappingservice / api / src / main / java / org / opendaylight / lispflowmapping / type / sbplugin / ILispSouthboundPlugin.java

diff --git a/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/type/sbplugin/ILispSouthboundPlugin.java b/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/type/sbplugin/ILispSouthboundPlugin.java
index 56c1e106112d41284c4200b82c19985f0125a02a..be8b799d884fc55e6c295c6f0b02dc916d285e23 100644 (file)
--- a/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/type/sbplugin/ILispSouthboundPlugin.java
+++ b/mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/type/sbplugin/ILispSouthboundPlugin.java
@@ -1,17 +1,51 @@
+/*
+ * Copyright (c) 2014 Contextream, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.lispflowmapping.type.sbplugin;
 
 import java.net.InetAddress;
 import java.util.concurrent.Future;
 
-import org.opendaylight.lispflowmapping.type.lisp.MapNotify;
-import org.opendaylight.lispflowmapping.type.lisp.MapReply;
+import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapNotify;
+import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapReply;
+import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapRequest;
 import org.opendaylight.yangtools.yang.binding.RpcService;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 
+/**
+ * The southbound plugin interface.
+ */
 public interface ILispSouthboundPlugin extends RpcService {
 
+    /**
+     * Handle a map notify by sending it back to the xTR
+     * 
+     * @param mapNotify
+     * @param targetAddress
+     * @return
+     */
     Future<RpcResult<java.lang.Void>> handleMapNotify(MapNotify mapNotify, InetAddress targetAddress);
 
+    /**
+     * Handle a map reply by sending it back to the xTR.
+     * 
+     * @param mapReply
+     * @param targetAddress
+     * @return
+     */
     Future<RpcResult<java.lang.Void>> handleMapReply(MapReply mapReply, InetAddress targetAddress);
 
+    /**
+     * Handle a non proxy map request by sending it to the correct xTR.
+     * 
+     * @param mapRequest
+     * @param targetAddress
+     * @return
+     */
+    Future<RpcResult<java.lang.Void>> handleMapRequest(MapRequest mapRequest, InetAddress targetAddress);
+
 }
\ No newline at end of file