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