openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/CommonService.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.services;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.util.concurrent.Futures;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.math.BigInteger;
  14 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
  15 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  16 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  17 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  18 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  19 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  20 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  22 import org.opendaylight.yangtools.yang.common.RpcError;
  23 import org.opendaylight.yangtools.yang.common.RpcResult;
  24 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  25 import org.slf4j.Logger;
  26
  27 public abstract class CommonService {
  28     private static final Logger LOG = org.slf4j.LoggerFactory.getLogger(CommonService.class);
  29     private static final long WAIT_TIME = 2000;
  30     private static final BigInteger PRIMARY_CONNECTION = BigInteger.ZERO;
  31
  32     private final short version;
  33     private final BigInteger datapathId;
  34     private final RequestContextStack requestContextStack;
  35     private final DeviceContext deviceContext;
  36     private final ConnectionAdapter primaryConnectionAdapter;
  37     private final MessageSpy messageSpy;
  38
  39
  40     public CommonService(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
  41         this.requestContextStack = requestContextStack;
  42         this.deviceContext = deviceContext;
  43         final FeaturesReply features = this.deviceContext.getPrimaryConnectionContext().getFeatures();
  44         this.datapathId = features.getDatapathId();
  45         this.version = features.getVersion();
  46         this.primaryConnectionAdapter = deviceContext.getPrimaryConnectionContext().getConnectionAdapter();
  47         this.messageSpy = deviceContext.getMessageSpy();
  48     }
  49
  50     public static BigInteger getPrimaryConnection() {
  51         return PRIMARY_CONNECTION;
  52     }
  53
  54     public short getVersion() {
  55         return version;
  56     }
  57
  58     public BigInteger getDatapathId() {
  59         return datapathId;
  60     }
  61
  62     public RequestContextStack getRequestContextStack() {
  63         return requestContextStack;
  64     }
  65
  66     public DeviceContext getDeviceContext() {
  67         return deviceContext;
  68     }
  69
  70     public ConnectionAdapter getPrimaryConnectionAdapter() {
  71         return primaryConnectionAdapter;
  72     }
  73
  74     public MessageSpy getMessageSpy() {
  75         return messageSpy;
  76     }
  77
  78     protected long provideWaitTime() {
  79         return WAIT_TIME;
  80     }
  81
  82
  83     protected ConnectionAdapter provideConnectionAdapter(final BigInteger connectionID) {
  84         if (connectionID == null) {
  85             return primaryConnectionAdapter;
  86         }
  87         if (connectionID.equals(PRIMARY_CONNECTION)) {
  88             return primaryConnectionAdapter;
  89         }
  90
  91         final ConnectionContext auxiliaryConnectionContext =
  92                 deviceContext.getAuxiliaryConnectiobContexts(connectionID);
  93         if (auxiliaryConnectionContext != null) {
  94             return auxiliaryConnectionContext.getConnectionAdapter();
  95         }
  96
  97         return primaryConnectionAdapter;
  98     }
  99
 100     /**
 101      * @param connectionID connection identifier
 102      * @param function     data sender
 103      * @param <T>          rpc result backend type
 104      * @param <F>          final rpc backend type
 105      * @return
 106      */
 107     public <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final BigInteger connectionID,
 108                                                                    final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
 109         DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder();
 110         return handleServiceCall(function, dataCrateBuilder);
 111     }
 112
 113     public <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function) {
 114         DataCrateBuilder<T> dataCrateBuilder = DataCrateBuilder.<T>builder();
 115         return handleServiceCall(function, dataCrateBuilder);
 116     }
 117
 118     /**
 119      * @param <T>
 120      * @param <F>
 121      * @param function
 122      * @param dataCrateBuilder predefined data
 123      * @return
 124      */
 125     public final <T, F> ListenableFuture<RpcResult<T>> handleServiceCall(final Function<DataCrate<T>, ListenableFuture<RpcResult<F>>> function,
 126                                                                          final DataCrateBuilder<T> dataCrateBuilder) {
 127
 128         LOG.trace("Handling general service call");
 129         final RequestContext<T> requestContext = createRequestContext();
 130         if (requestContext == null) {
 131             LOG.trace("Request context refused.");
 132             deviceContext.getMessageSpy().spyMessage(null, MessageSpy.STATISTIC_GROUP.TO_SWITCH_DISREGARDED);
 133             return failedFuture();
 134         }
 135
 136         Long reservedXid = deviceContext.getReservedXid();
 137         if (null == reservedXid) {
 138             //retry
 139             reservedXid = deviceContext.getReservedXid();
 140             if (null == reservedXid) {
 141                 deviceContext.getMessageSpy().spyMessage(requestContext.getClass(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_RESERVATION_REJECTED);
 142                 return RequestContextUtil.closeRequestContextWithRpcError(requestContext, "Outbound queue wasn't able to reserve XID.");
 143             }
 144         }
 145         final Xid xid = new Xid(reservedXid);
 146         requestContext.setXid(xid);
 147         DataCrate<T> dataCrate = dataCrateBuilder.setRequestContext(requestContext)
 148                 .build();
 149         final ListenableFuture<RpcResult<F>> resultFromOFLib;
 150
 151         LOG.trace("Hooking xid {} to device context - precaution.", requestContext.getXid().getValue());
 152         deviceContext.hookRequestCtx(xid, requestContext);
 153
 154         messageSpy.spyMessage(requestContext.getClass(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_READY_FOR_SUBMIT);
 155         function.apply(dataCrate);
 156
 157         return requestContext.getFuture();
 158
 159     }
 160
 161     protected final <T> RequestContext<T> createRequestContext() {
 162         return requestContextStack.createRequestContext();
 163     }
 164
 165     protected static <T> ListenableFuture<RpcResult<T>> failedFuture() {
 166         final RpcResult<T> rpcResult = RpcResultBuilder.<T>failed()
 167                 .withError(RpcError.ErrorType.APPLICATION, "", "Request quota exceeded").build();
 168         return Futures.immediateFuture(rpcResult);
 169     }
 170 }