You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2013/07/26 16:24:38 UTC
svn commit: r871285 - in /websites/staging/sling/trunk/content: ./
documentation/tutorials-how-tos/DropBoxEventHandler.java
documentation/tutorials-how-tos/DropBoxService.java
documentation/tutorials-how-tos/how-to-manage-events-in-sling.html
Author: buildbot
Date: Fri Jul 26 14:24:37 2013
New Revision: 871285
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxEventHandler.java
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxService.java
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jul 26 14:24:37 2013
@@ -1 +1 @@
-1506477
+1507324
Modified: websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxEventHandler.java
==============================================================================
--- websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxEventHandler.java (original)
+++ websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxEventHandler.java Fri Jul 26 14:24:37 2013
@@ -1,17 +1,17 @@
package mypackage;
-import javax.jcr.RepositoryException;
import javax.jcr.Session;
+
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Property;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
-import org.apache.sling.api.resource.ResourceUtil;
-import org.apache.sling.event.EventUtil;
-import org.apache.sling.event.JobProcessor;
-import org.apache.sling.jcr.api.SlingRepository;
-import org.apache.sling.jcr.resource.JcrResourceResolverFactory;
-import org.osgi.service.event.Event;
-import org.osgi.service.event.EventHandler;
+import org.apache.sling.api.resource.ResourceResolverFactory;
+import org.apache.sling.event.jobs.Job;
+import org.apache.sling.event.jobs.consumer.JobConsumer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -21,46 +21,36 @@ import org.slf4j.LoggerFactory;
* music (MIME type: audio/mpeg) to /dropbox/music/
* movies (MIME type: video/x-msvideo) to /dropbox/movies/
* otherwise to /dropbox/other/
- *
- * @scr.component immediate="true"
- * @scr.service interface="org.osgi.service.event.EventHandler"
- * @scr.property name="event.topics" valueRef="mypackage.DropBoxService.JOB_TOPIC"
+ *
*/
+@Component
+@Service(value=JobConsumer.class)
+@Property(name=JobConsumer.PROPERTY_TOPICS, value=DropBoxService.JOB_TOPIC)
+public class DropBoxEventHandler implements JobConsumer {
-public class DropBoxEventHandler implements JobProcessor, EventHandler {
+ /** Default logger. */
+ protected final Logger logger = LoggerFactory.getLogger(this.getClass());
- /** Default log. */
- protected final Logger log = LoggerFactory.getLogger(this.getClass());
+ @Reference
+ private ResourceResolverFactory resolverFactory;
- /** @scr.reference */
- private SlingRepository repository;
-
- /**
- * @scr.reference
- */
- private JcrResourceResolverFactory resolverFactory;
-
private final static String IMAGES_PATH = "/dropbox/images/";
private final static String MUSIC_PATH = "/dropbox/music/";
private final static String MOVIES_PATH = "/dropbox/movies/";
private final static String OTHER_PATH = "/dropbox/other/";
- public void handleEvent(Event event) {
- if (EventUtil.isLocal(event)) {
- EventUtil.processJob(event, this);
- }
- }
-
- public boolean process(Event event) {
- Session adminSession = null;
+ @Override
+ public JobResult process(final Job job) {
+ ResourceResolver adminResolver = null;
try {
- String resourcePath = (String) event.getProperty("resourcePath");
- String resourceName = resourcePath.substring(resourcePath.lastIndexOf("/") + 1);
- adminSession = repository.loginAdministrative(null);
- ResourceResolver resourceResolver = resolverFactory.getResourceResolver(adminSession);
- Resource res = resourceResolver.getResource(resourcePath);
- if (ResourceUtil.isA(res, "nt:file")) {
- String mimeType = res.getResourceMetadata().getContentType();
+ adminResolver = resolverFactory.getAdministrativeResourceResolver(null);
+
+ final String resourcePath = (String) job.getProperty("resourcePath");
+ final String resourceName = resourcePath.substring(resourcePath.lastIndexOf("/") + 1);
+
+ final Resource res = adminResolver.getResource(resourcePath);
+ if ( res.isResourceType("nt:file") ) {
+ final String mimeType = res.getResourceMetadata().getContentType();
String destDir;
if (mimeType.equals("image/png")) {
destDir = IMAGES_PATH;
@@ -74,18 +64,18 @@ public class DropBoxEventHandler impleme
else {
destDir = OTHER_PATH;
}
+ final Session adminSession = adminResolver.adaptTo(Session.class);
adminSession.move(resourcePath, destDir + resourceName);
adminSession.save();
- log.info("The file {} has been moved to {}", resourceName, destDir);
+ logger.info("The file {} has been moved to {}", resourceName, destDir);
}
- return true;
- } catch (RepositoryException e) {
- log.error("RepositoryException: " + e);
- return false;
+ return JobResult.OK;
+ } catch (final Exception e) {
+ logger.error("Exception: " + e, e);
+ return JobResult.FAILED;
} finally {
- if (adminSession != null && adminSession.isLive()) {
- adminSession.logout();
- adminSession = null;
+ if (adminResolver != null) {
+ adminResolver.close();
}
}
}
Modified: websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxService.java
==============================================================================
--- websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxService.java (original)
+++ websites/staging/sling/trunk/content/documentation/tutorials-how-tos/DropBoxService.java Fri Jul 26 14:24:37 2013
@@ -1,57 +1,53 @@
package mypackage;
-import java.util.Dictionary;
-import java.util.Hashtable;
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Property;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingConstants;
-import org.apache.sling.event.EventUtil;
-import org.apache.sling.event.JobProcessor;
+import org.apache.sling.event.jobs.JobManager;
import org.osgi.service.event.Event;
-import org.osgi.service.event.EventAdmin;
+import org.osgi.service.event.EventConstants;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The <code>DropBoxService</code> is listening content added to /tmp/dropbox by using OSGI events
- *
- * @scr.component immediate="true"
- * @scr.service interface="org.osgi.service.event.EventHandler"
- * @scr.property name="event.topics" valueRef="org.apache.sling.api.SlingConstants.TOPIC_RESOURCE_ADDED"
+ *
*/
-public class DropBoxService implements JobProcessor, EventHandler {
+@Component(immediate=true)
+@Service(value=EventHandler.class)
+@Property(name=EventConstants.EVENT_TOPIC, value=SlingConstants.TOPIC_RESOURCE_ADDED)
+public class DropBoxService implements EventHandler {
+
+ /** Default logger. */
+ protected final Logger logger = LoggerFactory.getLogger(this.getClass());
+
+ /** The job manager for starting the jobs. */
+ @Reference
+ private JobManager jobManager;
- /** Default log. */
- protected final Logger log = LoggerFactory.getLogger(this.getClass());
-
- /**
- * The OSGI event admin used for sending events
- * @scr.reference
- */
- private EventAdmin eventAdmin;
-
/** The job topic for dropbox job events. */
public static final String JOB_TOPIC = "com/sling/eventing/dropbox/job";
- public void handleEvent(Event event) {
- if (EventUtil.isLocal(event)) {
- EventUtil.processJob(event, this);
- }
- }
-
- public boolean process(Event event) {
- String propPath = (String) event.getProperty(SlingConstants.PROPERTY_PATH);
- String propResType = (String) event.getProperty(SlingConstants.PROPERTY_RESOURCE_TYPE);
- // an event is sent if a file is added to /tmp/dropbox
- if (propPath.startsWith("/tmp/dropbox") && propResType.equals("nt:file")) {
- final Dictionary<String, Object> props = new Hashtable<String, Object>();
- props.put(EventUtil.PROPERTY_JOB_TOPIC, JOB_TOPIC);
- props.put("resourcePath", propPath);
- Event dropboxJobEvent = new Event(EventUtil.TOPIC_JOB, props);
- eventAdmin.sendEvent(dropboxJobEvent);
- log.info("the dropbox job has been sent: {}", propPath);
- }
- return true;
+ @Override
+ public void handleEvent(final Event event) {
+ // get the resource event information
+ final String propPath = (String) event.getProperty(SlingConstants.PROPERTY_PATH);
+ final String propResType = (String) event.getProperty(SlingConstants.PROPERTY_RESOURCE_TYPE);
+ // a job is started if a file is added to /tmp/dropbox
+ if ( propPath.startsWith("/tmp/dropbox") && "nt:file".equals(propResType) ) {
+ // create payload
+ final Map<String, Object> payload = new HashMap<String, Object>();
+ payload.put("resourcePath", propPath);
+ // start job
+ this.jobManager.addJob(JOB_TOPIC, payload);
+ logger.info("the dropbox job has been started for: {}", propPath);
+ }
}
}
Modified: websites/staging/sling/trunk/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html (original)
+++ websites/staging/sling/trunk/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html Fri Jul 26 14:24:37 2013
@@ -18,7 +18,7 @@
limitations under the License.
-->
<head>
- <title>Apache Sling - How to Manage Events in Sling</title>
+ <title>Apache Sling - How to Manage Job in Sling</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
@@ -84,17 +84,15 @@
- <h1>How to Manage Events in Sling</h1>
- <p>Apache Sling provides some mechanisms and support for managing events.</p>
-<p>The event mechanism is leveraging the OSGi Event Admin Specification (OSGi Compendium 113). The OSGi API is very simple and lightweight. Sending an event is just generating the event object and calling the event admin. Receiving the event is implementing a single interface and declaring through properties which topics one is interested in.
-Sling makes a distinction between events and job events. Unlike events, job events are garanteed to be processed. In other words: someone has to do something with the job event (do the job). </p>
+ <h1>How to Manage Job in Sling</h1>
+ <p>Apache Sling supports the execution of jobs with the guarantee of processing the job exactly once. This can be seen as an extensions of the OSGi event admin, although jobs are usually not started or processed by OSGi events leveraging the OSGi event admin.</p>
<p>For more details please refer to the following resources:</p>
<ul>
<li><a href="/documentation/the-sling-engine/eventing-and-jobs.html">Eventing, Jobs and Scheduling section</a> to get detailed information on the eventing mechanisms in Sling.</li>
<li>Package <a href="http://www.osgi.org/javadoc/r4v42/org/osgi/service/event/package-summary.html">org.osgi.service.event</a> of the OSGI API.</li>
<li>Package <a href="/apidocs/sling6/org/apache/sling/event/package-summary.html">org.apache.sling.event</a> of the Sling API.</li>
</ul>
-<p>This page drives you through the implementation of two services that rely on the Sling eventing mechanisms. The services implement the following use case: whenever a file is uploaded to a temporary location in your web application, the file is moved to a specific location according to its MIME type.</p>
+<p>This page drives you through the implementation of two services that rely on the Sling job mechanism. The services implement the following use case: whenever a file is uploaded to a temporary location in your web application, the file is moved to a specific location according to its MIME type.</p>
<h2 id="introduction">Introduction</h2>
<p>You will now implement the logic to listen to files posted to <em>/tmp/dropbox</em> and to move them to the appropriate locations depending on the MIME type:</p>
<ul>
@@ -105,49 +103,50 @@ Sling makes a distinction between events
</ul>
<p>To do that, you will implement two services. The first one, called <strong>DropBoxService</strong>:</p>
<ul>
-<li>Listens to OSGI events.</li>
-<li>Sends a job event if a resource has been added to <strong>/tmp/dropbox</strong>.</li>
+<li>Listens to specific OSGi events (Sling resource added events)</li>
+<li>Starting a job event if a resource has been added to <strong>/tmp/dropbox</strong>.</li>
</ul>
<p>The second one, called <strong>DropBoxEventHandler</strong>:</p>
<ul>
-<li>Listens to the former job event.</li>
+<li>Processes the former jobs</li>
<li>Moves the file according to its extension.</li>
</ul>
<h2 id="listening-to-osgi-events">Listening to OSGI Events</h2>
-<p>To listen to OSGi events in Sling you just need to register an org.osgi.service.event.EventHandler service with
-an event.topics property that describes which event topics the handler is interested in.</p>
+<p>To listen to OSGi events in Sling you just need to register an <strong>org.osgi.service.event.EventHandler</strong> service with
+an <strong>event.topics</strong> property that describes which event topics the handler is interested in.</p>
<p>To listen to a Sling <strong>resource added</strong> events, for example, you'll set the <em>event.topics</em> property to
<strong>org.apache.sling.api.SlingConstants.TOPIC_RESOURCE_ADDED</strong> in the class annotations:</p>
<div class="codehilite"><pre> <span class="p">:::</span><span class="n">java</span>
- <span class="p">@</span><span class="n">Property</span><span class="p">(</span><span class="n">name</span><span class="p">=</span>"<span class="n">event</span><span class="p">.</span><span class="n">topics</span>"<span class="p">,</span>
+ <span class="p">@</span><span class="n">Property</span><span class="p">(</span><span class="n">name</span><span class="p">=</span><span class="n">org</span><span class="p">.</span><span class="n">osgi</span><span class="p">.</span><span class="n">service</span><span class="p">.</span><span class="n">event</span><span class="p">.</span><span class="n">EventConstants</span><span class="p">.</span><span class="n">EVENT_TOPIC</span><span class="p">,</span>
<span class="n">value</span><span class="p">=</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">sling</span><span class="p">.</span><span class="n">api</span><span class="p">.</span><span class="n">SlingConstants</span><span class="p">.</span><span class="n">TOPIC_RESOURCE_ADDED</span><span class="p">)</span>
</pre></div>
<p>The javadocs of the TOPIC_ constants in the <a href="/apidocs/sling6/org/apache/sling/api/SlingConstants.html">org.apache.sling.api.SlingConstants</a>
class lists and explains the available event topics available in Sling.</p>
-<h2 id="sending-job-events">Sending Job Events</h2>
-<p>To send an event the following code can be used: </p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">void</span> <span class="nf">sendEvent</span><span class="o">()</span> <span class="o">{</span>
- <span class="kd">final</span> <span class="n">Dictionary</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">></span> <span class="n">props</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Hashtable</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">>();</span>
- <span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="n">JobUtil</span><span class="o">.</span><span class="na">PROPERTY_JOB_TOPIC</span><span class="o">,</span> <span class="n">JOB_TOPIC</span><span class="o">);</span>
- <span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">,</span> <span class="n">RESOURCE_PATH</span><span class="o">);</span>
- <span class="kd">final</span> <span class="n">Event</span> <span class="n">myEvent</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Event</span><span class="o">(</span><span class="n">JobUtil</span><span class="o">.</span><span class="na">TOPIC_JOB</span><span class="o">,</span> <span class="n">props</span><span class="o">);</span>
- <span class="n">eventAdmin</span><span class="o">.</span><span class="na">sendEvent</span><span class="o">(</span><span class="n">myEvent</span><span class="o">);</span>
-<span class="o">}</span>
+<h2 id="starting-a-job">Starting a job</h2>
+<p>To start a job, the <em>JobManager</em> service can be used. It needs a job topic and a payload. In our case we define our dropbox job topic and give the resource path as the payload:</p>
+<div class="codehilite"><pre> <span class="kd">final</span> <span class="n">String</span> <span class="n">resourcePath</span> <span class="o">=</span> <span class="o">...;</span> <span class="c1">// path to the resource to handle</span>
+ <span class="kd">final</span> <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">></span> <span class="n">payload</span> <span class="o">=</span> <span class="k">new</span> <span class="n">HashMap</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">>();</span>
+ <span class="n">payload</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">,</span> <span class="n">resourcePath</span><span class="o">);</span>
+ <span class="c1">// start job</span>
+ <span class="k">this</span><span class="o">.</span><span class="na">jobManager</span><span class="o">.</span><span class="na">addJob</span><span class="o">(</span><span class="n">JOB_TOPIC</span><span class="o">,</span> <span class="n">payload</span><span class="o">);</span>
</pre></div>
-<p>However, for our example, to send a job event the service needs to implement the <strong>org.osgi.service.event.EventHandler</strong> and <strong>org.apache.sling.event.JobProcessor</strong> interfaces:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">class</span> <span class="nc">DropBoxService</span> <span class="kd">implements</span> <span class="n">JobProcessor</span><span class="o">,</span> <span class="n">EventHandler</span> <span class="o">{</span>
+<p>To receive the resource event, the service needs to implement the <strong>org.osgi.service.event.EventHandler</strong> interface and register it as an EventHandler service:</p>
+<div class="codehilite"><pre><span class="nd">@Component</span><span class="o">(</span><span class="n">immediate</span><span class="o">=</span><span class="kc">true</span><span class="o">)</span>
+<span class="nd">@Service</span><span class="o">(</span><span class="n">value</span><span class="o">=</span><span class="n">EventHandler</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">DropBoxService</span> <span class="kd">implements</span> <span class="n">EventHandler</span> <span class="o">{</span>
<span class="o">...</span>
<span class="o">}</span>
</pre></div>
-<p>To send the job event the Event Admin service needs to be referenced:</p>
+<p>As this service is an event handler, we have set the immediate flag to true on the component.</p>
+<p>To start the job we need a reference to the JobManager:</p>
<div class="codehilite"><pre><span class="nd">@Reference</span>
-<span class="kd">private</span> <span class="n">EventAdmin</span> <span class="n">eventAdmin</span><span class="o">;</span>
+<span class="kd">private</span> <span class="n">JobManager</span> <span class="n">jobManager</span><span class="o">;</span>
</pre></div>
@@ -158,88 +157,63 @@ class lists and explains the available e
<p>The <strong>org.osgi.service.event.EventHandler#handleEvent(Event event)</strong> method needs to be implemented:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="n">Event</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">EventUtil</span><span class="o">.</span><span class="na">isLocal</span><span class="o">(</span><span class="n">event</span><span class="o">))</span> <span class="o">{</span>
- <span class="n">EventUtil</span><span class="o">.</span><span class="na">processJob</span><span class="o">(</span><span class="n">event</span><span class="o">,</span> <span class="k">this</span><span class="o">);</span>
- <span class="o">}</span>
-<span class="o">}</span>
-</pre></div>
-
-
-<p>The <strong>org.apache.sling.event.JobProcessor#process(Event event)</strong> method needs to be implemented:</p>
<p>Its logic is as follows:</p>
<ul>
<li>The OSGI event is analyzed.</li>
<li>If the event is a file that has been added to <em>/tmp/dropbox</em>:<ul>
-<li>An event is created with 2 properties:<ul>
-<li>A property to set the event as a job event.</li>
+<li>An job is created with 1 property:<ul>
<li>A property for the file path.</li>
</ul>
</li>
-<li>The job event is sent to all the listeners that subscribe to the topic of the event.</li>
+<li>The job is started </li>
</ul>
</li>
</ul>
<p>For example:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">process</span><span class="o">(</span><span class="n">Event</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
-
+<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="kd">final</span> <span class="n">Event</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// get the resource event information</span>
- <span class="n">String</span> <span class="n">propPath</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">event</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">SlingConstants</span><span class="o">.</span><span class="na">PROPERTY_PATH</span><span class="o">);</span>
- <span class="n">String</span> <span class="n">propResType</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">event</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">SlingConstants</span><span class="o">.</span><span class="na">PROPERTY_RESOURCE_TYPE</span><span class="o">);</span>
-
- <span class="c1">// an event is sent if a file is added to /tmp/dropbox</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">propPath</span><span class="o">.</span><span class="na">startsWith</span><span class="o">(</span><span class="s">"/tmp/dropbox"</span><span class="o">)</span> <span class="o">&&</span> <span class="n">propResType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"nt:file"</span><span class="o">))</span> <span class="o">{</span>
-
- <span class="c1">// configure the job event</span>
- <span class="kd">final</span> <span class="n">Dictionary</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">></span> <span class="n">props</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Hashtable</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">>();</span>
- <span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="n">EventUtil</span><span class="o">.</span><span class="na">PROPERTY_JOB_TOPIC</span><span class="o">,</span> <span class="n">JOB_TOPIC</span><span class="o">);</span>
- <span class="n">props</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">,</span> <span class="n">propPath</span><span class="o">);</span>
+ <span class="kd">final</span> <span class="n">String</span> <span class="n">propPath</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">event</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">SlingConstants</span><span class="o">.</span><span class="na">PROPERTY_PATH</span><span class="o">);</span>
+ <span class="kd">final</span> <span class="n">String</span> <span class="n">propResType</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">event</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="n">SlingConstants</span><span class="o">.</span><span class="na">PROPERTY_RESOURCE_TYPE</span><span class="o">);</span>
- <span class="c1">// create the job event</span>
- <span class="n">Event</span> <span class="n">dropboxJobEvent</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Event</span><span class="o">(</span><span class="n">EventUtil</span><span class="o">.</span><span class="na">TOPIC_JOB</span><span class="o">,</span> <span class="n">props</span><span class="o">);</span>
-
- <span class="c1">// deliver the job event</span>
- <span class="n">eventAdmin</span><span class="o">.</span><span class="na">sendEvent</span><span class="o">(</span><span class="n">dropboxJobEvent</span><span class="o">);</span>
-
- <span class="n">log</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"the dropbox job has been sent: {}"</span><span class="o">,</span> <span class="n">propPath</span><span class="o">);</span>
+ <span class="c1">// a job is started if a file is added to /tmp/dropbox</span>
+ <span class="k">if</span> <span class="o">(</span> <span class="n">propPath</span><span class="o">.</span><span class="na">startsWith</span><span class="o">(</span><span class="s">"/tmp/dropbox"</span><span class="o">)</span> <span class="o">&&</span> <span class="s">"nt:file"</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="n">propResType</span><span class="o">)</span> <span class="o">)</span> <span class="o">{</span>
+ <span class="c1">// create payload</span>
+ <span class="kd">final</span> <span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">></span> <span class="n">payload</span> <span class="o">=</span> <span class="k">new</span> <span class="n">HashMap</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">Object</span><span class="o">>();</span>
+ <span class="n">payload</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">,</span> <span class="n">propPath</span><span class="o">);</span>
+ <span class="c1">// start job</span>
+ <span class="k">this</span><span class="o">.</span><span class="na">jobManager</span><span class="o">.</span><span class="na">addJob</span><span class="o">(</span><span class="n">JOB_TOPIC</span><span class="o">,</span> <span class="n">payload</span><span class="o">);</span>
+ <span class="n">logger</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"the dropbox job has been started for: {}"</span><span class="o">,</span> <span class="n">propPath</span><span class="o">);</span>
<span class="o">}</span>
-
- <span class="c1">// all set and done</span>
- <span class="k">return</span> <span class="kc">true</span><span class="o">;</span>
<span class="o">}</span>
</pre></div>
<p>The complete code for the <strong>DropBoxService</strong> service is available <a href="DropBoxService.java">here</a>.</p>
-<h2 id="listening-to-job-events">Listening to Job Events</h2>
-<p>Now that you have implemented a service that sends a job event when a file is uploaded to <strong>/tmp/dropbox</strong>, you will implement the service <strong>DropBoxEventHandler</strong> that listens to those job events and moves the files to a location according to their MIME types.</p>
-<p>To listen to the job events that have been defined before the property <strong>event.topics</strong> needs to be set to <strong>mypackage.DropBoxService.JOB_TOPIC</strong> in the class annotations:</p>
-<div class="codehilite"><pre><span class="nd">@Property</span><span class="o">(</span><span class="n">name</span><span class="o">=</span><span class="s">"event.topics"</span><span class="o">,</span>
- <span class="n">value</span><span class="o">=</span><span class="n">mypackage</span><span class="o">.</span><span class="na">DropBoxService</span><span class="o">.</span><span class="na">JOB_TOPIC</span><span class="o">)</span>
+<h2 id="consuming-job-events">Consuming Job Events</h2>
+<p>Now that you have implemented a service that starts a job when a file is uploaded to <strong>/tmp/dropbox</strong>, you will implement the service <strong>DropBoxEventHandler</strong> that processes those jobs and moves the files to a location according to their MIME types.</p>
+<p>To process to the job that have been defined before the property <strong>job.topics</strong> needs to be set to <strong>DropBoxService.JOB_TOPIC</strong> in the class annotations:</p>
+<div class="codehilite"><pre><span class="nd">@Property</span><span class="o">(</span><span class="n">name</span><span class="o">=</span><span class="s">"job.topics"</span><span class="o">,</span>
+ <span class="n">value</span><span class="o">=</span><span class="n">DropBoxService</span><span class="o">.</span><span class="na">JOB_TOPIC</span><span class="o">)</span>
</pre></div>
-<h2 id="handling-job-events">Handling Job Events</h2>
-<p>To move the files the service needs to implement the <strong>org.osgi.service.event.EventHandler</strong> and <strong>org.apache.sling.event.JobProcessor</strong> interfaces:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">class</span> <span class="nc">DropBoxEventHandler</span> <span class="kd">implements</span> <span class="n">JobProcessor</span><span class="o">,</span> <span class="n">EventHandler</span> <span class="o">{</span>
+<p>In addition the service needs to implement the <strong>org.apache.sling.event.jobs.consumer.JobConsumer</strong> interface:</p>
+<div class="codehilite"><pre><span class="kd">public</span> <span class="kd">class</span> <span class="nc">DropBoxEventHandler</span> <span class="kd">implements</span> <span class="n">JobConsume</span> <span class="o">{</span>
</pre></div>
<p>Some class fields need to be defined:</p>
<ul>
-<li>The default log.</li>
-<li>The references to the SlingRepository and the JcrResourceResolverFactory services, which are used in the implementation.</li>
+<li>The default logger.</li>
+<li>The references to the ResourceResolverFactory services, which are used in the implementation.</li>
<li>The destination paths of the files.</li>
</ul>
<p>For example:</p>
<div class="codehilite"><pre><span class="cm">/** Default log. */</span>
-<span class="kd">protected</span> <span class="kd">final</span> <span class="n">Logger</span> <span class="n">log</span> <span class="o">=</span> <span class="n">LoggerFactory</span><span class="o">.</span><span class="na">getLogger</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="na">getClass</span><span class="o">());</span>
+<span class="kd">protected</span> <span class="kd">final</span> <span class="n">Logger</span> <span class="n">logger</span> <span class="o">=</span> <span class="n">LoggerFactory</span><span class="o">.</span><span class="na">getLogger</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="na">getClass</span><span class="o">());</span>
<span class="nd">@Reference</span>
-<span class="kd">private</span> <span class="n">SlingRepository</span> <span class="n">repository</span><span class="o">;</span>
-
-<span class="nd">@Reference</span>
-<span class="kd">private</span> <span class="n">JcrResourceResolverFactory</span> <span class="n">resolverFactory</span><span class="o">;</span>
+<span class="kd">private</span> <span class="n">ResourceResolverFactory</span> <span class="n">resolverFactory</span><span class="o">;</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="kd">static</span> <span class="n">String</span> <span class="n">IMAGES_PATH</span> <span class="o">=</span> <span class="s">"/dropbox/images/"</span><span class="o">;</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="kd">static</span> <span class="n">String</span> <span class="n">MUSIC_PATH</span> <span class="o">=</span> <span class="s">"/dropbox/music/"</span><span class="o">;</span>
@@ -248,56 +222,51 @@ class lists and explains the available e
</pre></div>
-<p>The <strong>org.osgi.service.event.EventHandler#handleEvent(Event event)</strong> method needs to be implemented:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="n">Event</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">EventUtil</span><span class="o">.</span><span class="na">isLocal</span><span class="o">(</span><span class="n">event</span><span class="o">))</span> <span class="o">{</span>
- <span class="n">EventUtil</span><span class="o">.</span><span class="na">processJob</span><span class="o">(</span><span class="n">event</span><span class="o">,</span> <span class="k">this</span><span class="o">);</span>
- <span class="o">}</span>
-<span class="o">}</span>
-</pre></div>
-
-
-<p>The <strong>org.apache.sling.event.JobProcessor#process(Event event)</strong> method needs to be implemented.</p>
+<p>The <strong>org.apache.sling.event.jobs.consumer.JobConsume#process(Job job)</strong> method needs to be implemented:</p>
<p>Its logic is as follows:</p>
<ul>
-<li>The resource path is extracted from the job event property.</li>
+<li>The resource path is extracted from the job.</li>
<li>The resource is obtained from the resource path.</li>
<li>If the resource is a file, the destination path is defined based on the file MIME type.</li>
-<li>The file is moved to the new location.</li>
+<li>The file is moved to the new location by using a JCR session (as the Sling Resource API doesn't support move atm)</li>
</ul>
<p>or in Java Code:</p>
-<div class="codehilite"><pre><span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">process</span><span class="o">(</span><span class="n">Event</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
- <span class="n">Session</span> <span class="n">adminSession</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
+<div class="codehilite"><pre><span class="kd">public</span> <span class="n">JobResult</span> <span class="nf">process</span><span class="o">(</span><span class="kd">final</span> <span class="n">Job</span> <span class="n">job</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">ResourceResolver</span> <span class="n">adminResolver</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
<span class="k">try</span> <span class="o">{</span>
- <span class="n">String</span> <span class="n">resourcePath</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">event</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">);</span>
- <span class="n">String</span> <span class="n">resourceName</span> <span class="o">=</span> <span class="n">resourcePath</span><span class="o">.</span><span class="na">substring</span><span class="o">(</span><span class="n">resourcePath</span><span class="o">.</span><span class="na">lastIndexOf</span><span class="o">(</span><span class="s">"/"</span><span class="o">)</span> <span class="o">+</span> <span class="mi">1</span><span class="o">);</span>
- <span class="n">adminSession</span> <span class="o">=</span> <span class="n">repository</span><span class="o">.</span><span class="na">loginAdministrative</span><span class="o">(</span><span class="kc">null</span><span class="o">);</span>
- <span class="n">ResourceResolver</span> <span class="n">resourceResolver</span> <span class="o">=</span> <span class="n">resolverFactory</span><span class="o">.</span><span class="na">getResourceResolver</span><span class="o">(</span><span class="n">adminSession</span><span class="o">);</span>
- <span class="n">Resource</span> <span class="n">res</span> <span class="o">=</span> <span class="n">resourceResolver</span><span class="o">.</span><span class="na">getResource</span><span class="o">(</span><span class="n">resourcePath</span><span class="o">);</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">ResourceUtil</span><span class="o">.</span><span class="na">isA</span><span class="o">(</span><span class="n">res</span><span class="o">,</span> <span class="s">"nt:file"</span><span class="o">))</span> <span class="o">{</span>
- <span class="n">String</span> <span class="n">mimeType</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="na">getResourceMetadata</span><span class="o">().</span><span class="na">getContentType</span><span class="o">();</span>
+ <span class="n">adminResolver</span> <span class="o">=</span> <span class="n">resolverFactory</span><span class="o">.</span><span class="na">getAdministrativeResourceResolver</span><span class="o">(</span><span class="kc">null</span><span class="o">);</span>
+
+ <span class="kd">final</span> <span class="n">String</span> <span class="n">resourcePath</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">job</span><span class="o">.</span><span class="na">getProperty</span><span class="o">(</span><span class="s">"resourcePath"</span><span class="o">);</span>
+ <span class="kd">final</span> <span class="n">String</span> <span class="n">resourceName</span> <span class="o">=</span> <span class="n">resourcePath</span><span class="o">.</span><span class="na">substring</span><span class="o">(</span><span class="n">resourcePath</span><span class="o">.</span><span class="na">lastIndexOf</span><span class="o">(</span><span class="s">"/"</span><span class="o">)</span> <span class="o">+</span> <span class="mi">1</span><span class="o">);</span>
+
+ <span class="kd">final</span> <span class="n">Resource</span> <span class="n">res</span> <span class="o">=</span> <span class="n">adminResolver</span><span class="o">.</span><span class="na">getResource</span><span class="o">(</span><span class="n">resourcePath</span><span class="o">);</span>
+ <span class="k">if</span> <span class="o">(</span> <span class="n">res</span><span class="o">.</span><span class="na">isResourceType</span><span class="o">(</span><span class="s">"nt:file"</span><span class="o">)</span> <span class="o">)</span> <span class="o">{</span>
+ <span class="kd">final</span> <span class="n">String</span> <span class="n">mimeType</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="na">getResourceMetadata</span><span class="o">().</span><span class="na">getContentType</span><span class="o">();</span>
<span class="n">String</span> <span class="n">destDir</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(</span><span class="n">mimeType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"image/png"</span><span class="o">))</span> <span class="o">{</span>
<span class="n">destDir</span> <span class="o">=</span> <span class="n">IMAGES_PATH</span><span class="o">;</span>
- <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="n">mimeType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"audio/mpeg"</span><span class="o">))</span> <span class="o">{</span>
+ <span class="o">}</span>
+ <span class="k">else</span> <span class="nf">if</span> <span class="o">(</span><span class="n">mimeType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"audio/mpeg"</span><span class="o">))</span> <span class="o">{</span>
<span class="n">destDir</span> <span class="o">=</span> <span class="n">MUSIC_PATH</span><span class="o">;</span>
- <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="n">mimeType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"video/x-msvideo"</span><span class="o">))</span> <span class="o">{</span>
+ <span class="o">}</span>
+ <span class="k">else</span> <span class="nf">if</span> <span class="o">(</span><span class="n">mimeType</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"video/x-msvideo"</span><span class="o">))</span> <span class="o">{</span>
<span class="n">destDir</span> <span class="o">=</span> <span class="n">MOVIES_PATH</span><span class="o">;</span>
- <span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
+ <span class="o">}</span>
+ <span class="k">else</span> <span class="o">{</span>
<span class="n">destDir</span> <span class="o">=</span> <span class="n">OTHER_PATH</span><span class="o">;</span>
<span class="o">}</span>
+ <span class="kd">final</span> <span class="n">Session</span> <span class="n">adminSession</span> <span class="o">=</span> <span class="n">adminResolver</span><span class="o">.</span><span class="na">adaptTo</span><span class="o">(</span><span class="n">Session</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
<span class="n">adminSession</span><span class="o">.</span><span class="na">move</span><span class="o">(</span><span class="n">resourcePath</span><span class="o">,</span> <span class="n">destDir</span> <span class="o">+</span> <span class="n">resourceName</span><span class="o">);</span>
<span class="n">adminSession</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
- <span class="n">log</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"The file {} has been moved to {}"</span><span class="o">,</span> <span class="n">resourceName</span><span class="o">,</span> <span class="n">destDir</span><span class="o">);</span>
+ <span class="n">logger</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"The file {} has been moved to {}"</span><span class="o">,</span> <span class="n">resourceName</span><span class="o">,</span> <span class="n">destDir</span><span class="o">);</span>
<span class="o">}</span>
- <span class="k">return</span> <span class="kc">true</span><span class="o">;</span>
- <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">RepositoryException</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
- <span class="n">log</span><span class="o">.</span><span class="na">error</span><span class="o">(</span><span class="s">"RepositoryException: "</span> <span class="o">+</span> <span class="n">e</span><span class="o">);</span>
- <span class="k">return</span> <span class="kc">false</span><span class="o">;</span>
+ <span class="k">return</span> <span class="n">JobResult</span><span class="o">.</span><span class="na">OK</span><span class="o">;</span>
+ <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="kd">final</span> <span class="n">Exception</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">logger</span><span class="o">.</span><span class="na">error</span><span class="o">(</span><span class="s">"Exception: "</span> <span class="o">+</span> <span class="n">e</span><span class="o">,</span> <span class="n">e</span><span class="o">);</span>
+ <span class="k">return</span> <span class="n">JobResult</span><span class="o">.</span><span class="na">FAILED</span><span class="o">;</span>
<span class="o">}</span> <span class="k">finally</span> <span class="o">{</span>
- <span class="k">if</span> <span class="o">(</span><span class="n">adminSession</span> <span class="o">!=</span> <span class="kc">null</span> <span class="o">&&</span> <span class="n">adminSession</span><span class="o">.</span><span class="na">isLive</span><span class="o">())</span> <span class="o">{</span>
- <span class="n">adminSession</span><span class="o">.</span><span class="na">logout</span><span class="o">();</span>
- <span class="n">adminSession</span> <span class="o">=</span> <span class="kc">null</span><span class="o">;</span>
+ <span class="k">if</span> <span class="o">(</span><span class="n">adminResolver</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">adminResolver</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
@@ -306,7 +275,7 @@ class lists and explains the available e
<p>The complete code for the <strong>DropBoxEventHandler</strong> service is available <a href="DropBoxEventHandler.java">here</a>.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1478710 by bdelacretaz on Fri, 3 May 2013 10:10:36 +0000
+ Rev. 1507324 by cziegeler on Fri, 26 Jul 2013 14:24:29 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project