openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/rpc/RpcContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, 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.openflowplugin.api.openflow.rpc;
   9
  10 import com.google.common.util.concurrent.SettableFuture;
  11 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  12 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  13 import org.opendaylight.yangtools.yang.binding.DataObject;
  14 import org.opendaylight.yangtools.yang.binding.RpcService;
  15 import org.opendaylight.yangtools.yang.common.RpcResult;
  16 import java.util.concurrent.Future;
  17
  18 /**
  19  * This context is registered with MD-SAL as a routed RPC provider for the inventory node backed by this switch and
  20  * tracks the state of any user requests and how they map onto protocol requests. It uses
  21  * {@link org.opendaylight.openflowplugin.api.openflow.device.RequestContext} to perform requests.
  22  * <p/>
  23  * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
  24  */
  25 public interface RpcContext extends AutoCloseable {
  26
  27     <S extends RpcService> void registerRpcServiceImplementation(Class<S> serviceClass, S serviceInstance);
  28
  29     /**
  30      *  Method adds request to request queue which has limited quota. After number of requests exceeds quota limit
  31      *  future will be done immediately and will contain information about exceeded request quota.
  32      *
  33      * @param data
  34      */
  35     <T extends DataObject> SettableFuture<RpcResult<T>> storeOrFail(RequestContext data);
  36
  37     /**
  38      * Method for setting request quota value. When the Request Context quota is exceeded, incoming RPCs fail
  39      * immediately, with a well-defined error.
  40      *
  41      * @param maxRequestsPerDevice
  42      */
  43     void setRequestContextQuota(int maxRequestsPerDevice);
  44
  45     void forgetRequestContext(RequestContext requestContext);
  46
  47     /**
  48      * Method provides device context.
  49      * @return
  50      */
  51     DeviceContext getDeviceContext();
  52
  53     /**
  54      * Method returns new request context for current request.
  55      * @return
  56      */
  57     <T extends DataObject> RequestContext createRequestContext();
  58
  59 }