From: Sasidharan Sambasivam <sasidharan.s.sambasivam@ericsson.com>
Date: Thu, 2 Apr 2015 09:38:42 +0000 (+0530)
Subject: resolved checkstyle warnings
X-Git-Tag: release/lithium~82
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=vpnservice.git;a=commitdiff_plain;h=272200b362c916ee5af9fa07a5dcd34c1b4a10b6

resolved checkstyle warnings

Change-Id: I891a27585291bd1bb2f8a5e700da248711652fb3
Signed-off-by: Sasidharan Sambasivam <sasidharan.s.sambasivam@ericsson.com>
---

diff --git a/commons/src/main/resources/odl_checks.xml b/commons/src/main/resources/vpns_checks.xml
similarity index 99%
rename from commons/src/main/resources/odl_checks.xml
rename to commons/src/main/resources/vpns_checks.xml
index da55fb5f..ea14c9eb 100644
--- a/commons/src/main/resources/odl_checks.xml
+++ b/commons/src/main/resources/vpns_checks.xml
@@ -150,9 +150,9 @@
              value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
         </module>
         <module name="Indentation">
-            <property name="basicOffset" value="2"/>
+            <property name="basicOffset" value="4"/>
             <property name="braceAdjustment" value="0"/>
-            <property name="caseIndent" value="2"/>
+            <property name="caseIndent" value="4"/>
             <property name="throwsIndent" value="4"/>
         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
             <property name="lineWrappingIndentation" value="4"/>
diff --git a/interfacemgr/interfacemgr-impl/pom.xml b/interfacemgr/interfacemgr-impl/pom.xml
index 9f7df5d1..52ad8bfb 100644
--- a/interfacemgr/interfacemgr-impl/pom.xml
+++ b/interfacemgr/interfacemgr-impl/pom.xml
@@ -42,7 +42,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
         <artifactId>maven-checkstyle-plugin</artifactId>
         <configuration>
           <configLocation>
-            ${project.basedir}/../../commons/src/main/resources/odl_checks.xml
+            ${project.basedir}/../../commons/src/main/resources/vpns_checks.xml
           </configLocation>
           <failsOnError>true</failsOnError>
           <includes>**/*.java,**/*.xml,**/*.ini,**/*.sh,**/*.bat</includes>
diff --git a/vpnmanager-impl/pom.xml b/vpnmanager-impl/pom.xml
index d7762002..5d02077d 100644
--- a/vpnmanager-impl/pom.xml
+++ b/vpnmanager-impl/pom.xml
@@ -37,5 +37,21 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
        <scope>test</scope>
     </dependency>
   </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <configuration>
+          <configLocation>
+            ${project.basedir}/../commons/src/main/resources/vpns_checks.xml
+          </configLocation>
+          <failsOnError>true</failsOnError>
+          <includes>**/*.java,**/*.xml,**/*.ini</includes>
+          <excludes>**/yang/</excludes>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 
 </project>
diff --git a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/AbstractDataChangeListener.java b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/AbstractDataChangeListener.java
index 38530a71..88e2893f 100644
--- a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/AbstractDataChangeListener.java
+++ b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/AbstractDataChangeListener.java
@@ -23,10 +23,14 @@ import java.util.Set;
  * AbstractDataChangeListener implemented basic {@link DataChangeListener} processing for
  * VPN related Data Objects.
  */
-public abstract class AbstractDataChangeListener <T extends DataObject> implements DataChangeListener {
+public abstract class AbstractDataChangeListener<T extends DataObject> implements DataChangeListener {
 
     protected final Class<T> clazz;
 
+    /**
+     * 
+     * @param clazz - for which the data change event is received
+     */
     public AbstractDataChangeListener(Class<T> clazz) {
         this.clazz = Preconditions.checkNotNull(clazz, "Class can not be null!");
     }
@@ -37,16 +41,16 @@ public abstract class AbstractDataChangeListener <T extends DataObject> implemen
 
         /* All DataObjects for create */
         final Map<InstanceIdentifier<?>, DataObject> createdData = changeEvent.getCreatedData() != null
-                ? changeEvent.getCreatedData() : Collections.<InstanceIdentifier<?>, DataObject> emptyMap();
+                ? changeEvent.getCreatedData() : Collections.<InstanceIdentifier<?>, DataObject>emptyMap();
         /* All DataObjects for remove */
         final Set<InstanceIdentifier<?>> removeData = changeEvent.getRemovedPaths() != null
-                ? changeEvent.getRemovedPaths() : Collections.<InstanceIdentifier<?>> emptySet();
+                ? changeEvent.getRemovedPaths() : Collections.<InstanceIdentifier<?>>emptySet();
         /* All DataObjects for updates */
         final Map<InstanceIdentifier<?>, DataObject> updateData = changeEvent.getUpdatedData() != null
-                ? changeEvent.getUpdatedData() : Collections.<InstanceIdentifier<?>, DataObject> emptyMap();
+                ? changeEvent.getUpdatedData() : Collections.<InstanceIdentifier<?>, DataObject>emptyMap();
         /* All Original DataObjects */
         final Map<InstanceIdentifier<?>, DataObject> originalData = changeEvent.getOriginalData() != null
-                ? changeEvent.getOriginalData() : Collections.<InstanceIdentifier<?>, DataObject> emptyMap();
+                ? changeEvent.getOriginalData() : Collections.<InstanceIdentifier<?>, DataObject>emptyMap();
 
         this.createData(createdData);
         this.updateData(updateData, originalData);
@@ -56,14 +60,14 @@ public abstract class AbstractDataChangeListener <T extends DataObject> implemen
     @SuppressWarnings("unchecked")
     private void createData(final Map<InstanceIdentifier<?>, DataObject> createdData) {
         final Set<InstanceIdentifier<?>> keys = createdData.keySet() != null
-                ? createdData.keySet() : Collections.<InstanceIdentifier<?>> emptySet();
+                ? createdData.keySet() : Collections.<InstanceIdentifier<?>>emptySet();
         for (InstanceIdentifier<?> key : keys) {
             if (clazz.equals(key.getTargetType())) {
-                 InstanceIdentifier<T> createKeyIdent = key.firstIdentifierOf(clazz);
-                 final Optional<DataObject> value = Optional.of(createdData.get(key));
-                 if (value.isPresent()) {
-                     this.add(createKeyIdent, (T)value.get());
-                 }
+                InstanceIdentifier<T> createKeyIdent = key.firstIdentifierOf(clazz);
+                final Optional<DataObject> value = Optional.of(createdData.get(key));
+                if (value.isPresent()) {
+                    this.add(createKeyIdent, (T)value.get());
+                }
             }
         }
     }
@@ -73,16 +77,16 @@ public abstract class AbstractDataChangeListener <T extends DataObject> implemen
             final Map<InstanceIdentifier<?>, DataObject> originalData) {
 
         final Set<InstanceIdentifier<?>> keys = updateData.keySet() != null
-                ? updateData.keySet() : Collections.<InstanceIdentifier<?>> emptySet();
+                ? updateData.keySet() : Collections.<InstanceIdentifier<?>>emptySet();
         for (InstanceIdentifier<?> key : keys) {
-          if (clazz.equals(key.getTargetType())) {
-              InstanceIdentifier<T> updateKeyIdent = key.firstIdentifierOf(clazz);
-              final Optional<DataObject> value = Optional.of(updateData.get(key));
-              final Optional<DataObject> original = Optional.of(originalData.get(key));
-              if (value.isPresent() && original.isPresent()) {
-                this.update(updateKeyIdent, (T)original.get(), (T)value.get());
-              }
-          }
+            if (clazz.equals(key.getTargetType())) {
+                InstanceIdentifier<T> updateKeyIdent = key.firstIdentifierOf(clazz);
+                final Optional<DataObject> value = Optional.of(updateData.get(key));
+                final Optional<DataObject> original = Optional.of(originalData.get(key));
+                if (value.isPresent() && original.isPresent()) {
+                    this.update(updateKeyIdent, (T)original.get(), (T)value.get());
+                }
+            }
         }
     }
 
@@ -92,9 +96,9 @@ public abstract class AbstractDataChangeListener <T extends DataObject> implemen
 
         for (InstanceIdentifier<?> key : removeData) {
             if (clazz.equals(key.getTargetType())) {
-                   final InstanceIdentifier<T> ident = key.firstIdentifierOf(clazz);
-                    final DataObject removeValue = originalData.get(key);
-                    this.remove(ident, (T)removeValue);
+                final InstanceIdentifier<T> ident = key.firstIdentifierOf(clazz);
+                final DataObject removeValue = originalData.get(key);
+                this.remove(ident, (T)removeValue);
             }
         }
     }
diff --git a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnInterfaceManager.java b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnInterfaceManager.java
index ae286b66..d46f1624 100644
--- a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnInterfaceManager.java
+++ b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnInterfaceManager.java
@@ -7,11 +7,8 @@
  */
 package org.opendaylight.vpnservice;
 
-import java.util.Collections;
+
 import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.Future;
 
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
@@ -20,14 +17,13 @@ import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.NextHopList;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.next.hop.list.*;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.next.hop.list.L3NextHops;
 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.VpnInterface1;
 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
@@ -38,11 +34,17 @@ import org.slf4j.LoggerFactory;
 import com.google.common.base.Optional;
 import com.google.common.collect.FluentIterable;
 
-public class VpnInterfaceManager extends AbstractDataChangeListener<VpnInterface> implements AutoCloseable{
+public class VpnInterfaceManager extends AbstractDataChangeListener<VpnInterface> implements AutoCloseable {
     private static final Logger LOG = LoggerFactory.getLogger(VpnInterfaceManager.class);
     private ListenerRegistration<DataChangeListener> listenerRegistration;
     private final DataBroker broker;
-    
+
+    /**
+     * Responsible for listening to data change related to VPN Interface
+     * Bind VPN Service on the interface and informs the BGP service
+     * 
+     * @param db - dataBroker service reference
+     */
     public VpnInterfaceManager(final DataBroker db) {
         super(VpnInterface.class);
         broker = db;
@@ -61,7 +63,7 @@ public class VpnInterfaceManager extends AbstractDataChangeListener<VpnInterface
         }
         LOG.info("VPN Interface Manager Closed");
     }
-    
+
     private void registerListener(final DataBroker db) {
         try {
             listenerRegistration = db.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
@@ -87,7 +89,7 @@ public class VpnInterfaceManager extends AbstractDataChangeListener<VpnInterface
                 InstanceIdentifier.builder(Interfaces.class).child(Interface.class, new InterfaceKey(interfaceName));
         InstanceIdentifier<Interface> id = idBuilder.build();
         Optional<Interface> port = read(LogicalDatastoreType.CONFIGURATION, id);
-        if(port.isPresent()) {
+        if (port.isPresent()) {
             Interface interf = port.get();
             bindServiceOnInterface(interf);
             updateNextHops(identifier);
@@ -98,15 +100,15 @@ public class VpnInterfaceManager extends AbstractDataChangeListener<VpnInterface
         //Read NextHops
         InstanceIdentifier<VpnInterface1> path = identifier.augmentation(VpnInterface1.class);
         Optional<VpnInterface1> nextHopList = read(LogicalDatastoreType.CONFIGURATION, path);
-        
-        if(nextHopList.isPresent()) {
+
+        if (nextHopList.isPresent()) {
             List<L3NextHops> nextHops = nextHopList.get().getL3NextHops();
-            
-            if(!nextHops.isEmpty()) {
-                LOG.info("NextHops are "+ nextHops);
-                for(L3NextHops nextHop : nextHops) {
+
+            if (!nextHops.isEmpty()) {
+                LOG.info("NextHops are " + nextHops);
+                for (L3NextHops nextHop : nextHops) {
                     //TODO: Generate label for the prefix and store it in the next hop model
-                    
+
                     //TODO: Update BGP
                     updatePrefixToBGP(nextHop);
                 }
diff --git a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnManager.java b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnManager.java
index 7a957af4..fc02a3f8 100644
--- a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnManager.java
+++ b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnManager.java
@@ -7,30 +7,28 @@
  */
 package org.opendaylight.vpnservice;
 
-import java.util.Collections;
-import java.util.Map;
-import java.util.Set;
-
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
-import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-
-public class VpnManager extends AbstractDataChangeListener<VpnInstance> implements AutoCloseable{
+public class VpnManager extends AbstractDataChangeListener<VpnInstance> implements AutoCloseable {
     private static final Logger LOG = LoggerFactory.getLogger(VpnManager.class);
     private ListenerRegistration<DataChangeListener> listenerRegistration;
     private final DataBroker broker;
 
+    /**
+     * Listens for data change related to VPN Instance
+     * Informs the BGP about VRF information
+     * 
+     * @param db - dataBroker reference
+     */
     public VpnManager(final DataBroker db) {
         super(VpnInstance.class);
         broker = db;
diff --git a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnserviceProvider.java b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnserviceProvider.java
index 1ad8b593..84b18382 100644
--- a/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnserviceProvider.java
+++ b/vpnmanager-impl/src/main/java/org/opendaylight/vpnservice/VpnserviceProvider.java
@@ -28,7 +28,7 @@ public class VpnserviceProvider implements BindingAwareProvider,
             final  DataBroker dataBroker = session.getSALService(DataBroker.class);
             vpnManager = new VpnManager(dataBroker);
             vpnInterfaceManager = new VpnInterfaceManager(dataBroker);
-        } catch(Exception e) {
+        } catch (Exception e) {
             LOG.error("Error initializing services", e);
         }
     }