Author: tommaso
Date: Mon Sep 29 14:08:39 2014
New Revision: 1628185
URL: http://svn.apache.org/r1628185
Log:
SLING-3891 - added some missing javadoc
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationAgentHistory.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationEndpoint.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationRequest.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/event/ReplicationEvent.java
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/serialization/ReplicationPackageBuilder.java
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationAgentHistory.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationAgentHistory.java?rev=1628185&r1=1628184&r2=1628185&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationAgentHistory.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationAgentHistory.java
Mon Sep 29 14:08:39 2014
@@ -20,14 +20,18 @@ package org.apache.sling.replication.com
import java.util.SortedMap;
+import org.apache.sling.replication.agent.ReplicationAgent;
+
/**
* The communication history for a certain agent
*/
public interface ReplicationAgentHistory {
- SortedMap<ReplicationRequest, ReplicationResponse> getCommunication();
-
- ReplicationResponse getResponseFor(ReplicationRequest request);
+ /**
+ * get the communication history of a certain agent
+ *
+ * @return
+ */
+ SortedMap<ReplicationRequest, ReplicationResponse>
getCommunication(ReplicationAgent agent);
- ReplicationResponse getResponseFor(String requestId);
}
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationEndpoint.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationEndpoint.java?rev=1628185&r1=1628184&r2=1628185&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationEndpoint.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationEndpoint.java
Mon Sep 29 14:08:39 2014
@@ -35,6 +35,11 @@ public class ReplicationEndpoint {
this.uri = URI.create(uriString);
}
+ /**
+ * get the URI of this replication endpoint
+ *
+ * @return a <code>URI</code>
+ */
public URI getUri() {
return uri;
}
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationRequest.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationRequest.java?rev=1628185&r1=1628184&r2=1628185&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationRequest.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/communication/ReplicationRequest.java
Mon Sep 29 14:08:39 2014
@@ -35,14 +35,29 @@ public class ReplicationRequest {
this.paths = paths;
}
+ /**
+ * get the time this replication request was created
+ *
+ * @return a <code>long</code> representing the replication request
creation time
+ */
public long getTime() {
return time;
}
+ /**
+ * get the {@link
org.apache.sling.replication.communication.ReplicationActionType} associated
with this request
+ *
+ * @return the action as a <code>ReplicationActionType</code>
+ */
public ReplicationActionType getAction() {
return action;
}
+ /**
+ * get the paths for this replication request
+ *
+ * @return an array of <code>String</code>s representing the paths
+ */
public String[] getPaths() {
return paths;
}
Modified:
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/event/ReplicationEvent.java
URL:
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/event/ReplicationEvent.java?rev=1628185&r1=1628184&r2=1628185&view=diff
==============================================================================
---
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/event/ReplicationEvent.java
(original)
+++
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/event/ReplicationEvent.java
Mon Sep 29 14:08:39 2014
@@ -33,6 +33,12 @@ public class ReplicationEvent extends Ev
super(getTopic(type), properties);
}
+ /**
+ * get the topic for a certain event type
+ *
+ * @param type the {@link
org.apache.sling.replication.event.ReplicationEventType} to get the topic for
+ * @return a <code>String</code> representing the topic
+ */
public static String getTopic(ReplicationEventType type) {
return EVENT_TOPIC + '/' + type.toString();
}
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=1628185&r1=1628184&r2=1628185&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
Mon Sep 29 14:08:39 2014
@@ -57,8 +57,8 @@ public interface ReplicationPackageBuild
/**
* Installs the given replicationPackage into the repository
*
- * @param replicationPackage
- * @return
+ * @param replicationPackage the replication package to install
+ * @return <code>true</code> if the package was installed successfully
* @throws ReplicationPackageReadingException
*/
boolean installPackage(ReplicationPackage replicationPackage) throws
ReplicationPackageReadingException;
