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

   1 /*
   2  * Copyright (c) 2014 Contextream, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.lispflowmapping.type.sbplugin;
   9
  10 import java.net.InetAddress;
  11 import java.util.concurrent.Future;
  12
  13 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapNotify;
  14 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapReply;
  15 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.MapRequest;
  16 import org.opendaylight.yangtools.yang.binding.RpcService;
  17 import org.opendaylight.yangtools.yang.common.RpcResult;
  18
  19 /**
  20  * The southbound plugin interface.
  21  */
  22 public interface ILispSouthboundPlugin extends RpcService {
  23
  24     /**
  25      * Handle a map notify by sending it back to the xTR
  26      *
  27      * @param mapNotify
  28      * @param targetAddress
  29      * @return
  30      */
  31     Future<RpcResult<java.lang.Void>> handleMapNotify(MapNotify mapNotify, InetAddress targetAddress);
  32
  33     /**
  34      * Handle a map reply by sending it back to the xTR.
  35      *
  36      * @param mapReply
  37      * @param targetAddress
  38      * @return
  39      */
  40     Future<RpcResult<java.lang.Void>> handleMapReply(MapReply mapReply, InetAddress targetAddress);
  41
  42     /**
  43      * Handle a non proxy map request by sending it to the correct xTR.
  44      *
  45      * @param mapRequest
  46      * @param targetAddress
  47      * @return
  48      */
  49     Future<RpcResult<java.lang.Void>> handleMapRequest(MapRequest mapRequest, InetAddress targetAddress);
  50
  51 }