You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by to...@apache.org on 2014/10/28 16:41:40 UTC

svn commit: r1634895 - in /sling/trunk/contrib/extensions/replication: core/src/main/java/org/apache/sling/replication/serialization/ core/src/main/java/org/apache/sling/replication/serialization/impl/ core/src/main/java/org/apache/sling/replication/se...

Author: tommaso
Date: Tue Oct 28 15:41:39 2014
New Revision: 1634895

URL: http://svn.apache.org/r1634895
Log:
SLING-4106 - minor fixes on javadoc, AL headers, releasing of resources, typos

Modified:
    sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java
    sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackage.java
    sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackageBuilder.java
    sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/vlt/FileVaultReplicationPackageBuilder.java
    sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ForwardReplicationTest.java
    sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationAgentResourcesIntegrationTest.java
    sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationPackageExporterImporterTest.java
    sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationUtils.java
    sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReverseReplicationTest.java

Modified: sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java (original)
+++ sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java Tue Oct 28 15:41:39 2014
@@ -32,8 +32,7 @@ public interface ReplicationPackageBuild
     /**
      * creates a {@link org.apache.sling.replication.packaging.ReplicationPackage} for a specific {@link ReplicationRequest}
      *
-     *
-     * @param resourceResolver
+     * @param resourceResolver the resource resolver used to access the resources to be packaged
      * @param request the {@link org.apache.sling.replication.communication.ReplicationRequest} to create the package for
      * @return a {@link org.apache.sling.replication.packaging.ReplicationPackage}
      * @throws ReplicationPackageBuildingException
@@ -43,6 +42,7 @@ public interface ReplicationPackageBuild
     /**
      * reads a stream and tries to convert it to a {@link ReplicationPackage} this provider can read and install
      *
+     * @param resourceResolver resource resolver used to store the eventually created package
      * @param stream the {@link InputStream} of the package to read
      * @return a {@link ReplicationPackage} if it can read it from the stream
      * @throws ReplicationPackageReadingException when the stream cannot be read as a {@link ReplicationPackage}
@@ -52,7 +52,8 @@ public interface ReplicationPackageBuild
     /**
      * get an already created (and saved into the repository) {@link ReplicationPackage} by its id
      *
-     * @param id a <code>String</code> representing the unique identifier of an already created {@link ReplicationPackage}
+     * @param resourceResolver resource resolver used to access the package with the given id
+     * @param id the unique identifier of an already created {@link ReplicationPackage}
      * @return a {@link ReplicationPackage} if one with such an id exists, <code>null</code> otherwise
      */
     ReplicationPackage getPackage(ResourceResolver resourceResolver, String id);
@@ -60,6 +61,7 @@ public interface ReplicationPackageBuild
     /**
      * Installs the given replicationPackage into the repository
      *
+     * @param resourceResolver the resource resolver used to install the packaged resources
      * @param replicationPackage the replication package to install
      * @return <code>true</code> if the package was installed successfully
      * @throws ReplicationPackageReadingException

Modified: sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackage.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackage.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackage.java (original)
+++ sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackage.java Tue Oct 28 15:41:39 2014
@@ -1,14 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.sling.replication.serialization.impl;
 
 import org.apache.sling.replication.packaging.ReplicationPackage;
 import org.apache.sling.replication.packaging.ReplicationPackageInfo;
 
+/**
+ * abstract implementation of a {@link org.apache.sling.replication.packaging.ReplicationPackage}
+ */
 public abstract class AbstractReplicationPackage implements ReplicationPackage {
-    private final ReplicationPackageInfo info  = new SimpleReplicationPackageInfo();
+    private final ReplicationPackageInfo info = new SimpleReplicationPackageInfo();
 
     public ReplicationPackageInfo getInfo() {
         return info;
     }
 
-
 }

Modified: sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackageBuilder.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackageBuilder.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackageBuilder.java (original)
+++ sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/AbstractReplicationPackageBuilder.java Tue Oct 28 15:41:39 2014
@@ -141,7 +141,9 @@ public abstract class AbstractReplicatio
         } catch (Exception e) {
             throw new ReplicationPackageReadingException(e);
         } finally {
-            ungetSession(session);
+            if (session != null) {
+                session.logout();
+            }
         }
 
         return false;
@@ -171,11 +173,6 @@ public abstract class AbstractReplicatio
         return session;
     }
 
-    protected void ungetSession(Session session) {
-
-    }
-
-
     protected abstract ReplicationPackage createPackageForAdd(ResourceResolver resourceResolver, ReplicationRequest request)
             throws ReplicationPackageBuildingException;
 

Modified: sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/vlt/FileVaultReplicationPackageBuilder.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/vlt/FileVaultReplicationPackageBuilder.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/vlt/FileVaultReplicationPackageBuilder.java (original)
+++ sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/vlt/FileVaultReplicationPackageBuilder.java Tue Oct 28 15:41:39 2014
@@ -98,7 +98,9 @@ public class FileVaultReplicationPackage
         } catch (Exception e) {
             throw new ReplicationPackageBuildingException(e);
         } finally {
-           ungetSession(session);
+           if (session != null) {
+               session.logout();
+           }
         }
     }
 
@@ -164,7 +166,9 @@ public class FileVaultReplicationPackage
             log.error("could not read / install the package", e);
             throw new ReplicationPackageReadingException(e);
         } finally {
-           ungetSession(session);
+           if (session != null) {
+               session.logout();
+           }
         }
         return false;
     }

Modified: sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ForwardReplicationTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ForwardReplicationTest.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ForwardReplicationTest.java (original)
+++ sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ForwardReplicationTest.java Tue Oct 28 15:41:39 2014
@@ -22,7 +22,7 @@ import org.apache.sling.replication.comm
 import org.junit.Test;
 
 import static org.apache.sling.replication.it.ReplicationUtils.assertExists;
-import static org.apache.sling.replication.it.ReplicationUtils.assertNotExits;
+import static org.apache.sling.replication.it.ReplicationUtils.assertNotExists;
 import static org.apache.sling.replication.it.ReplicationUtils.createRandomNode;
 import static org.apache.sling.replication.it.ReplicationUtils.replicate;
 
@@ -44,7 +44,7 @@ public class ForwardReplicationTest exte
         String nodePath = createRandomNode(publishClient, "/content/forward_del_" + System.nanoTime());
         assertExists(publishClient, nodePath);
         replicate(author, "publish", ReplicationActionType.DELETE, nodePath);
-        assertNotExits(publishClient, nodePath);
+        assertNotExists(publishClient, nodePath);
     }
 
 }

Modified: sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationAgentResourcesIntegrationTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationAgentResourcesIntegrationTest.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationAgentResourcesIntegrationTest.java (original)
+++ sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationAgentResourcesIntegrationTest.java Tue Oct 28 15:41:39 2014
@@ -26,7 +26,7 @@ import static org.apache.sling.replicati
 import static org.apache.sling.replication.it.ReplicationUtils.agentRootUrl;
 import static org.apache.sling.replication.it.ReplicationUtils.agentUrl;
 import static org.apache.sling.replication.it.ReplicationUtils.assertExists;
-import static org.apache.sling.replication.it.ReplicationUtils.assertNotExits;
+import static org.apache.sling.replication.it.ReplicationUtils.assertNotExists;
 import static org.apache.sling.replication.it.ReplicationUtils.assertResponseContains;
 import static org.apache.sling.replication.it.ReplicationUtils.deleteNode;
 import static org.apache.sling.replication.it.ReplicationUtils.queueUrl;
@@ -69,7 +69,7 @@ public class ReplicationAgentResourcesIn
                 "cache-flush"
         };
         for (String agentName : defaultPublishAgentNames) {
-            assertNotExits(authorClient, agentUrl(agentName));
+            assertNotExists(authorClient, agentUrl(agentName));
         }
     }
 
@@ -93,7 +93,7 @@ public class ReplicationAgentResourcesIn
                 "cache-flush"
         };
         for (String agentName : defaultPublishAgentNames) {
-            assertNotExits(authorClient, queueUrl(agentName));
+            assertNotExists(authorClient, queueUrl(agentName));
         }
     }
 
@@ -137,8 +137,7 @@ public class ReplicationAgentResourcesIn
         assertExists(authorClient, newConfigResource);
 
         deleteNode(author, newConfigResource);
-        // authorClient.delete does not work for some reason
-        assertNotExits(authorClient, newConfigResource);
+        assertNotExists(authorClient, newConfigResource);
     }
 
 

Modified: sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationPackageExporterImporterTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationPackageExporterImporterTest.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationPackageExporterImporterTest.java (original)
+++ sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationPackageExporterImporterTest.java Tue Oct 28 15:41:39 2014
@@ -23,7 +23,7 @@ import org.apache.sling.replication.comm
 import org.junit.Test;
 
 import static org.apache.sling.replication.it.ReplicationUtils.assertExists;
-import static org.apache.sling.replication.it.ReplicationUtils.assertNotExits;
+import static org.apache.sling.replication.it.ReplicationUtils.assertNotExists;
 import static org.apache.sling.replication.it.ReplicationUtils.createRandomNode;
 import static org.apache.sling.replication.it.ReplicationUtils.doExport;
 import static org.apache.sling.replication.it.ReplicationUtils.doImport;
@@ -38,7 +38,7 @@ public class ReplicationPackageExporterI
         String content = doExport(publish, "default", ReplicationActionType.ADD, nodePath);
 
         publishClient.delete(nodePath);
-        assertNotExits(publishClient, nodePath);
+        assertNotExists(publishClient, nodePath);
 
         doImport(publish, "default", content.getBytes(HTTP.DEFAULT_CONTENT_CHARSET));
         assertExists(publishClient, nodePath);
@@ -53,6 +53,6 @@ public class ReplicationPackageExporterI
         String content = doExport(publish, "default", ReplicationActionType.DELETE, nodePath);
 
         doImport(publish, "default", content.getBytes(HTTP.DEFAULT_CONTENT_CHARSET));
-        assertNotExits(publishClient, nodePath);
+        assertNotExists(publishClient, nodePath);
     }
 }

Modified: sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationUtils.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationUtils.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationUtils.java (original)
+++ sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReplicationUtils.java Tue Oct 28 15:41:39 2014
@@ -153,7 +153,7 @@ public class ReplicationUtils {
         assertTrue("path " + path + " doesn't exist", slingClient.exists(path));
     }
 
-    public static void assertNotExits(SlingClient slingClient, String path) throws Exception {
+    public static void assertNotExists(SlingClient slingClient, String path) throws Exception {
         int retries = 100;
         while (slingClient.exists(path) && retries-- > 0) {
             Thread.sleep(1000);

Modified: sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReverseReplicationTest.java
URL: http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReverseReplicationTest.java?rev=1634895&r1=1634894&r2=1634895&view=diff
==============================================================================
--- sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReverseReplicationTest.java (original)
+++ sling/trunk/contrib/extensions/replication/it/src/test/java/org/apache/sling/replication/it/ReverseReplicationTest.java Tue Oct 28 15:41:39 2014
@@ -23,7 +23,7 @@ import org.apache.sling.replication.comm
 import org.junit.Test;
 
 import static org.apache.sling.replication.it.ReplicationUtils.assertExists;
-import static org.apache.sling.replication.it.ReplicationUtils.assertNotExits;
+import static org.apache.sling.replication.it.ReplicationUtils.assertNotExists;
 import static org.apache.sling.replication.it.ReplicationUtils.createRandomNode;
 import static org.apache.sling.replication.it.ReplicationUtils.replicate;
 
@@ -45,6 +45,6 @@ public class ReverseReplicationTest exte
         String nodePath = createRandomNode(authorClient, "/content/reverse_del_" + System.nanoTime());
         assertExists(authorClient, nodePath);
         replicate(publish, "reverse", ReplicationActionType.DELETE, nodePath);
-        assertNotExits(authorClient, nodePath);
+        assertNotExists(authorClient, nodePath);
     }
 }