openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/rpc/RpcContextImpl.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.impl.rpc;
   9
  10 import com.google.common.util.concurrent.SettableFuture;
  11 import java.util.Collection;
  12 import java.util.HashSet;
  13 import javax.annotation.concurrent.GuardedBy;
  14 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
  15 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  16 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  17 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  18 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  19 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  23 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.binding.RpcService;
  25 import org.opendaylight.yangtools.yang.common.RpcError;
  26 import org.opendaylight.yangtools.yang.common.RpcResult;
  27 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  28 import org.slf4j.Logger;
  29
  30 public class RpcContextImpl implements RpcContext {
  31     private static final Logger LOG = org.slf4j.LoggerFactory.getLogger(RpcContextImpl.class);
  32     private MessageSpy messagSpy;
  33     final RpcProviderRegistry rpcProviderRegistry;
  34
  35     // TODO: add private Sal salBroker
  36     private final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier;
  37     private final Collection<RoutedRpcRegistration<?>> rpcRegistrations = new HashSet<>();
  38
  39
  40     @GuardedBy("requestsList")
  41     private final Collection<RequestContext<?>> requestsList = new HashSet<RequestContext<?>>();
  42
  43     private int maxRequestsPerDevice;
  44
  45     public RpcContextImpl(final MessageSpy messagSpy, final RpcProviderRegistry rpcProviderRegistry, final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier) {
  46         this.messagSpy = messagSpy;
  47         this.rpcProviderRegistry = rpcProviderRegistry;
  48         this.nodeInstanceIdentifier = nodeInstanceIdentifier;
  49     }
  50
  51     /**
  52      * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#registerRpcServiceImplementation(java.lang.Class,
  53      * org.opendaylight.yangtools.yang.binding.RpcService)
  54      */
  55     @Override
  56     public <S extends RpcService> void registerRpcServiceImplementation(final Class<S> serviceClass,
  57                                                                         final S serviceInstance) {
  58         final RoutedRpcRegistration<S> routedRpcReg = rpcProviderRegistry.addRoutedRpcImplementation(serviceClass, serviceInstance);
  59         routedRpcReg.registerPath(NodeContext.class, nodeInstanceIdentifier);
  60         rpcRegistrations.add(routedRpcReg);
  61         LOG.debug("Registration of service {} for device {}.", serviceClass, nodeInstanceIdentifier);
  62     }
  63
  64     @Override
  65     public <T> SettableFuture<RpcResult<T>> storeOrFail(final RequestContext<T> requestContext) {
  66         final SettableFuture<RpcResult<T>> rpcResultFuture = requestContext.getFuture();
  67
  68         final boolean success;
  69         // FIXME: use a fixed-size collection, with lockless reserve/set queue
  70         synchronized (requestsList) {
  71             if (requestsList.size() < maxRequestsPerDevice) {
  72                 requestsList.add(requestContext);
  73                 success = true;
  74             } else {
  75                 success = false;
  76             }
  77         }
  78
  79         if (!success) {
  80             final RpcResult<T> rpcResult = RpcResultBuilder.<T>failed()
  81                     .withError(RpcError.ErrorType.APPLICATION, "", "Device's request queue is full.").build();
  82             rpcResultFuture.set(rpcResult);
  83         }
  84
  85         return rpcResultFuture;
  86     }
  87
  88     /**
  89      * Unregisters all services.
  90      *
  91      * @see java.lang.AutoCloseable#close()
  92      */
  93     @Override
  94     public void close() throws Exception {
  95         for (final RoutedRpcRegistration<?> rpcRegistration : rpcRegistrations) {
  96             rpcRegistration.unregisterPath(NodeContext.class, nodeInstanceIdentifier);
  97             rpcRegistration.close();
  98         }
  99     }
 100
 101     /**
 102      * @see org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext#setRequestContextQuota(int)
 103      */
 104     @Override
 105     public void setRequestContextQuota(final int maxRequestsPerDevice) {
 106         this.maxRequestsPerDevice = maxRequestsPerDevice;
 107     }
 108
 109     @Override
 110     public <T> void forgetRequestContext(final RequestContext<T> requestContext) {
 111         synchronized (requestsList) {
 112             requestsList.remove(requestContext);
 113             LOG.trace("Removed request context with xid {}. Context request in list {}.",
 114                     requestContext.getXid().getValue(), requestsList.size());
 115             messagSpy.spyMessage(RpcContextImpl.class, MessageSpy.STATISTIC_GROUP.REQUEST_STACK_FREED);
 116         }
 117     }
 118
 119     @Override
 120     public <T> RequestContext<T> createRequestContext() {
 121         return new RequestContextImpl<T>(this);
 122     }
 123
 124     @Override
 125     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
 126         for (RoutedRpcRegistration<?> registration : rpcRegistrations) {
 127             registration.close();
 128         }
 129
 130         synchronized (requestsList) {
 131             requestsList.clear();
 132         }
 133     }
 134 }