svn commit: r1532645 - /sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java

[cz...@apache.org]

Author: cziegeler
Date: Wed Oct 16 06:09:42 2013
New Revision: 1532645

URL: http://svn.apache.org/r1532645
Log:
SLING-3167 : Job Logging

Modified:
    sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java

Modified: sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java?rev=1532645&r1=1532644&r2=1532645&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java (original)
+++ sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/jobs/consumer/JobExecutionContext.java Wed Oct 16 06:09:42 2013
@@ -85,6 +85,12 @@ public interface JobExecutionContext {
 
     /**
      * Log a message.
+     * A job consumer can use this method during job processing to add additional information
+     * about the current state of job processing.
+     * As calling this method adds a significant overhead it should only
+     * be used to log a few statements per job processing. If a consumer wants
+     * to output detailed information about the processing it should persists it
+     * by itself and not use this method for it.
      * The message and the arguments are passed to the {@link java.text.MessageFormat}
      * class.
      * @param message A message