openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/AbstractService.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.Preconditions;
  11 import com.google.common.base.Verify;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import java.math.BigInteger;
  16 import java.util.Objects;
  17 import java.util.function.Function;
  18 import javax.annotation.Nonnull;
  19 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
  20 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceRegistry;
  23 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  25 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
  26 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
  27 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
  28 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  30 import org.opendaylight.yangtools.yang.binding.DataContainer;
  31 import org.opendaylight.yangtools.yang.common.RpcError;
  32 import org.opendaylight.yangtools.yang.common.RpcResult;
  33 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 abstract class AbstractService<I, O> {
  38     private static final Logger LOG = LoggerFactory.getLogger(AbstractService.class);
  39
  40     private final short version;
  41     private final BigInteger datapathId;
  42     private final RequestContextStack requestContextStack;
  43     private final DeviceContext deviceContext;
  44     private final MessageSpy messageSpy;
  45     private EventIdentifier eventIdentifier;
  46
  47     AbstractService(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
  48         final DeviceInfo deviceInfo = deviceContext.getDeviceInfo();
  49
  50         this.requestContextStack = requestContextStack;
  51         this.deviceContext = deviceContext;
  52         this.datapathId = deviceInfo.getDatapathId();
  53         this.version = deviceInfo.getVersion();
  54         this.messageSpy = deviceContext.getMessageSpy();
  55     }
  56
  57     public EventIdentifier getEventIdentifier() {
  58         return eventIdentifier;
  59     }
  60
  61     public void setEventIdentifier(final EventIdentifier eventIdentifier) {
  62         this.eventIdentifier = eventIdentifier;
  63     }
  64
  65     public short getVersion() {
  66         return version;
  67     }
  68
  69     public BigInteger getDatapathId() {
  70         return datapathId;
  71     }
  72
  73     public RequestContextStack getRequestContextStack() {
  74         return requestContextStack;
  75     }
  76
  77     @Deprecated
  78     public DeviceContext getDeviceContext() {
  79         return deviceContext;
  80     }
  81
  82     protected DeviceRegistry getDeviceRegistry() {
  83         return deviceContext;
  84     }
  85
  86     public DeviceInfo getDeviceInfo() {
  87         return deviceContext.getDeviceInfo();
  88     }
  89
  90     public TxFacade getTxFacade() {
  91         return deviceContext;
  92     }
  93
  94     public MessageSpy getMessageSpy() {
  95         return messageSpy;
  96     }
  97
  98     protected abstract OfHeader buildRequest(Xid xid, I input) throws ServiceException;
  99
 100     protected abstract FutureCallback<OfHeader> createCallback(RequestContext<O> context, Class<?> requestType);
 101
 102     public ListenableFuture<RpcResult<O>> handleServiceCall(@Nonnull final I input) {
 103         return handleServiceCall(input, null);
 104     }
 105
 106     public ListenableFuture<RpcResult<O>> handleServiceCall(@Nonnull final I input,
 107             @Nonnull final Function<OfHeader, Boolean> isComplete) {
 108         Preconditions.checkNotNull(input);
 109
 110         final Class<?> requestType;
 111         if (input instanceof DataContainer) {
 112             requestType = ((DataContainer) input).getImplementedInterface();
 113         } else {
 114             requestType = input.getClass();
 115         }
 116         getMessageSpy().spyMessage(requestType, MessageSpy.STATISTIC_GROUP.TO_SWITCH_ENTERED);
 117
 118         LOG.trace("Handling general service call");
 119         final RequestContext<O> requestContext = requestContextStack.createRequestContext();
 120         if (requestContext == null) {
 121             LOG.trace("Request context refused.");
 122             getMessageSpy().spyMessage(AbstractService.class, MessageSpy.STATISTIC_GROUP.TO_SWITCH_DISREGARDED);
 123             return failedFuture();
 124         }
 125
 126         if (requestContext.getXid() == null) {
 127             getMessageSpy().spyMessage(requestContext.getClass(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_RESERVATION_REJECTED);
 128             return RequestContextUtil.closeRequestContextWithRpcError(requestContext, "Outbound queue wasn't able to reserve XID.");
 129         }
 130
 131         getMessageSpy().spyMessage(requestContext.getClass(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_READY_FOR_SUBMIT);
 132
 133         final Xid xid = requestContext.getXid();
 134         OfHeader request = null;
 135         try {
 136             request = buildRequest(xid, input);
 137             Verify.verify(xid.getValue().equals(request.getXid()), "Expected XID %s got %s", xid.getValue(), request.getXid());
 138         } catch (Exception ex) {
 139             LOG.error("Failed to build request for {}, forfeiting request {}", input, xid.getValue(), ex);
 140             RequestContextUtil.closeRequestContextWithRpcError(requestContext, "failed to build request input: " + ex.getMessage());
 141         } finally {
 142             final OutboundQueue outboundQueue = getDeviceContext().getPrimaryConnectionContext().getOutboundQueueProvider();
 143
 144             if (Objects.nonNull(isComplete)) {
 145                 outboundQueue.commitEntry(xid.getValue(), request, createCallback(requestContext, requestType), isComplete);
 146             } else {
 147                 outboundQueue.commitEntry(xid.getValue(), request, createCallback(requestContext, requestType));
 148             }
 149         }
 150
 151         return requestContext.getFuture();
 152     }
 153
 154     protected static <T> ListenableFuture<RpcResult<T>> failedFuture() {
 155         final RpcResult<T> rpcResult = RpcResultBuilder.<T>failed()
 156             .withError(RpcError.ErrorType.APPLICATION, "", "Request quota exceeded").build();
 157         return Futures.immediateFuture(rpcResult);
 158     }
 159 }