Author: tommaso
Date: Fri Aug 15 09:44:00 2014
New Revision: 1618126
URL: http://svn.apache.org/r1618126
Log:
SLING-3816 - fixed some javadoc issues
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageImporter.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/queue/ReplicationQueue.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/rule/impl/ReplicateOnQueueEventRule.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackage.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageBuilder.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/servlet/ReplicationPackageImporterServlet.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/transport/ReplicationTransportHandler.java
sling/trunk/contrib/extensions/replication/core/src/test/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageTest.java
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageImporter.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageImporter.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageImporter.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageImporter.java
Fri Aug 15 09:44:00 2014
@@ -23,11 +23,13 @@ import java.io.InputStream;
import
org.apache.sling.replication.serialization.ReplicationPackageReadingException;
/**
- * A {@link org.apache.sling.replication.packaging.ReplicationPackage} importer
+ * A {@link org.apache.sling.replication.packaging.ReplicationPackageImporter}
is responsible for importing
+ * {@link org.apache.sling.replication.packaging.ReplicationPackage}s into the
resource tree.
*/
public interface ReplicationPackageImporter {
/**
* Imports the given replication package
+ *
* @param replicationPackage - the package to be imported
* @return <code>true</code> if the import succeeded, <code>false</code>
otherwise
*/
@@ -36,10 +38,9 @@ public interface ReplicationPackageImpor
/**
* reads a stream and tries to convert it to a {@link ReplicationPackage}
this provider can read and install
*
- * @param stream the {@link InputStream} of the package to read
+ * @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}
+ * @throws ReplicationPackageReadingException when the stream cannot be
read as a {@link ReplicationPackage}
*/
ReplicationPackage readPackage(InputStream stream) throws
ReplicationPackageReadingException;
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/queue/ReplicationQueue.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/queue/ReplicationQueue.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/queue/ReplicationQueue.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/queue/ReplicationQueue.java
Fri Aug 15 09:44:00 2014
@@ -35,35 +35,31 @@ public interface ReplicationQueue {
/**
* add a replication package to this queue
*
- *
* @param replicationPackage a replication package to replicate
* @return <code>true</code> if the replication package was added
correctly to the queue,
* <code>false</code otherwise
- * @throws ReplicationQueueException
*/
boolean add(ReplicationQueueItem replicationPackage);
/**
* get the status of a certain package in the queue
*
- *
- * @param replicationPackage the replication package to get the status for
+ * @param item the replication package to get the status for
* @return the item status in the queue
* @throws ReplicationQueueException
*/
- ReplicationQueueItemState getStatus(ReplicationQueueItem
replicationPackage)
+ ReplicationQueueItemState getStatus(ReplicationQueueItem item)
throws ReplicationQueueException;
/**
* get the first item (FIFO wise, the next to be processed) into the queue
*
- * @return the first replication package into the queue
+ * @return the first item into the queue
*/
ReplicationQueueItem getHead();
/**
* remove the first package into the queue from it
- *
*/
void removeHead();
@@ -77,12 +73,13 @@ public interface ReplicationQueue {
/**
* get the items in the queue
*
- * @return a <code>Collection</code> of {@link
org.apache.sling.replication.packaging.ReplicationPackage}s
+ * @return a <code>Collection</code> of {@link
org.apache.sling.replication.queue.ReplicationQueueItem}s
*/
Collection<ReplicationQueueItem> getItems();
/**
* remove an item from the queue by specifying its id
+ *
* @param id <code>String</code> representing an item's identifier
*/
void remove(String id);
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/rule/impl/ReplicateOnQueueEventRule.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/rule/impl/ReplicateOnQueueEventRule.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/rule/impl/ReplicateOnQueueEventRule.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/rule/impl/ReplicateOnQueueEventRule.java
Fri Aug 15 09:44:00 2014
@@ -25,6 +25,7 @@ import java.util.concurrent.ConcurrentHa
import java.util.concurrent.Future;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
@@ -58,9 +59,10 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * {@link org.apache.sling.replication.rule.ReplicationRule} to trigger
+ * {@link org.apache.sling.replication.rule.ReplicationRule} to trigger
replication upon reception of server sent events
+ * on a certain queue
*/
-@Component(immediate = true, label = "Rule for generating Server Sent Events
for Queues")
+@Component(immediate = true, label = "Rule for listening on Server Sent Events
for Queues")
@Service(value = ReplicationRule.class)
public class ReplicateOnQueueEventRule implements ReplicationRule {
@@ -72,7 +74,6 @@ public class ReplicateOnQueueEventRule i
private static final Pattern signaturePattern =
Pattern.compile(SIGNATURE_REGEX);
-
@Reference
private Scheduler scheduler;
@@ -219,7 +220,6 @@ public class ReplicateOnQueueEventRule i
new SSEResponseConsumer(agent, actionType,
path), null);
requests.put(agent.getName(), futureResponse);
futureResponse.get();
-
} finally {
httpClient.close();
}
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackage.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackage.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackage.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackage.java
Fri Aug 15 09:44:00 2014
@@ -23,6 +23,7 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.Arrays;
+
import org.apache.commons.io.IOUtils;
import org.apache.jackrabbit.vault.util.Text;
import org.apache.sling.replication.communication.ReplicationActionType;
@@ -34,6 +35,8 @@ import org.apache.sling.replication.pack
*/
public class VoidReplicationPackage implements ReplicationPackage {
+ private static final String TYPE = "VOID";
+
private final String type;
private final String[] paths;
@@ -42,6 +45,10 @@ public class VoidReplicationPackage impl
private final String action;
+ public VoidReplicationPackage(ReplicationRequest request) {
+ this(request, TYPE);
+ }
+
public VoidReplicationPackage(ReplicationRequest request, String type) {
this.type = type;
this.paths = request.getPaths();
@@ -57,7 +64,7 @@ public class VoidReplicationPackage impl
String[] parts = streamString.split(":");
- if(parts.length < 4) return null;
+ if (parts.length < 4) return null;
String actionString = parts[0];
String pathsString = parts[1];
@@ -67,7 +74,7 @@ public class VoidReplicationPackage impl
ReplicationActionType replicationActionType =
ReplicationActionType.fromName(actionString);
VoidReplicationPackage replicationPackage = null;
- if(replicationActionType != null){
+ if (replicationActionType != null) {
pathsString = Text.unescape(pathsString);
String[] paths = pathsString.split(", ");
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageBuilder.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageBuilder.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageBuilder.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageBuilder.java
Fri Aug 15 09:44:00 2014
@@ -18,6 +18,10 @@
*/
package org.apache.sling.replication.serialization.impl;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
@@ -27,18 +31,15 @@ import org.apache.sling.replication.seri
import
org.apache.sling.replication.serialization.ReplicationPackageBuildingException;
import
org.apache.sling.replication.serialization.ReplicationPackageReadingException;
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-
@Component(metatype = false, label = "Void Replication Package Builder")
@Service(value = ReplicationPackageBuilder.class)
@Property(name = "name", value = VoidReplicationPackageBuilder.NAME)
public class VoidReplicationPackageBuilder implements
ReplicationPackageBuilder {
- public static final String NAME = "void";
+
+ static final String NAME = "void";
public ReplicationPackage createPackage(ReplicationRequest request) throws
ReplicationPackageBuildingException {
- return new VoidReplicationPackage(request, "VOID");
+ return new VoidReplicationPackage(request);
}
public ReplicationPackage readPackage(InputStream stream) throws
ReplicationPackageReadingException {
@@ -52,8 +53,7 @@ public class VoidReplicationPackageBuild
public ReplicationPackage getPackage(String id) {
try {
return VoidReplicationPackage.fromStream(new
ByteArrayInputStream(id.getBytes("UTF-8")));
- }
- catch (IOException ex){
+ } catch (IOException ex) {
return null;
}
}
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/servlet/ReplicationPackageImporterServlet.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/servlet/ReplicationPackageImporterServlet.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/servlet/ReplicationPackageImporterServlet.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/servlet/ReplicationPackageImporterServlet.java
Fri Aug 15 09:44:00 2014
@@ -18,10 +18,11 @@
*/
package org.apache.sling.replication.servlet;
-import java.io.IOException;
-import java.io.InputStream;
import javax.servlet.Servlet;
import javax.servlet.ServletException;
+import java.io.IOException;
+import java.io.InputStream;
+
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
@@ -29,9 +30,9 @@ import org.apache.felix.scr.annotations.
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
-import org.apache.sling.replication.resources.ReplicationConstants;
import org.apache.sling.replication.packaging.ReplicationPackage;
import org.apache.sling.replication.packaging.ReplicationPackageImporter;
+import org.apache.sling.replication.resources.ReplicationConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -64,7 +65,11 @@ public class ReplicationPackageImporterS
InputStream stream = request.getInputStream();
try {
ReplicationPackage replicationPackage =
replicationPackageImporter.readPackage(stream);
- success =
replicationPackageImporter.importPackage(replicationPackage);
+ if (replicationPackage != null) {
+ success =
replicationPackageImporter.importPackage(replicationPackage);
+ } else {
+ log.warn("cannot read a replication package from the given
stream");
+ }
} catch (final Exception e) {
response.setStatus(400);
log.error("Error during replication: {}", e.getMessage(), e);
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/transport/ReplicationTransportHandler.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/transport/ReplicationTransportHandler.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/transport/ReplicationTransportHandler.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/transport/ReplicationTransportHandler.java
Fri Aug 15 09:44:00 2014
@@ -18,12 +18,12 @@
*/
package org.apache.sling.replication.transport;
+import java.util.List;
+
import org.apache.sling.replication.communication.ReplicationEndpoint;
import org.apache.sling.replication.communication.ReplicationRequest;
import org.apache.sling.replication.packaging.ReplicationPackage;
-import java.util.List;
-
/**
* A <code>TransportHandler</code> is responsible for implementing the
transport of a
* {@link ReplicationPackage}s to / from another instance described by a
{@link ReplicationEndpoint}
@@ -33,7 +33,7 @@ public interface ReplicationTransportHan
/**
* Delivers a given {@link ReplicationPackage}
*
- * @param replicationPackage a {@link ReplicationPackage} to transport
+ * @param replicationPackage a {@link ReplicationPackage} to transport
* @throws ReplicationTransportException if any error occurs during the
transport
*/
void deliverPackage(ReplicationPackage replicationPackage) throws
ReplicationTransportException;
@@ -41,6 +41,7 @@ public interface ReplicationTransportHan
/**
* Retrieves a list of {@link ReplicationPackage}
*
+ * @param replicationRequest the replication request
* @throws ReplicationTransportException if any error occurs during the
transport
*/
public List<ReplicationPackage> retrievePackages(ReplicationRequest
replicationRequest) throws ReplicationTransportException;
Modified:
sling/trunk/contrib/extensions/replication/core/src/test/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageTest.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/test/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageTest.java?rev=1618126&r1=1618125&r2=1618126&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/test/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageTest.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/test/java/org/apache/sling/replication/serialization/impl/VoidReplicationPackageTest.java
Fri Aug 15 09:44:00 2014
@@ -36,7 +36,7 @@ public class VoidReplicationPackageTest
@Test
public void testCreatedAndReadPackagesEquality() throws Exception {
ReplicationRequest request = new ReplicationRequest(123l,
ReplicationActionType.DELETE, "/abc");
- VoidReplicationPackage createdPackage = new
VoidReplicationPackage(request, "VOID");
+ VoidReplicationPackage createdPackage = new
VoidReplicationPackage(request);
VoidReplicationPackage readPackage =
VoidReplicationPackage.fromStream(new
ByteArrayInputStream("DELETE:/abc:123:VOID".getBytes()));
assertEquals(createdPackage.getId(), readPackage.getId());
assertEquals(createdPackage.getAction(), readPackage.getAction());
