Bug 4098 - ofoverlay-renderer failure in jdk8 32/27232/4
authorDileep Ranganathan <dileep.ranganathan@intel.com>
Wed, 16 Sep 2015 23:29:05 +0000 (16:29 -0700)
committerDileep Ranganathan <dileep.ranganathan@intel.com>
Wed, 23 Sep 2015 20:52:36 +0000 (13:52 -0700)
Modified Javadoc comments for jdk 8 compatibility
Formatted whitespaces/tabs
  - VxlanTunnelType.java
  - VxlanGpeTunnelType.java
  - AbstractTunnelType.java

Change-Id: I34f0722f8982424eae77aa7be97722e0dfc226d2
Signed-off-by: Dileep Ranganathan <dileep.ranganathan@intel.com>
27 files changed:
groupbasedpolicy/src/main/java/org/opendaylight/groupbasedpolicy/endpoint/EndpointRpcRegistry.java
groupbasedpolicy/src/main/java/org/opendaylight/groupbasedpolicy/resolver/PolicyInfo.java
groupbasedpolicy/src/main/java/org/opendaylight/groupbasedpolicy/resolver/validator/AbstractValidator.java
neutron-ovsdb/src/main/java/org/opendaylight/controller/config/yang/config/neutron_ovsdb/impl/NeutronOvsdbModuleFactory.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/AbstractTunnelType.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/NodeDataChangeListener.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/TerminationPointDataChangeListener.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/VxlanGpeTunnelType.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/VxlanTunnelType.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/util/EndpointHelper.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/util/InventoryHelper.java
neutron-ovsdb/src/main/java/org/opendaylight/groupbasedpolicy/neutron/ovsdb/util/OvsdbHelper.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/EndpointManager.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/PolicyManager.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/SfcManager.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/arp/Arp.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/arp/ArpFlowFactory.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/arp/ArpUtils.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/FlowTable.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/FlowUtils.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/OfTable.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/flow/OrdinalFactory.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/node/SwitchListener.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/node/SwitchManager.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/Action.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/IpProtoClassifier.java
renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sfcutils/SfcNshHeader.java

index 5af2ff3494327e8aff016ebe5839bd54f4028a49..ce6acd51e291c218d78a204bfc9c1642f8ba0fd4 100644 (file)
@@ -118,7 +118,7 @@ public class EndpointRpcRegistry implements EndpointService {
 
     /**
      *
-     * @param regImp
+     * @param regImp the endpoint augmentation
      * @throws Exception
      */
     public static void unregister(EpRendererAugmentation regImp)
@@ -167,9 +167,9 @@ public class EndpointRpcRegistry implements EndpointService {
     /**
      * Constructor
      *
-     * @param dataProvider
-     * @param rpcRegistry
-     * @param executor
+     * @param dataProvider the {@link DataBroker}
+     * @param rpcRegistry  the {@link RpcProviderRegistry}
+     * @param executor     the {@link ScheduledExecutorService}
      */
     private EndpointRpcRegistry(DataBroker dataProvider,
             RpcProviderRegistry rpcRegistry,
index 8b0f8bb1078d3f45f7e12153bc13a4a1ad5e8ea8..c0e7e76b8a134f5d82aa2636b65f5460981263a8 100644 (file)
@@ -69,9 +69,9 @@ public class PolicyInfo {
 
     /**
      * Get the condition group as it applies to the given list of conditions
-     * @param eg
-     * @param conditions
-     * @return
+     * @param eg the endpoint group key
+     * @param conditions the list of conditions
+     * @return the {@link ConditionGroup}
      */
     public ConditionGroup getEgCondGroup(EgKey eg,
                                          List<ConditionName> conditions) {
index e92cff7b8d1cede5bce368ba990b92bf7dbc7a2d..8a104b1016bb0c9f3a5ceb3915a697a79956e375 100644 (file)
@@ -106,7 +106,6 @@ public abstract class AbstractValidator<U extends DataContainer> implements Vali
      * Individual validators must override this method, if they want to execute
      * validation on their children.
      *
-     * @param <T>
      * @param objectToValidate Object that is validated by this validator
      * @return List of child objects associated to {@code objectToValidate}. If
      * there is not any child, return empty list or {@code null}.
index de2907a2e6abc4ab2b0746c6ab7ec6def09b2cb8..387ed6b1c2c75ed77300bb3c176268b2a55f0dcc 100644 (file)
@@ -17,7 +17,7 @@ import org.osgi.framework.BundleContext;
 public class NeutronOvsdbModuleFactory extends org.opendaylight.controller.config.yang.config.neutron_ovsdb.impl.AbstractNeutronOvsdbModuleFactory {
 
     /**
-     * @see org.opendaylight.controller.config.yang.config.neutron_mapper.impl.AbstractNeutronOvsdbModuleFactory#createModule(java.lang.String, org.opendaylight.controller.config.api.DependencyResolver, org.osgi.framework.BundleContext)
+     * @see org.opendaylight.controller.config.yang.config.neutron_ovsdb.impl.AbstractNeutronOvsdbModuleFactory#createModule(java.lang.String, org.opendaylight.controller.config.api.DependencyResolver, org.osgi.framework.BundleContext)
      */
     @Override
     public Module createModule(String instanceName, DependencyResolver dependencyResolver, BundleContext bundleContext) {
@@ -27,7 +27,7 @@ public class NeutronOvsdbModuleFactory extends org.opendaylight.controller.confi
     }
 
     /**
-     * @see org.opendaylight.controller.config.yang.config.neutron_mapper.impl.AbstractNeutronOvsdbModuleFactory#createModule(java.lang.String, org.opendaylight.controller.config.api.DependencyResolver, org.opendaylight.controller.config.api.DynamicMBeanWithInstance, org.osgi.framework.BundleContext)
+     * @see org.opendaylight.controller.config.yang.config.neutron_ovsdb.impl.AbstractNeutronOvsdbModuleFactory#createModule(java.lang.String, org.opendaylight.controller.config.api.DependencyResolver, org.opendaylight.controller.config.api.DynamicMBeanWithInstance, org.osgi.framework.BundleContext)
      */
     @Override
     public Module createModule(String instanceName, DependencyResolver dependencyResolver, DynamicMBeanWithInstance old,
index 84dec31fd97abd0cdd7c8415790f447cdd12df8f..c04820c8630ff96a2da07eba1d5458fcec1ccda6 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -22,6 +22,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.re
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
 
 public abstract class AbstractTunnelType {
+
     protected static final String DESTPORT_KEY = "dst_port";
     protected static final String REMOTE_IP_KEY = "remote_ip";
     protected static final String REMOTE_IP_VALUE = "flow";
@@ -29,35 +30,31 @@ public abstract class AbstractTunnelType {
     protected static final String VNID_VALUE = "flow";
 
     protected List<Options> createOptionsList(Map<String, String> optionsMap) {
-               List<Options> options = new ArrayList<Options>();
+        List<Options> options = new ArrayList<Options>();
         OptionsBuilder ob = new OptionsBuilder();
-        for (Entry<String, String> entry: optionsMap.entrySet()) {
+        for (Entry<String, String> entry : optionsMap.entrySet()) {
             ob.setOption(entry.getKey());
             ob.setValue(entry.getValue());
             options.add(ob.build());
         }
         return Collections.unmodifiableList(options);
-       }
+    }
 
-    protected boolean hasTunnelOptions(OvsdbTerminationPointAugmentation tpAugmentation,
-            Map<String, String> optionsMap) {
+    protected boolean hasTunnelOptions(OvsdbTerminationPointAugmentation tpAugmentation, Map<String, String> optionsMap) {
 
         Map<String, String> foundOpts = new HashMap<String, String>();
         List<Options> options = tpAugmentation.getOptions();
         if (options != null) {
-            for (Options opt: options) {
+            for (Options opt : options) {
                 // skip invalid options
-                if (opt.getOption() == null
-                    || opt.getValue() == null) continue;
+                if (opt.getOption() == null || opt.getValue() == null)
+                    continue;
 
-                if (optionsMap.containsKey(opt.getOption())
-                         && optionsMap.get(opt.getOption())
-                                   .equals(opt.getValue())) {
+                if (optionsMap.containsKey(opt.getOption()) && optionsMap.get(opt.getOption()).equals(opt.getValue())) {
                     foundOpts.put(opt.getOption(), opt.getValue());
                 }
             }
-            if ((foundOpts.size() == optionsMap.size())
-                    && (options.size() == foundOpts.size())) {
+            if ((foundOpts.size() == optionsMap.size()) && (options.size() == foundOpts.size())) {
                 return true;
             }
         }
@@ -69,7 +66,7 @@ public abstract class AbstractTunnelType {
         if (options == null) {
             return null;
         }
-        for (Options opt: options) {
+        for (Options opt : options) {
             if (DESTPORT_KEY.equals(opt.getOption())) {
                 return opt.getValue();
             }
@@ -78,9 +75,9 @@ public abstract class AbstractTunnelType {
     }
 
     /**
-     * Return the {@link List<Options>} valid for this tunnel type
+     * Return the list of {@link Options} valid for this tunnel type
      *
-     * @return {@link List<Options>} for the tunnel, null if not supported
+     * @return list of {@link Options} for the tunnel, null if not supported
      */
     public abstract List<Options> getOptions();
 
@@ -88,7 +85,7 @@ public abstract class AbstractTunnelType {
      * Check if a TerminationPoint is a tunnel port that meets
      * requirements
      *
-     * @param tpAugmentation
+     * @param tpAugmentation the {@link OvsdbTerminationPointAugmentation}
      * @return String of the tunnel port name (null if not found)
      */
     public abstract boolean isValidTunnelPort(OvsdbTerminationPointAugmentation tpAugmentation);
index 81940fa39c745fde20ca7b01d3d7d8c9467096b0..2bd1334e8e6b478346ffd28091f8a7dd0c85d483 100644 (file)
@@ -169,7 +169,8 @@ public class NodeDataChangeListener implements DataChangeListener, AutoCloseable
      * Get the DPID and OpenFlow port of the bridge that owns the {@link TerminationPoint} in the
      * provider mapping
      *
-     * @return
+     * @return the DPID and OpenFlow port of the bridge that owns the {@link TerminationPoint} in
+     * the provider mapping
      */
     private static String getInventoryNodeId(OvsdbNodeAugmentation ovsdbNode, String externalPortName) {
         List<ManagedNodeEntry> ovsdbNodes = ovsdbNode.getManagedNodeEntry();
index 343687a43077e914e35793cd41f5934374aef301..6b9a5f89ca2b0839e339aa1592c59db3f8750d56 100755 (executable)
@@ -257,7 +257,7 @@ public class TerminationPointDataChangeListener implements DataChangeListener, A
      * removes attached tunnels (namely Vxlan-type) from OVSDB bridge;
      * else removes location info from TP
      *
-     * @param ovsdbBridge {@link OvsdbBridgeAugmentation}
+     * @param nodeId {@link NodeId}
      * @param ovsdbTp {@link OvsdbTerminationPointAugmentation}
      * @param ovsdbTpIid termination point's IID {@link InstanceIdentifier}
      */
@@ -342,7 +342,7 @@ public class TerminationPointDataChangeListener implements DataChangeListener, A
      * Get the Neutron Port UUID from an {@link OvsdbTerminationPointAugmentation}.
      * The Neutron Port UUID is stored as an "external-id" in the termination point.
      *
-     * @param ovsdbTp The OVSDB Termination Point augmentation
+     * @param ovsdbTp The {@link OvsdbTerminationPointAugmentation}
      * @return The String representation of the Neutron Port UUID, null if not present
      */
     private String getNeutronPortUuid(OvsdbTerminationPointAugmentation ovsdbTp) {
index 0408db766d93c558b9e47198121e57a2c1e10a58..6f7155814b13cbf4ceefff9e6d2e7da859aee77f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -40,18 +40,17 @@ public class VxlanGpeTunnelType extends AbstractTunnelType {
     private static final String DESTPORT_KEY = "dst_port";
     private static final String DESTPORT_VALUE = VXLAN_GPE_PORT_NUMBER.toString();
 
-
-       private final PortNumber udpTunnelPort;
+    private final PortNumber udpTunnelPort;
     private final List<Options> optionsList;
     private static final Class<? extends TunnelTypeBase> tunnelType = TunnelTypeVxlanGpe.class;
 
-       public VxlanGpeTunnelType() {
-               optionsList = createOptionsList(optsMap);
-               udpTunnelPort = new PortNumber(VXLAN_GPE_PORT_NUMBER);
-       }
+    public VxlanGpeTunnelType() {
+        optionsList = createOptionsList(optsMap);
+        udpTunnelPort = new PortNumber(VXLAN_GPE_PORT_NUMBER);
+    }
 
-       private static final Map<String, String> optsMap;
-       static {
+    private static final Map<String, String> optsMap;
+    static {
         Map<String, String> opts = new HashMap<String, String>();
         opts.put(VNID_KEY, VNID_VALUE);
         opts.put(REMOTE_IP_KEY, REMOTE_IP_VALUE);
@@ -65,37 +64,37 @@ public class VxlanGpeTunnelType extends AbstractTunnelType {
         optsMap = Collections.unmodifiableMap(opts);
     }
 
-       @Override
+    @Override
     public List<Options> getOptions() {
         return optionsList;
     }
 
-       @Override
+    @Override
     public Class<? extends TunnelTypeBase> getTunnelType() {
         return tunnelType;
     }
 
-       @Override
+    @Override
     public PortNumber getPortNumber() {
         return udpTunnelPort;
     }
 
-       @Override
+    @Override
     public String getTunnelPrefix() {
         return VXLAN_GPE_TUNNEL_PREFIX;
-       }
+    }
 
-       /**
+    /**
      * Check if a TerminationPoint is a tunnel port that meets
      * requirements for the Service Function Chaining with NSH
      * encapsulation. The tunnel port must support setting the
      * VNID, destination Tunnel IP address, NSI, NSP, and all
      * four NSHC fields from flow-mods, and use VXLAN encapsulation.
      *
-     * @param tpAugmentation
+     * @param tpAugmentation the {@link OvsdbTerminationPointAugmentation}
      * @return true if it can be an SFC NSH tunnel port, false if not
      */
-       @Override
+    @Override
     public boolean isValidTunnelPort(OvsdbTerminationPointAugmentation tpAugmentation) {
         if (hasTunnelOptions(tpAugmentation, optsMap)
                 && InterfaceTypeVxlan.class.equals(tpAugmentation.getInterfaceType())
index c3e7b8756f41af99d212eddfbe400b7dc43ba0ef..360b4becc00fa7b9409a1725e05cccd092314c1c 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
- *
+ * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+ * 
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
@@ -20,8 +20,8 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.re
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
 
-
 public class VxlanTunnelType extends AbstractTunnelType {
+
     private static final Map<String, String> optsMap;
     private static final Class<? extends TunnelTypeBase> tunnelType = TunnelTypeVxlan.class;
     private static final Integer VXLAN_PORT_NUMBER = 4789;
@@ -29,37 +29,37 @@ public class VxlanTunnelType extends AbstractTunnelType {
     private final PortNumber udpTunnelPort;
     private final List<Options> optionsList;
 
-       static {
+    static {
         Map<String, String> opts = new HashMap<String, String>();
         opts.put(VNID_KEY, VNID_VALUE);
         opts.put(REMOTE_IP_KEY, REMOTE_IP_VALUE);
         optsMap = Collections.unmodifiableMap(opts);
     }
 
-       public VxlanTunnelType() {
-               optionsList = createOptionsList(optsMap);
-               udpTunnelPort = new PortNumber(VXLAN_PORT_NUMBER);
-       }
+    public VxlanTunnelType() {
+        optionsList = createOptionsList(optsMap);
+        udpTunnelPort = new PortNumber(VXLAN_PORT_NUMBER);
+    }
 
-       @Override
+    @Override
     public List<Options> getOptions() {
         return optionsList;
     }
 
-       @Override
+    @Override
     public Class<? extends TunnelTypeBase> getTunnelType() {
         return tunnelType;
     }
 
-       @Override
+    @Override
     public PortNumber getPortNumber() {
         return udpTunnelPort;
     }
 
-       @Override
+    @Override
     public String getTunnelPrefix() {
         return VXLAN_TUNNEL_PREFIX;
-       }
+    }
 
     /**
      * Check if a TerminationPoint is a tunnel port that meets
@@ -67,15 +67,15 @@ public class VxlanTunnelType extends AbstractTunnelType {
      * setting the VNID and destination Tunnel IP address, and
      * use VXLAN encapsulation.
      *
-     * @param tpAugmentation
+     * @param tpAugmentation the {@link OvsdbTerminationPointAugmentation}
      * @return true if it can be the OfOverlay tunnel port, false if not
      */
-       @Override
+    @Override
     public boolean isValidTunnelPort(OvsdbTerminationPointAugmentation tpAugmentation) {
         if (hasTunnelOptions(tpAugmentation, optsMap)
                 && InterfaceTypeVxlan.class.equals(tpAugmentation.getInterfaceType())
-                && (getDestPort(tpAugmentation) == null
-                || getDestPort(tpAugmentation).equals(VXLAN_PORT_NUMBER.toString()))) {
+                && (getDestPort(tpAugmentation) == null || getDestPort(tpAugmentation).equals(
+                        VXLAN_PORT_NUMBER.toString()))) {
             return true;
         }
         return false;
index 7df6a65aa1f1df2ea8d1d894b6d2f944dc3481a9..c4f01deb6362663e73db8bb940f0f848e404889b 100755 (executable)
@@ -36,7 +36,7 @@ public class EndpointHelper {
      * Look up the {@link Endpoint} from the Endpoint Registry.
      *
      * @param epKey The {@link EndpointKey} to look up
-     * @param dataBroker The {@link DataBroker} to use for the transaction
+     * @param transaction The {@link ReadOnlyTransaction}
      * @return The corresponding {@link Endpoint}, null if not found
      */
     public static Endpoint lookupEndpoint(EndpointKey epKey, ReadOnlyTransaction transaction) {
@@ -54,10 +54,10 @@ public class EndpointHelper {
      * Note this updates the datastore directly. It does not use the Endpoint RPC, as this has
      * unfortunate side-effects on EndpointL3 augmentations.
      *
-     * @param endpoint
-     * @param nodeIdString
-     * @param nodeConnectorIdString
-     * @param rwTx
+     * @param endpoint               the network endpoint
+     * @param nodeIdString           the string representation of the inventory NodeId
+     * @param nodeConnectorIdString  the string representation of the inventory NodeConnectorId
+     * @param rwTx                   a reference to ReadWriteTransaction object
      */
     public static void updateEndpointWithLocation(Endpoint endpoint, String nodeIdString,
         String nodeConnectorIdString, ReadWriteTransaction rwTx) {
index 11c4889d88332bd6957b6d3da30cfc09932da323..b2976b630eb779e18f4ce944be53cd503963cd56 100755 (executable)
@@ -71,7 +71,9 @@ public class InventoryHelper {
      * augmentation, converting that to a Long, and prepending it with the
      * "openflow:" prefix.
      *
-     * @param ovsdbBridge The OVSDB bridge augmentation
+     * @param ovsdbBridge The {@link OvsdbBridgeAugmentation}
+     * @param ovsdbTpIid the {@link OvsdbTerminationPointAugmentation}
+     * @param dataBroker the {@link DataBroker}
      * @return String representation of the Inventory NodeId, null if it fails
      */
     public static String getInventoryNodeIdString(OvsdbBridgeAugmentation ovsdbBridge,
@@ -102,6 +104,8 @@ public class InventoryHelper {
      *
      * @param inventoryNodeId The string representation of the Inventory NodeId
      * @param ovsdbTp The {@link OvsdbTerminationPointAugmentation}
+     * @param tpIid the InstanceIdentifier for OvsdbTerminationPointAugmentation
+     * @param dataBroker the {@link DataBroker}
      * @return String representation of the Inventory NodeConnectorId, null if it fails
      */
     public static String getInventoryNodeConnectorIdString(String inventoryNodeId,
@@ -136,6 +140,9 @@ public class InventoryHelper {
      * Inventory Node, and verify that the tunnel types we need
      * are present
      *
+     * @param nodeIdString The inventory node id string
+     * @param requiredTunnelTypes the list of tunnel types
+     * @param dataBroker the {@link DataBroker}
      * @return true if tunnel types are present, false otherwise
      */
     public static boolean checkOfOverlayConfig(String nodeIdString, List<AbstractTunnelType> requiredTunnelTypes,
@@ -198,14 +205,14 @@ public class InventoryHelper {
     }
 
     /**
-     * Update the {@link OfOverlayConfig} of an Inventory Node
+     * Update the {@link OfOverlayNodeConfig} of an Inventory Node
      * using the new tunnel state.
      *
-     * @param ip
-     * @param nodeIdString
-     * @param nodeConnectorIdString
-     * @param tunnelType
-     * @param dataBroker
+     * @param ip the ipaddress
+     * @param nodeIdString the string representation of the inventory NodeId
+     * @param nodeConnectorIdString the string representation of the inventory NodeConnectorId
+     * @param tunnelType the tunnel type
+     * @param dataBroker the {@link DataBroker}
      */
     public static void updateOfOverlayConfig(IpAddress ip, String nodeIdString, String nodeConnectorIdString,
             AbstractTunnelType tunnelType, DataBroker dataBroker) {
index 170715139852b5d5f2c3b9d94e3e19952461aafc..815cf6ce3117562d79fd5e9f6e104fe7830436f5 100755 (executable)
@@ -50,9 +50,10 @@ public class OvsdbHelper {
 
     /**
      * Look up the {@link OvsdbBridgeAugmentation} from the data store
-     * given a child {@link InstanceIdentifier<OvsdbTerminationPointAugmentation>}
+     * given a child {@link InstanceIdentifier} of {@link OvsdbTerminationPointAugmentation}
      *
-     * @param tpId The InstanceIdentifier for a child TerminationPoint augmentation
+     * @param tpIid The InstanceIdentifier for a child TerminationPoint augmentation
+     * @param dataBroker the {@link DataBroker}
      * @return the {@link OvsdbBridgeAugmentation}, null if the augmentation isn't present
      */
     public static OvsdbBridgeAugmentation getOvsdbBridgeFromTerminationPoint(
@@ -183,8 +184,8 @@ public class OvsdbHelper {
     /**
      * Get the manager node for this bridge node
      *
-     * @param bridge
-     * @param dataBroker
+     * @param bridge the bridge node
+     * @param dataBroker the {@link DataBroker}
      * @return The {@link OvsdbBridgeAugmentation} for the manager node, null
      *         if not found or if it already is the manager node
      */
@@ -224,9 +225,10 @@ public class OvsdbHelper {
      * Use OVSDB CRUD to create any missing tunnels on a given
      * Inventory Node.
      *
-     * @param nodeIid
-     * @param node
-     * @param tunnelType
+     * @param nodeIid the node instance identifier
+     * @param node the inventory node
+     * @param tunnelType the tunnel type
+     * @param dataBroker the {@link DataBroker}
      */
     public static void createTunnelPort(InstanceIdentifier<Node> nodeIid,
             Node node, AbstractTunnelType tunnelType, DataBroker dataBroker) {
index 6d6acfa6319f633336cb61081ceed4c1247a83c2..c8e392e2485a6a7899b5f86675395541eaf07dca 100644 (file)
@@ -283,7 +283,6 @@ public class EndpointManager implements AutoCloseable, DataChangeListener {
      * Get the endpoints container from datastore.
      * Note: There are maps maintained by listener when higher performance is required.
      *
-     * @param
      * @return the {@link Endpoints}
      */
     public Endpoints getEndpointsFromDataStore() {
@@ -312,7 +311,6 @@ public class EndpointManager implements AutoCloseable, DataChangeListener {
     /**
      * Return all L3Prefix Endpoints from datastore.
      *
-     * @param
      * @return the {@link EndpointL3Prefix}
      */
     public Collection<EndpointL3Prefix> getEndpointsL3Prefix() {
@@ -327,7 +325,6 @@ public class EndpointManager implements AutoCloseable, DataChangeListener {
     /**
      * Return all L3Endpoints from datastore.
      *
-     * @param
      * @return the {@link EndpointL3}
      */
     public Collection<EndpointL3> getL3Endpoints() {
@@ -460,6 +457,9 @@ public class EndpointManager implements AutoCloseable, DataChangeListener {
 
     /**
      * Update the endpointL3 indexes. Set newEp to null to remove.
+     *
+     * @param oldL3Ep the old L3 endpoint
+     * @param newL3Ep the new L3 endpoint
      */
     protected synchronized void updateEndpointL3(EndpointL3 oldL3Ep, EndpointL3 newL3Ep) {
         // TODO Bug 3543 - complete
@@ -507,6 +507,9 @@ public class EndpointManager implements AutoCloseable, DataChangeListener {
 
     /**
      * Update the endpoint indexes. Set newEp to null to remove.
+     *
+     * @param oldEp the old endpoint
+     * @param newEp the new endpoint
      */
     protected synchronized void updateEndpoint(Endpoint oldEp, Endpoint newEp) {
         // TODO Be alagalah From Helium only keep track of endpoints that are
index 5e5b660654aa13a357ff8f8447ff4253bb51d27a..bc6a9bb960a0782d8f48d8c50e52aeb46c02f74f 100755 (executable)
@@ -169,8 +169,8 @@ public class PolicyManager
     }
 
     /**
-     * @param tableOffset - new offset value
-     * @return ListenableFuture<List> - to indicate that tables have been synced
+     * @param tableOffset the new offset value
+     * @return {@link ListenableFuture} to indicate that tables have been synced
      */
     public ListenableFuture<Void> changeOpenFlowTableOffset(final short tableOffset) {
         try {
index ca90ef2fb67610896f8e4e9ab5341d5b76fd57b8..81e51fb7f1a138d8833cbff09c79d3a2c5348cd6 100644 (file)
@@ -382,8 +382,8 @@ public class SfcManager implements AutoCloseable, DataChangeListener {
     /**
      * Return the first hop information for the Rendered Service Path
      *
-     * @param rspName
-     * @return
+     * @param rspName the Rendered Service Path
+     * @return the first hop information for the Rendered Service Path
      */
     public RenderedServicePathFirstHop getRspFirstHop(String rspName) {
         return rspMap.get(rspName);
index 69848eb5507f11d4e268f8ee745b009e163697f1..9306a9d1ac991fbb1ef7b2d3edbeb2b9a53cce07 100644 (file)
@@ -126,7 +126,9 @@ public class Arp extends Packet {
     }
 
     /**
+     *
      * @param value hardware length in Bytes
+     * @return {@link Arp}
      */
     public Arp setHardwareLength(short value) {
         hdrFieldsMap.put(HLEN, Unpooled.buffer(1).writeByte(value).array());
@@ -134,7 +136,9 @@ public class Arp extends Packet {
     }
 
     /**
+     *
      * @param value protocol length in Bytes
+     * @return {@link Arp}
      */
     public Arp setProtocolLength(short value) {
         hdrFieldsMap.put(PLEN, Unpooled.buffer(1).writeByte(value).array());
index a7a083f1e127d670a83e42a5209ff3fbee1721d8..2db00da8eb5ba882c36cdb73a17d7a81326fdb4b 100644 (file)
@@ -37,6 +37,9 @@ public class ArpFlowFactory {
 
     /**
      * Creates {@link EthernetMatch} containing ARP ether-type and the given destination MAC address
+     *
+     * @param destinationMacAddress the destination MAC address
+     * @return {@link EthernetMatch}
      */
     public static EthernetMatch createEthernetMatch(MacAddress destinationMacAddress) {
         return new EthernetMatchBuilder().setEthernetType(
@@ -48,6 +51,10 @@ public class ArpFlowFactory {
     /**
      * Creates {@link ArpMatch} containing Reply ARP operation, THA and TPA for the given target
      * address and SPA for the given sender protocol address
+     *
+     * @param targetAddress the target address
+     * @param senderProtocolAddress the sender protocol address
+     * @return {@link ArpMatch}
      */
     public static ArpMatch createArpMatch(ArpMessageAddress targetAddress, Ipv4Address senderProtocolAddress) {
         return new ArpMatchBuilder().setArpOp(ArpOperation.REPLY.intValue())
@@ -62,6 +69,7 @@ public class ArpFlowFactory {
      * Creates {@link Action} representing output to the controller
      *
      * @param order the order for the action
+     * @return {@link Action}
      */
     public static Action createSendToControllerAction(int order) {
         return new ActionBuilder().setOrder(order)
index 2d5b3b27b6e2e854c3af9cba025ad6e46a2bd0d3..5bb9d86f01dc33b97ceb1110a4646a4644263523 100644 (file)
@@ -30,6 +30,9 @@ public class ArpUtils {
 
     /**
      * Returns Ethernet and ARP in readable string format
+     *
+     * @param eth {@link Ethernet}
+     * @return returns Ethernet and ARP in readable string format
      */
     public static String getArpFrameToStringFormat(Ethernet eth) {
         String ethernetString = "Ethernet [getEtherType()="
@@ -49,6 +52,9 @@ public class ArpUtils {
 
     /**
      * Returns ARP in readable string format
+     *
+     * @param arp {@link Arp}
+     * @return returns ARP in readable string format
      */
     public static String getArpToStringFormat(Arp arp) {
         try {
index bd8ed8b7cb0c86f1305eabe78b977dd926d4a26a..ce55b582f6f5189e2d743a9f542572eb2c6bfebd 100755 (executable)
@@ -50,12 +50,18 @@ public abstract class FlowTable extends OfTable {
 
     /**
      * Sync flow state using the flow map
-     * @throws Exception
+     *
+     * @param nodeId the node id
+     * @param policyInfo the current policy snapshot
+     * @param ofWriter the {@link OfWriter}
+     * @throws Exception throws all exception
      */
     public abstract void sync(NodeId nodeId, PolicyInfo policyInfo, OfWriter ofWriter) throws Exception;
 
     /**
      * Get the table ID being manipulated
+     *
+     * @return the table id
      */
     public abstract short getTableId();
 
@@ -65,6 +71,8 @@ public abstract class FlowTable extends OfTable {
 
     /**
      * Get a base flow builder with some common features already set
+     *
+     * @return {@link FlowBuilder}
      */
     protected FlowBuilder base() {
         return new FlowBuilder()
@@ -77,6 +85,11 @@ public abstract class FlowTable extends OfTable {
     /**
      * Write a drop flow for the given ethertype at the given priority.
      * If the ethertype is null, then drop all traffic
+     *
+     * @param priority the priority
+     * @param etherType the ethertype
+     * @param tableId the table id
+     * @return a drop flow for the given ethertype at the given priority.
      */
     public Flow dropFlow(Integer priority, Long etherType, Short tableId) {
         FlowId flowid;
index 0eac888172ee5b39e180cb8ecf5fce864bb2c7f0..3ca1ee9b69c4fe1c70d294c1b30d2717dc276f4b 100755 (executable)
@@ -190,8 +190,8 @@ public final class FlowUtils {
     /**
      * Creates an Instance Identifier (path) for node with specified id
      *
-     * @param nodeId
-     * @return
+     * @param nodeId the ID of the node
+     * @return the {@link InstanceIdentifier}
      */
     public static final InstanceIdentifier<Node> createNodePath(final NodeId nodeId) {
         return InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(nodeId)).build();
@@ -251,9 +251,9 @@ public final class FlowUtils {
      * Creates a path for particular flow, by appending flow-specific information
      * to table path.
      *
-     * @param table
-     * @param flowKey
-     * @return
+     * @param table the table iid
+     * @param flowKey the flow key
+     * @return the {@link InstanceIdentifier}
      */
     public static InstanceIdentifier<Flow> createFlowPath(final InstanceIdentifier<Table> table, final FlowKey flowKey) {
         return table.child(Flow.class, flowKey);
@@ -263,9 +263,9 @@ public final class FlowUtils {
      * Creates a path for particular flow, by appending flow-specific information
      * to table path.
      *
-     * @param table
-     * @param flowId
-     * @return
+     * @param table the table iid
+     * @param flowId the flow id
+     * @return the {@link InstanceIdentifier}
      */
     public static InstanceIdentifier<Flow> createFlowPath(final InstanceIdentifier<Table> table, final FlowId flowId) {
         return createFlowPath(table, new FlowKey(flowId));
index 50b4701de985154e127b21e418b99f7628cccdf5..7b599b1b587366f6056dc7ed1850169e670e4e89 100755 (executable)
@@ -40,9 +40,9 @@ public abstract class OfTable {
     /**
      * Update the relevant flow table for the node
      * @param nodeId the node to update
-     * @param policyInfo
-     * @param ofWriter
-     * @throws Exception
+     * @param policyInfo the current policy snapshot
+     * @param ofWriter the {@link OfWriter}
+     * @throws Exception throws all exception
      */
     public abstract void update(NodeId nodeId,
                                 PolicyInfo policyInfo,
index 234c12a0346c472c97a586808b50a3114d4041ff..3e0195060094c08d8168c2c963773228f9fa3342 100755 (executable)
@@ -52,10 +52,10 @@ public class OrdinalFactory {
      * Creates an ordinal for the OfOverlay pipeline comparison, based on @TenantId and a
      * uniqueID (UUID) associated with any other attribute.
      *
-     * @param tenantId
-     * @param id
-     * @return
-     * @throws Exception
+     * @param tenantId the tenant id
+     * @param id a unique id
+     * @return the ordinal
+     * @throws Exception throws all exception
      */
     public static int getContextOrdinal(final TenantId tenantId, final UniqueId id) throws Exception {
         if (tenantId == null || id == null)
@@ -91,7 +91,7 @@ public class OrdinalFactory {
      * @param destNode
      *        destination node ID
      * @return the 32-bit ordinal value
-     * @throws Exception
+     * @throws Exception throws all exception
      */
 
     public static int getContextOrdinal(NodeId destNode) throws Exception {
index 1ed01bdef0b980e69c7bba8020fbaf9046029657..b3a0ff9a41e212fe23812c0bd43d5d758289f2b7 100644 (file)
@@ -26,11 +26,11 @@ public interface SwitchListener {
      * @param sw the ID for the switch
      */
     public void switchRemoved(NodeId sw);
-    
-    /**
+
+       /**
      * Indicated that the switch configuration, tunnel port, or external ports
      * have changed
-     * @param sw
+     * @param sw the ID for the switch
      */
     public void switchUpdated(NodeId sw);
 }
index 6c007a7dd1df5a582599fdc8e74db98309a2a797..17bb24b16f8ab3d4556b47710e9c08151293d76d 100644 (file)
@@ -309,6 +309,11 @@ public class SwitchManager implements AutoCloseable {
 
         /**
          * Constructor used for tests
+         *
+         * @param node the node id
+         * @param tunnelPort the tunnel port
+         * @param externalPorts the set of expternal ports
+         * @param nodeConfig the ofoverlay node config
          */
         public SwitchState(NodeId node, NodeConnectorId tunnelPort, Set<NodeConnectorId> externalPorts,
                 OfOverlayNodeConfig nodeConfig) {
index bbc6242c04b5e2567a9cc3dcf44cf668b116a0be..677045004d3274f19e9e39cb7f3b067ba948d028 100755 (executable)
@@ -43,9 +43,15 @@ public abstract class Action implements ActionInstanceValidator{
      * Construct a set of actions that will apply to the traffic.  Augment
      * the existing list of actions or add new actions.  It's important
      * that the order of the returned list be consistent however
+     *
      * @param actions The existing actions
      * @param params the parameters for the action instance
-     * @param direction
+     * @param order the order of the list of actions
+     * @param netElements the network elements
+     * @param policyPair the {@link PolicyPair}
+     * @param ofWriter the {@link OfWriter}
+     * @param ctx the OfContext
+     * @param direction the direction of traffic
      * @return the updated list of actions (may be a different length)
      */
     public abstract List<ActionBuilder> updateAction(List<ActionBuilder> actions,
index cadab1fd57d1e7212984202e39c1368c4fff677c..bb276c627c353ba24b0d5fabe6c4accf48338789 100644 (file)
@@ -139,7 +139,9 @@ public class IpProtoClassifier extends Classifier {
     }
 
     /**
-     * May return null.
+     * Return the IpProtocol value. May return null.
+     * @param params the parameters of classifier-instance inserted by user
+     * @return the IpProtocol value
      */
     public static Long getIpProtoValue(Map<String, ParameterValue> params) {
         if (params == null) {
index b2197954c10a1d9d24d5ef8473b9dcc2dde5e83e..3a17a9e19c9de637ad3bcbc2c2a8a42ea482dc3c 100644 (file)
@@ -100,12 +100,9 @@ public class SfcNshHeader {
             SfcNshHeader sfcNshHeader = new SfcNshHeader(this);
             return sfcNshHeader;
         }
+
         /**
          * SfcNshHeaderBuilder requires following in constructor:
-         *
-         * @param nshNspToChain
-         * @param nshNsiToChain
-         * @param nshTunIpDst
          */
         public SfcNshHeaderBuilder() {