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