External api proposal
[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / session / MessageDispatchServiceImpl.java
index 610e7d340b4350a9e2c5f0cb37999f2fd2fa386f..f3c122b723e16da42da360d701c3278c4b894376 100644 (file)
@@ -7,73 +7,53 @@
  */
 package org.opendaylight.openflowplugin.openflow.md.core.session;
 
-import java.math.BigInteger;
-import java.util.concurrent.Future;
+import com.google.common.base.Function;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.JdkFutureAdapters;
+import com.google.common.util.concurrent.ListenableFuture;
 
-import org.opendaylight.controller.sal.common.util.Rpcs;
 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
-import org.opendaylight.openflowplugin.openflow.md.core.ConnectionConductor;
-import org.opendaylight.openflowplugin.openflow.md.core.SwitchConnectionDistinguisher;
+import org.opendaylight.openflowplugin.ConnectionException;
+import org.opendaylight.openflowplugin.api.openflow.md.core.ConnectionConductor;
+import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
+import org.opendaylight.openflowplugin.api.openflow.md.core.session.IMessageDispatchService;
+import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
+import org.opendaylight.openflowplugin.openflow.md.util.RpcResultUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutputBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterOutputBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MeterModInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketOutInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortModInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestOutput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetAsyncInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.TableModInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.*;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.UpdatePortOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.UpdatePortOutputBuilder;
 import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Function;
-import com.google.common.util.concurrent.Futures;
-import com.google.common.util.concurrent.JdkFutureAdapters;
-import com.google.common.util.concurrent.ListenableFuture;
+import java.math.BigInteger;
+import java.util.concurrent.Future;
 
 /**
  * message dispatch service to send the message to switch.
  *
  * @author AnilGujele
- *
  */
 public class MessageDispatchServiceImpl implements IMessageDispatchService {
 
     private static final Logger LOG = LoggerFactory.getLogger(MessageDispatchServiceImpl.class);
-
-    private SessionContext session;    
+    private SessionContext session;
 
     /**
      * constructor
      *
-     * @param session
-     *            - MessageDispatchService for this session
+     * @param session - MessageDispatchService for this session
      */
     public MessageDispatchServiceImpl(SessionContext session) {
-        this.session = session;        
+        this.session = session;
     }
 
     /**
@@ -81,16 +61,14 @@ public class MessageDispatchServiceImpl implements IMessageDispatchService {
      *
      * @param cookie to identify the right connection, it can be null also.
      * @return connectionAdapter associated with cookie, otherwise return best
-     *         suitable connection.
-     *
+     * suitable connection.
      */
 
-    private ConnectionAdapter getConnectionAdapter(SwitchConnectionDistinguisher cookie) {
+    private ConnectionAdapter getConnectionAdapter(SwitchConnectionDistinguisher cookie) throws ConnectionException {
 
         if (!session.isValid()) {
-            LOG.warn("Session for the cookie {} is invalid.", cookie);
-            throw new IllegalArgumentException("Session for the cookie is invalid. Reason: "
-                    + "the switch has been recently disconnected OR inventory provides outdated information.");
+            LOG.warn("No valid connection found for the node [datapath-id : {}]", session.getSessionKey().getId());
+            throw new ConnectionException(CONNECTION_ERROR_MESSAGE);
         }
         LOG.debug("finding connecton for cookie value {}. ", cookie);
         // set main connection as default
@@ -109,167 +87,240 @@ public class MessageDispatchServiceImpl implements IMessageDispatchService {
     }
 
     @Override
-    public Future<RpcResult<BarrierOutput>> barrier(BarrierInput input, SwitchConnectionDistinguisher cookie) {  
-        return getConnectionAdapter(cookie).barrier(input);
+    public Future<RpcResult<BarrierOutput>> barrier(BarrierInput input, SwitchConnectionDistinguisher cookie) {
+        try {
+            return getConnectionAdapter(cookie).barrier(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<Void>> experimenter(ExperimenterInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).experimenter(input);
+        try {
+            return getConnectionAdapter(cookie).experimenter(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<UpdateFlowOutput>> flowMod(final FlowModInput input, SwitchConnectionDistinguisher cookie) {
         LOG.debug("Calling OFLibrary flowMod");
-        Future<RpcResult<Void>> response = getConnectionAdapter(cookie).flowMod(input);
+        Future<RpcResult<Void>> response = null;
+        try {
+            response = getConnectionAdapter(cookie).flowMod(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
 
         // appending xid
         ListenableFuture<RpcResult<UpdateFlowOutput>> xidResult = Futures.transform(
-                JdkFutureAdapters.listenInPoolThread(response), 
-                new Function<RpcResult<Void>,RpcResult<UpdateFlowOutput>>() {
-
-            @Override
-            public RpcResult<UpdateFlowOutput> apply(final RpcResult<Void> inputArg) {
-                UpdateFlowOutputBuilder flowModOutput = new UpdateFlowOutputBuilder();        
-                BigInteger bigIntXid = BigInteger.valueOf(input.getXid()) ;
-                flowModOutput.setTransactionId(new TransactionId(bigIntXid));
-
-                UpdateFlowOutput result = flowModOutput.build();
-                RpcResult<UpdateFlowOutput> rpcResult = Rpcs.getRpcResult(
-                        inputArg.isSuccessful(), result, inputArg.getErrors());
-                return rpcResult;
-            }
-        });
-        
+                JdkFutureAdapters.listenInPoolThread(response),
+                new Function<RpcResult<Void>, RpcResult<UpdateFlowOutput>>() {
+
+                    @Override
+                    public RpcResult<UpdateFlowOutput> apply(final RpcResult<Void> inputArg) {
+                        UpdateFlowOutputBuilder flowModOutput = new UpdateFlowOutputBuilder();
+                        BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
+                        flowModOutput.setTransactionId(new TransactionId(bigIntXid));
+
+                        UpdateFlowOutput result = flowModOutput.build();
+                        RpcResult<UpdateFlowOutput> rpcResult = RpcResultBuilder
+                                .<UpdateFlowOutput>status(inputArg.isSuccessful())
+                                .withResult(result).withRpcErrors(inputArg.getErrors())
+                                .build();
+                        return rpcResult;
+                    }
+                });
+
         return xidResult;
     }
 
     @Override
     public Future<RpcResult<GetAsyncOutput>> getAsync(GetAsyncInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).getAsync(input);
+        try {
+            return getConnectionAdapter(cookie).getAsync(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<GetConfigOutput>> getConfig(GetConfigInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).getConfig(input);
+        try {
+            return getConnectionAdapter(cookie).getConfig(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<GetFeaturesOutput>> getFeatures(GetFeaturesInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).getFeatures(input);
+        try {
+            return getConnectionAdapter(cookie).getFeatures(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<GetQueueConfigOutput>> getQueueConfig(GetQueueConfigInput input,
-            SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).getQueueConfig(input);
+                                                                  SwitchConnectionDistinguisher cookie) {
+        try {
+            return getConnectionAdapter(cookie).getQueueConfig(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
-    public Future<RpcResult<UpdateGroupOutput>> groupMod(final GroupModInput input, SwitchConnectionDistinguisher cookie) {        
+    public Future<RpcResult<UpdateGroupOutput>> groupMod(final GroupModInput input, SwitchConnectionDistinguisher cookie) {
         LOG.debug("Calling OFLibrary groupMod");
-        Future<RpcResult<Void>> response = getConnectionAdapter(cookie).groupMod(input);
+        Future<RpcResult<Void>> response = null;
+        try {
+            response = getConnectionAdapter(cookie).groupMod(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
 
         // appending xid
         ListenableFuture<RpcResult<UpdateGroupOutput>> xidResult = Futures.transform(
-                JdkFutureAdapters.listenInPoolThread(response), 
-                new Function<RpcResult<Void>,RpcResult<UpdateGroupOutput>>() {
-
-            @Override
-            public RpcResult<UpdateGroupOutput> apply(final RpcResult<Void> inputArg) {
-                UpdateGroupOutputBuilder groupModOutput = new UpdateGroupOutputBuilder();      
-                BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
-                groupModOutput.setTransactionId(new TransactionId(bigIntXid));
-
-                UpdateGroupOutput result = groupModOutput.build();
-                RpcResult<UpdateGroupOutput> rpcResult = Rpcs.getRpcResult(
-                        inputArg.isSuccessful(), result, inputArg.getErrors());
-                return rpcResult;
-            }
-        });
-        
+                JdkFutureAdapters.listenInPoolThread(response),
+                new Function<RpcResult<Void>, RpcResult<UpdateGroupOutput>>() {
+
+                    @Override
+                    public RpcResult<UpdateGroupOutput> apply(final RpcResult<Void> inputArg) {
+                        UpdateGroupOutputBuilder groupModOutput = new UpdateGroupOutputBuilder();
+                        BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
+                        groupModOutput.setTransactionId(new TransactionId(bigIntXid));
+
+                        UpdateGroupOutput result = groupModOutput.build();
+                        RpcResult<UpdateGroupOutput> rpcResult = RpcResultBuilder
+                                .<UpdateGroupOutput>status(inputArg.isSuccessful()).withResult(result)
+                                .withRpcErrors(inputArg.getErrors()).build();
+                        return rpcResult;
+                    }
+                });
+
         return xidResult;
     }
 
     @Override
     public Future<RpcResult<UpdateMeterOutput>> meterMod(final MeterModInput input, SwitchConnectionDistinguisher cookie) {
         LOG.debug("Calling OFLibrary meterMod");
-        Future<RpcResult<Void>> response = getConnectionAdapter(cookie).meterMod(input);
+        Future<RpcResult<Void>> response = null;
+        try {
+            response = getConnectionAdapter(cookie).meterMod(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
 
         // appending xid
         ListenableFuture<RpcResult<UpdateMeterOutput>> xidResult = Futures.transform(
-                JdkFutureAdapters.listenInPoolThread(response), 
-                new Function<RpcResult<Void>,RpcResult<UpdateMeterOutput>>() {
-
-            @Override
-            public RpcResult<UpdateMeterOutput> apply(final RpcResult<Void> inputArg) {
-                UpdateMeterOutputBuilder meterModOutput = new UpdateMeterOutputBuilder();       
-                BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
-                meterModOutput.setTransactionId(new TransactionId(bigIntXid));
-                
-                UpdateMeterOutput result = meterModOutput.build();
-                RpcResult<UpdateMeterOutput> rpcResult = Rpcs.getRpcResult(
-                        inputArg.isSuccessful(), result, inputArg.getErrors());
-                return rpcResult;
-            }
-        });
-        
+                JdkFutureAdapters.listenInPoolThread(response),
+                new Function<RpcResult<Void>, RpcResult<UpdateMeterOutput>>() {
+
+                    @Override
+                    public RpcResult<UpdateMeterOutput> apply(final RpcResult<Void> inputArg) {
+                        UpdateMeterOutputBuilder meterModOutput = new UpdateMeterOutputBuilder();
+                        BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
+                        meterModOutput.setTransactionId(new TransactionId(bigIntXid));
+
+                        UpdateMeterOutput result = meterModOutput.build();
+                        RpcResult<UpdateMeterOutput> rpcResult = RpcResultBuilder
+                                .<UpdateMeterOutput>status(inputArg.isSuccessful()).withResult(result)
+                                .withRpcErrors(inputArg.getErrors()).build();
+                        return rpcResult;
+                    }
+                });
+
         return xidResult;
     }
 
     @Override
     public Future<RpcResult<java.lang.Void>> multipartRequest(MultipartRequestInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).multipartRequest(input);
+        try {
+            return getConnectionAdapter(cookie).multipartRequest(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<Void>> packetOut(PacketOutInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).packetOut(input);
+        try {
+            return getConnectionAdapter(cookie).packetOut(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<UpdatePortOutput>> portMod(final PortModInput input, SwitchConnectionDistinguisher cookie) {
         LOG.debug("Calling OFLibrary portMod");
-        Future<RpcResult<Void>> response = getConnectionAdapter(cookie).portMod(input);
-        
+        Future<RpcResult<Void>> response = null;
+        try {
+            response = getConnectionAdapter(cookie).portMod(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
+
         // appending xid
         ListenableFuture<RpcResult<UpdatePortOutput>> xidResult = Futures.transform(
-                JdkFutureAdapters.listenInPoolThread(response), 
-                new Function<RpcResult<Void>,RpcResult<UpdatePortOutput>>() {
-
-            @Override
-            public RpcResult<UpdatePortOutput> apply(final RpcResult<Void> inputArg) {
-                UpdatePortOutputBuilder portModOutput = new UpdatePortOutputBuilder();
-                BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
-                portModOutput.setTransactionId(new TransactionId(bigIntXid));
-                
-                UpdatePortOutput result = portModOutput.build();
-                RpcResult<UpdatePortOutput> rpcResult = Rpcs.getRpcResult(
-                        inputArg.isSuccessful(), result, inputArg.getErrors());
-                return rpcResult;
-            }
-        });
-        
+                JdkFutureAdapters.listenInPoolThread(response),
+                new Function<RpcResult<Void>, RpcResult<UpdatePortOutput>>() {
+
+                    @Override
+                    public RpcResult<UpdatePortOutput> apply(final RpcResult<Void> inputArg) {
+                        UpdatePortOutputBuilder portModOutput = new UpdatePortOutputBuilder();
+                        BigInteger bigIntXid = BigInteger.valueOf(input.getXid());
+                        portModOutput.setTransactionId(new TransactionId(bigIntXid));
+
+                        UpdatePortOutput result = portModOutput.build();
+                        RpcResult<UpdatePortOutput> rpcResult = RpcResultBuilder
+                                .<UpdatePortOutput>status(inputArg.isSuccessful()).withResult(result)
+                                .withRpcErrors(inputArg.getErrors()).build();
+                        return rpcResult;
+                    }
+                });
+
         return xidResult;
     }
 
     @Override
     public Future<RpcResult<RoleRequestOutput>> roleRequest(RoleRequestInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).roleRequest(input);
+        try {
+            return getConnectionAdapter(cookie).roleRequest(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<Void>> setAsync(SetAsyncInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).setAsync(input);
+        try {
+            return getConnectionAdapter(cookie).setAsync(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<Void>> setConfig(SetConfigInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).setConfig(input);
+        try {
+            return getConnectionAdapter(cookie).setConfig(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 
     @Override
     public Future<RpcResult<Void>> tableMod(TableModInput input, SwitchConnectionDistinguisher cookie) {
-        return getConnectionAdapter(cookie).tableMod(input);
+        try {
+            return getConnectionAdapter(cookie).tableMod(input);
+        } catch (ConnectionException e) {
+            return RpcResultUtil.getRpcErrorFuture(e);
+        }
     }
 }