2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.openflowplugin.impl.services;
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 javax.annotation.Nullable;
20 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceRegistry;
24 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
25 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
26 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
27 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
28 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
29 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
30 import org.opendaylight.openflowplugin.impl.services.util.RequestContextUtil;
31 import org.opendaylight.openflowplugin.impl.services.util.ServiceException;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
33 import org.opendaylight.yangtools.yang.binding.DataContainer;
34 import org.opendaylight.yangtools.yang.common.RpcError;
35 import org.opendaylight.yangtools.yang.common.RpcResult;
36 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 public abstract class AbstractService<I, O> {
41 private static final Logger LOG = LoggerFactory.getLogger(AbstractService.class);
43 private final short version;
44 private final BigInteger datapathId;
45 private final RequestContextStack requestContextStack;
46 private final DeviceContext deviceContext;
47 private final MessageSpy messageSpy;
48 private EventIdentifier eventIdentifier;
50 AbstractService(final RequestContextStack requestContextStack, final DeviceContext deviceContext) {
51 final DeviceInfo deviceInfo = deviceContext.getDeviceInfo();
53 this.requestContextStack = requestContextStack;
54 this.deviceContext = deviceContext;
55 this.datapathId = deviceInfo.getDatapathId();
56 this.version = deviceInfo.getVersion();
57 this.messageSpy = deviceContext.getMessageSpy();
60 public boolean canUseSingleLayerSerialization() {
61 return deviceContext.canUseSingleLayerSerialization();
64 public EventIdentifier getEventIdentifier() {
65 return eventIdentifier;
68 public void setEventIdentifier(final EventIdentifier eventIdentifier) {
69 this.eventIdentifier = eventIdentifier;
72 public short getVersion() {
76 public BigInteger getDatapathId() {
80 public RequestContextStack getRequestContextStack() {
81 return requestContextStack;
85 public DeviceContext getDeviceContext() {
89 public DeviceRegistry getDeviceRegistry() {
93 public DeviceInfo getDeviceInfo() {
94 return deviceContext.getDeviceInfo();
97 public TxFacade getTxFacade() {
101 public MessageSpy getMessageSpy() {
105 protected abstract OfHeader buildRequest(Xid xid, I input) throws ServiceException;
107 protected abstract FutureCallback<OfHeader> createCallback(RequestContext<O> context, Class<?> requestType);
109 public ListenableFuture<RpcResult<O>> handleServiceCall(@Nonnull final I input) {
110 return handleServiceCall(input, null);
113 public ListenableFuture<RpcResult<O>> handleServiceCall(@Nonnull final I input,
114 @Nullable final Function<OfHeader, Boolean> isComplete) {
115 Preconditions.checkNotNull(input);
117 final Class<?> requestType = input instanceof DataContainer
118 ? ((DataContainer) input).getImplementedInterface()
121 getMessageSpy().spyMessage(requestType, MessageSpy.StatisticsGroup.TO_SWITCH_ENTERED);
123 LOG.trace("Handling general service call");
124 final RequestContext<O> requestContext = requestContextStack.createRequestContext();
126 if (Objects.isNull(requestContext)) {
127 LOG.trace("Request context refused.");
128 getMessageSpy().spyMessage(AbstractService.class, MessageSpy.StatisticsGroup.TO_SWITCH_DISREGARDED);
129 return Futures.immediateFuture(RpcResultBuilder
131 .withError(RpcError.ErrorType.APPLICATION, "", "Request quota exceeded")
135 if (Objects.isNull(requestContext.getXid())) {
136 getMessageSpy().spyMessage(requestContext.getClass(),
137 MessageSpy.StatisticsGroup.TO_SWITCH_RESERVATION_REJECTED);
138 return RequestContextUtil
139 .closeRequestContextWithRpcError(requestContext, "Outbound queue wasn't able to reserve XID.");
142 getMessageSpy().spyMessage(requestContext.getClass(), MessageSpy.StatisticsGroup.TO_SWITCH_READY_FOR_SUBMIT);
144 final Xid xid = requestContext.getXid();
145 OfHeader request = null;
147 request = buildRequest(xid, input);
148 Verify.verify(xid.getValue().equals(request.getXid()),
149 "Expected XID %s got %s",
152 } catch (ServiceException ex) {
153 LOG.error("Failed to build request for {}, forfeiting request {}", input, xid.getValue(), ex);
154 RequestContextUtil.closeRequestContextWithRpcError(requestContext,
155 "failed to build request input: " + ex.getMessage());
157 final OutboundQueue outboundQueue =
158 getDeviceContext().getPrimaryConnectionContext().getOutboundQueueProvider();
160 if (Objects.nonNull(isComplete)) {
161 outboundQueue.commitEntry(xid.getValue(),
163 createCallback(requestContext, requestType), isComplete);
165 outboundQueue.commitEntry(xid.getValue(), request, createCallback(requestContext, requestType));
169 return requestContext.getFuture();