Remove duplicated treatment building from GroupBucketEntryBuilder

Change-Id: I0f956dd11d990209eb3dc00c866dd535843506ea

providers/openflow/flow/src/main/java/org/onosproject/provider/of/flow/impl/FlowEntryBuilder.java

@@ -91,6 +91,7 @@ import org.projectfloodlight.openflow.types.U64;
 import org.projectfloodlight.openflow.types.U8;
 import org.projectfloodlight.openflow.types.VlanPcp;
 import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.List;
 
@@ -104,10 +105,9 @@ import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupCh
 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupGridType;
 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupOchSignalType;
 import static org.onosproject.provider.of.flow.impl.OpenFlowValueMapper.lookupOduSignalType;
-import static org.slf4j.LoggerFactory.getLogger;
 
 public class FlowEntryBuilder {
-    private final Logger log = getLogger(getClass());
+    private static final Logger log = LoggerFactory.getLogger(FlowEntryBuilder.class);
 
     private final OFFlowStatsEntry stat;
     private final OFFlowRemoved removed;
@@ -289,14 +289,24 @@ public class FlowEntryBuilder {
         return builder.build();
     }
 
-    private TrafficTreatment.Builder buildActions(List<OFAction> actions,
+    /**
-                                                  TrafficTreatment.Builder builder) {
+     * Configures traffic treatment builder with a given collection of actions.
-        DriverHandler driverHandler = getDriver(deviceId);
+     *
-        ExtensionTreatmentInterpreter treatmentInterpreter;
+     * @param actions a set of OpenFlow actions
+     * @param builder traffic treatment builder
+     * @param driverHandler driver handler
+     * @param deviceId device identifier
+     * @return configured traffic treatment builder
+     */
+    public static TrafficTreatment.Builder configureTreatmentBuilder(List<OFAction> actions,
+                                                                     TrafficTreatment.Builder builder,
+                                                                     DriverHandler driverHandler,
+                                                                     DeviceId deviceId) {
+        ExtensionTreatmentInterpreter interpreter;
         if (driverHandler.hasBehaviour(ExtensionTreatmentInterpreter.class)) {
-            treatmentInterpreter = driverHandler.behaviour(ExtensionTreatmentInterpreter.class);
+            interpreter = driverHandler.behaviour(ExtensionTreatmentInterpreter.class);
         } else {
-            treatmentInterpreter = null;
+            interpreter = null;
         }
 
         for (OFAction act : actions) {
@@ -344,15 +354,15 @@ public class FlowEntryBuilder {
                                 lookupGridType(circuitSignalID.getGridType()),
                                 lookupChannelSpacing(circuitSignalID.getChannelSpacing()),
                                 circuitSignalID.getChannelNumber(), circuitSignalID.getSpectralWidth())));
-                    } else if (treatmentInterpreter != null) {
+                    } else if (interpreter != null) {
-                        builder.extension(treatmentInterpreter.mapAction(exp), deviceId);
+                        builder.extension(interpreter.mapAction(exp), deviceId);
                     } else {
                         log.warn("Unsupported OFActionExperimenter {}", exp.getExperimenter());
                     }
                     break;
                 case SET_FIELD:
                     OFActionSetField setField = (OFActionSetField) act;
-                    handleSetField(builder, setField);
+                    handleSetField(builder, setField, driverHandler, deviceId);
                     break;
                 case POP_MPLS:
                     OFActionPopMpls popMpls = (OFActionPopMpls) act;
@@ -410,9 +420,18 @@ public class FlowEntryBuilder {
         return builder;
     }
 
-
+    private TrafficTreatment.Builder buildActions(List<OFAction> actions,
-    private void handleSetField(TrafficTreatment.Builder builder, OFActionSetField action) {
+                                                  TrafficTreatment.Builder builder) {
         DriverHandler driverHandler = getDriver(deviceId);
+
+        return configureTreatmentBuilder(actions, builder, driverHandler, deviceId);
+    }
+
+
+    private static void handleSetField(TrafficTreatment.Builder builder,
+                                       OFActionSetField action,
+                                       DriverHandler driverHandler,
+                                       DeviceId deviceId) {
         ExtensionTreatmentInterpreter treatmentInterpreter;
         if (driverHandler.hasBehaviour(ExtensionTreatmentInterpreter.class)) {
             treatmentInterpreter = driverHandler.behaviour(ExtensionTreatmentInterpreter.class);

providers/openflow/group/pom.xml

@@ -31,4 +31,12 @@
 
     <description>ONOS OpenFlow protocol group provider</description>
 
+    <dependencies>
+        <dependency>
+            <groupId>org.onosproject</groupId>
+            <artifactId>onos-of-provider-flow</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
 </project>

providers/openflow/group/src/main/java/org/onosproject/provider/of/group/impl/GroupBucketEntryBuilder.java

@@ -16,12 +16,6 @@
 package org.onosproject.provider.of.group.impl;
 
 import com.google.common.collect.Lists;
-
-import org.onlab.packet.EthType;
-import org.onlab.packet.Ip4Address;
-import org.onlab.packet.MacAddress;
-import org.onlab.packet.MplsLabel;
-import org.onlab.packet.VlanId;
 import org.onosproject.core.DefaultGroupId;
 import org.onosproject.core.GroupId;
 import org.onosproject.net.DeviceId;
@@ -37,33 +31,10 @@ import org.onosproject.net.group.DefaultGroupBucket;
 import org.onosproject.net.group.GroupBucket;
 import org.onosproject.net.group.GroupBuckets;
 import org.onosproject.openflow.controller.Dpid;
-import org.onosproject.openflow.controller.ExtensionTreatmentInterpreter;
+import org.onosproject.provider.of.flow.impl.FlowEntryBuilder;
 import org.projectfloodlight.openflow.protocol.OFBucket;
 import org.projectfloodlight.openflow.protocol.OFGroupType;
 import org.projectfloodlight.openflow.protocol.action.OFAction;
-import org.projectfloodlight.openflow.protocol.action.OFActionCopyTtlIn;
-import org.projectfloodlight.openflow.protocol.action.OFActionCopyTtlOut;
-import org.projectfloodlight.openflow.protocol.action.OFActionDecMplsTtl;
-import org.projectfloodlight.openflow.protocol.action.OFActionDecNwTtl;
-import org.projectfloodlight.openflow.protocol.action.OFActionExperimenter;
-import org.projectfloodlight.openflow.protocol.action.OFActionGroup;
-import org.projectfloodlight.openflow.protocol.action.OFActionOutput;
-import org.projectfloodlight.openflow.protocol.action.OFActionPopMpls;
-import org.projectfloodlight.openflow.protocol.action.OFActionPushMpls;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetDlDst;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetDlSrc;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetField;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetNwDst;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetNwSrc;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetVlanPcp;
-import org.projectfloodlight.openflow.protocol.action.OFActionSetVlanVid;
-import org.projectfloodlight.openflow.protocol.oxm.OFOxm;
-import org.projectfloodlight.openflow.types.IPv4Address;
-import org.projectfloodlight.openflow.types.OFVlanVidMatch;
-import org.projectfloodlight.openflow.types.U32;
-import org.projectfloodlight.openflow.types.U64;
-import org.projectfloodlight.openflow.types.U8;
-import org.projectfloodlight.openflow.types.VlanPcp;
 import org.slf4j.Logger;
 
 import java.util.List;
@@ -143,225 +114,18 @@ public class GroupBucketEntryBuilder {
         return new GroupBuckets(bucketList);
     }
 
-
     private TrafficTreatment buildTreatment(List<OFAction> actions) {
+        DriverHandler driverHandler = getDriver(dpid);
         TrafficTreatment.Builder builder = DefaultTrafficTreatment.builder();
+
         // If this is a drop rule
         if (actions.size() == 0) {
             builder.drop();
             return builder.build();
         }
-        for (OFAction act : actions) {
-            switch (act.getType()) {
-                case OUTPUT:
-                    OFActionOutput out = (OFActionOutput) act;
-                    builder.setOutput(
-                            PortNumber.portNumber(out.getPort().getPortNumber()));
-                    break;
-                case SET_VLAN_VID:
-                    OFActionSetVlanVid vlan = (OFActionSetVlanVid) act;
-                    builder.setVlanId(VlanId.vlanId(vlan.getVlanVid().getVlan()));
-                    break;
-                case SET_VLAN_PCP:
-                    OFActionSetVlanPcp pcp = (OFActionSetVlanPcp) act;
-                    builder.setVlanPcp(pcp.getVlanPcp().getValue());
-                    break;
-                case POP_VLAN:
-                    builder.popVlan();
-                    break;
-                case PUSH_VLAN:
-                    builder.pushVlan();
-                    break;
-                case SET_DL_DST:
-                    OFActionSetDlDst dldst = (OFActionSetDlDst) act;
-                    builder.setEthDst(
-                            MacAddress.valueOf(dldst.getDlAddr().getLong()));
-                    break;
-                case SET_DL_SRC:
-                    OFActionSetDlSrc dlsrc = (OFActionSetDlSrc) act;
-                    builder.setEthSrc(
-                            MacAddress.valueOf(dlsrc.getDlAddr().getLong()));
 
-                    break;
+        return FlowEntryBuilder.configureTreatmentBuilder(actions, builder,
-                case SET_NW_DST:
+                driverHandler, DeviceId.deviceId(Dpid.uri(dpid))).build();
-                    OFActionSetNwDst nwdst = (OFActionSetNwDst) act;
-                    IPv4Address di = nwdst.getNwAddr();
-                    builder.setIpDst(Ip4Address.valueOf(di.getInt()));
-                    break;
-                case SET_NW_SRC:
-                    OFActionSetNwSrc nwsrc = (OFActionSetNwSrc) act;
-                    IPv4Address si = nwsrc.getNwAddr();
-                    builder.setIpSrc(Ip4Address.valueOf(si.getInt()));
-                    break;
-                case EXPERIMENTER:
-                    OFActionExperimenter exp = (OFActionExperimenter) act;
-                    log.warn("Unsupported OFActionExperimenter {}", exp.getExperimenter());
-                    break;
-                case SET_FIELD:
-                    OFActionSetField setField = (OFActionSetField) act;
-                    handleSetField(builder, setField);
-                    break;
-                case POP_MPLS:
-                    OFActionPopMpls popMpls = (OFActionPopMpls) act;
-                    builder.popMpls(new EthType(popMpls.getEthertype().getValue()));
-                    break;
-                case PUSH_MPLS:
-                    OFActionPushMpls pushMpls = (OFActionPushMpls) act;
-                    builder.pushMpls();
-                    break;
-                case COPY_TTL_IN:
-                    OFActionCopyTtlIn copyTtlIn = (OFActionCopyTtlIn) act;
-                    builder.copyTtlIn();
-                    break;
-                case COPY_TTL_OUT:
-                    OFActionCopyTtlOut copyTtlOut = (OFActionCopyTtlOut) act;
-                    builder.copyTtlOut();
-                    break;
-                case DEC_MPLS_TTL:
-                    OFActionDecMplsTtl decMplsTtl = (OFActionDecMplsTtl) act;
-                    builder.decMplsTtl();
-                    break;
-                case DEC_NW_TTL:
-                    OFActionDecNwTtl decNwTtl = (OFActionDecNwTtl) act;
-                    builder.decNwTtl();
-                    break;
-                case GROUP:
-                    OFActionGroup grp = (OFActionGroup) act;
-                    builder.group(new DefaultGroupId(grp.getGroup().getGroupNumber()));
-                    break;
-                case SET_TP_DST:
-                case SET_TP_SRC:
-                case POP_PBB:
-                case PUSH_PBB:
-                case SET_MPLS_LABEL:
-                case SET_MPLS_TC:
-                case SET_MPLS_TTL:
-                case SET_NW_ECN:
-                case SET_NW_TOS:
-                case SET_NW_TTL:
-                case SET_QUEUE:
-                case STRIP_VLAN:
-                case ENQUEUE:
-                default:
-                    log.warn("Action type {} not yet implemented.", act.getType());
-            }
-        }
-
-        return builder.build();
-    }
-
-    private void handleSetField(TrafficTreatment.Builder builder, OFActionSetField action) {
-        OFOxm<?> oxm = action.getField();
-        switch (oxm.getMatchField().id) {
-            case VLAN_PCP:
-                @SuppressWarnings("unchecked")
-                OFOxm<VlanPcp> vlanpcp = (OFOxm<VlanPcp>) oxm;
-                builder.setVlanPcp(vlanpcp.getValue().getValue());
-                break;
-            case VLAN_VID:
-                @SuppressWarnings("unchecked")
-                OFOxm<OFVlanVidMatch> vlanvid = (OFOxm<OFVlanVidMatch>) oxm;
-                builder.setVlanId(VlanId.vlanId(vlanvid.getValue().getVlan()));
-                break;
-            case ETH_DST:
-                @SuppressWarnings("unchecked")
-                OFOxm<org.projectfloodlight.openflow.types.MacAddress> ethdst =
-                        (OFOxm<org.projectfloodlight.openflow.types.MacAddress>) oxm;
-                builder.setEthDst(MacAddress.valueOf(ethdst.getValue().getLong()));
-                break;
-            case ETH_SRC:
-                @SuppressWarnings("unchecked")
-                OFOxm<org.projectfloodlight.openflow.types.MacAddress> ethsrc =
-                        (OFOxm<org.projectfloodlight.openflow.types.MacAddress>) oxm;
-                builder.setEthSrc(MacAddress.valueOf(ethsrc.getValue().getLong()));
-                break;
-            case IPV4_DST:
-                @SuppressWarnings("unchecked")
-                OFOxm<IPv4Address> ip4dst = (OFOxm<IPv4Address>) oxm;
-                builder.setIpDst(Ip4Address.valueOf(ip4dst.getValue().getInt()));
-                break;
-            case IPV4_SRC:
-                @SuppressWarnings("unchecked")
-                OFOxm<IPv4Address> ip4src = (OFOxm<IPv4Address>) oxm;
-                builder.setIpSrc(Ip4Address.valueOf(ip4src.getValue().getInt()));
-                break;
-            case MPLS_LABEL:
-                @SuppressWarnings("unchecked")
-                OFOxm<U32> labelId = (OFOxm<U32>) oxm;
-                builder.setMpls(MplsLabel.mplsLabel((int) labelId.getValue().getValue()));
-                break;
-            case MPLS_BOS:
-                @SuppressWarnings("unchecked")
-                OFOxm<U8> mplsBos = (OFOxm<U8>) oxm;
-                builder.setMplsBos(mplsBos.getValue() == U8.ZERO ? false : true);
-                break;
-            case TUNNEL_ID:
-                @SuppressWarnings("unchecked")
-                OFOxm<U64> tunnelId = (OFOxm<U64>) oxm;
-                builder.setTunnelId(tunnelId.getValue().getValue());
-                break;
-            case TUNNEL_IPV4_DST:
-                DriverHandler driver = getDriver(dpid);
-                ExtensionTreatmentInterpreter interpreter = driver.behaviour(ExtensionTreatmentInterpreter.class);
-                if (interpreter != null) {
-                    builder.extension(interpreter.mapAction(action), DeviceId.deviceId(Dpid.uri(dpid)));
-                }
-                break;
-            case ARP_OP:
-            case ARP_SHA:
-            case ARP_SPA:
-            case ARP_THA:
-            case ARP_TPA:
-            case BSN_EGR_PORT_GROUP_ID:
-            case BSN_GLOBAL_VRF_ALLOWED:
-            case BSN_IN_PORTS_128:
-            case BSN_L3_DST_CLASS_ID:
-            case BSN_L3_INTERFACE_CLASS_ID:
-            case BSN_L3_SRC_CLASS_ID:
-            case BSN_LAG_ID:
-            case BSN_TCP_FLAGS:
-            case BSN_UDF0:
-            case BSN_UDF1:
-            case BSN_UDF2:
-            case BSN_UDF3:
-            case BSN_UDF4:
-            case BSN_UDF5:
-            case BSN_UDF6:
-            case BSN_UDF7:
-            case BSN_VLAN_XLATE_PORT_GROUP_ID:
-            case BSN_VRF:
-            case ETH_TYPE:
-            case ICMPV4_CODE:
-            case ICMPV4_TYPE:
-            case ICMPV6_CODE:
-            case ICMPV6_TYPE:
-            case IN_PHY_PORT:
-            case IN_PORT:
-            case IPV6_DST:
-            case IPV6_FLABEL:
-            case IPV6_ND_SLL:
-            case IPV6_ND_TARGET:
-            case IPV6_ND_TLL:
-            case IPV6_SRC:
-            case IP_DSCP:
-            case IP_ECN:
-            case IP_PROTO:
-            case METADATA:
-            case MPLS_TC:
-            case OCH_SIGID:
-            case OCH_SIGID_BASIC:
-            case OCH_SIGTYPE:
-            case OCH_SIGTYPE_BASIC:
-            case SCTP_DST:
-            case SCTP_SRC:
-            case TCP_DST:
-            case TCP_SRC:
-            case UDP_DST:
-            case UDP_SRC:
-            default:
-                log.warn("Set field type {} not yet implemented.", oxm.getMatchField().id);
-                break;
-        }
     }
 
     private DriverHandler getDriver(Dpid dpid) {