You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by tm...@apache.org on 2018/01/02 14:31:23 UTC
[sling-org-apache-sling-distribution-core] branch master updated:
SLING-7057 - Add description to Distribution Trigger implementations
This is an automated email from the ASF dual-hosted git repository.
tmaret pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-core.git
The following commit(s) were added to refs/heads/master by this push:
new 953a06a SLING-7057 - Add description to Distribution Trigger implementations
953a06a is described below
commit 953a06a15628976cc7cbaf2d9a6768eee5ddd8c1
Author: tmaret <tm...@adobe.com>
AuthorDate: Tue Jan 2 15:04:35 2018 +0100
SLING-7057 - Add description to Distribution Trigger implementations
---
.../trigger/impl/JcrEventDistributionTriggerFactory.java | 6 ++++--
.../trigger/impl/ResourceEventDistributionTriggerFactory.java | 4 +++-
.../trigger/impl/ScheduledDistributionTriggerFactory.java | 8 +++++---
3 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/sling/distribution/trigger/impl/JcrEventDistributionTriggerFactory.java b/src/main/java/org/apache/sling/distribution/trigger/impl/JcrEventDistributionTriggerFactory.java
index 85e837f..7a631b4 100644
--- a/src/main/java/org/apache/sling/distribution/trigger/impl/JcrEventDistributionTriggerFactory.java
+++ b/src/main/java/org/apache/sling/distribution/trigger/impl/JcrEventDistributionTriggerFactory.java
@@ -43,7 +43,9 @@ import org.apache.sling.jcr.api.SlingRepository;
label = "Apache Sling Distribution Trigger - Jcr Event Triggers Factory",
configurationFactory = true,
specVersion = "1.1",
- policy = ConfigurationPolicy.REQUIRE
+ policy = ConfigurationPolicy.REQUIRE,
+ description = "Triggers a distribution request ('ADD', 'DELETE') " +
+ "for the given path (path) whenever the JCR node at the given path is modified (added, resp. removed)."
)
@Service(DistributionTrigger.class)
@Property(name="webconsole.configurationFactory.nameHint", value="Trigger name: {name} on path {path}")
@@ -74,7 +76,7 @@ public class JcrEventDistributionTriggerFactory implements DistributionTrigger {
/**
* use deep distribution
*/
- @Property(label = "Use deep distribution", description = "Distribute entire subtree of the event node path", boolValue = false)
+ @Property(label = "Use deep distribution", description = "Distribute entire subtree of the event node path. Default is 'false'.", boolValue = false)
private static final String DEEP = "deep";
diff --git a/src/main/java/org/apache/sling/distribution/trigger/impl/ResourceEventDistributionTriggerFactory.java b/src/main/java/org/apache/sling/distribution/trigger/impl/ResourceEventDistributionTriggerFactory.java
index b22b324..a816242 100644
--- a/src/main/java/org/apache/sling/distribution/trigger/impl/ResourceEventDistributionTriggerFactory.java
+++ b/src/main/java/org/apache/sling/distribution/trigger/impl/ResourceEventDistributionTriggerFactory.java
@@ -40,7 +40,9 @@ import org.osgi.framework.BundleContext;
label = "Apache Sling Distribution Trigger - Resource Event Triggers Factory",
configurationFactory = true,
specVersion = "1.1",
- policy = ConfigurationPolicy.REQUIRE
+ policy = ConfigurationPolicy.REQUIRE,
+ description = "Triggers a distribution request ('ADD', 'DELETE') " +
+ "for the given path (path) whenever the resource at the given path is modified (added, resp. removed)."
)
@Service(DistributionTrigger.class)
@Property(name="webconsole.configurationFactory.nameHint", value="Trigger name: {name}")
diff --git a/src/main/java/org/apache/sling/distribution/trigger/impl/ScheduledDistributionTriggerFactory.java b/src/main/java/org/apache/sling/distribution/trigger/impl/ScheduledDistributionTriggerFactory.java
index 4079f24..3248e56 100644
--- a/src/main/java/org/apache/sling/distribution/trigger/impl/ScheduledDistributionTriggerFactory.java
+++ b/src/main/java/org/apache/sling/distribution/trigger/impl/ScheduledDistributionTriggerFactory.java
@@ -43,7 +43,9 @@ import org.osgi.framework.BundleContext;
label = "Apache Sling Distribution Trigger - Scheduled Triggers Factory",
configurationFactory = true,
specVersion = "1.1",
- policy = ConfigurationPolicy.REQUIRE
+ policy = ConfigurationPolicy.REQUIRE,
+ description = "Triggers a distribution request of the given type (action) " +
+ "for the given path (path) at a periodical time interval (seconds)."
)
@Service(DistributionTrigger.class)
@Property(name="webconsole.configurationFactory.nameHint", value="Trigger name: {name}")
@@ -56,7 +58,7 @@ public class ScheduledDistributionTriggerFactory implements DistributionTrigger
/**
* scheduled trigger action property
*/
- @Property(label = "Distribution Type", description = "The type of the distribution request produced by this trigger.")
+ @Property(label = "Distribution Type", description = "The type of the distribution request produced by this trigger in ('ADD', 'DELETE', 'PULL', 'TEST'). Default 'PULL'.")
private static final String ACTION = "action";
/**
@@ -68,7 +70,7 @@ public class ScheduledDistributionTriggerFactory implements DistributionTrigger
/**
* scheduled trigger seconds property
*/
- @Property(label = "Interval in Seconds", description = "The number of seconds between executions")
+ @Property(label = "Interval in Seconds", description = "The number of seconds between distribution requests. Default 30 seconds.")
private static final String SECONDS = "seconds";
@Property(label = "Service Name", description = "The name of the service used to trigger the distribution requests.")
--
To stop receiving notification emails like this one, please contact
['"commits@sling.apache.org" <co...@sling.apache.org>'].