You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by en...@apache.org on 2011/11/25 12:16:42 UTC
svn commit: r1206121 - in /incubator/stanbol/trunk/commons: jobs/README.md
jobs/api/pom.xml jobs/web/pom.xml pom.xml
Author: enridaga
Date: Fri Nov 25 11:16:40 2011
New Revision: 1206121
URL: http://svn.apache.org/viewvc?rev=1206121&view=rev
Log:
Removed version numbers from all poms in /jobs. They must inherit the version from the parent pom (STANBOL-390)
Modified:
incubator/stanbol/trunk/commons/jobs/README.md
incubator/stanbol/trunk/commons/jobs/api/pom.xml
incubator/stanbol/trunk/commons/jobs/web/pom.xml
incubator/stanbol/trunk/commons/pom.xml
Modified: incubator/stanbol/trunk/commons/jobs/README.md
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/jobs/README.md?rev=1206121&r1=1206120&r2=1206121&view=diff
==============================================================================
--- incubator/stanbol/trunk/commons/jobs/README.md (original)
+++ incubator/stanbol/trunk/commons/jobs/README.md Fri Nov 25 11:16:40 2011
@@ -26,16 +26,17 @@ and the location of the output. This ser
Job output handling is demanded to the service which created the job.
-Creating jobs
+Creating a job
------------------
+
Stanbol services can create a job accessing the `org.apache.stanbol.commons.jobs.api.JobManager` SCR component,
by providing an implementation of the `org.apache.stanbol.commons.jobs.api.Job` interface and obtaining the job identifier.
The service **must** then return an HTTP response with status `201` including the
-`Location` HTTP header pointing to the resource job (if exists). It **should** provide a human readable location of the job
+`Location` HTTP header pointing to the created job. It **should** provide a human readable location of the job
resource in the body of the response.
The job resource location can be
-derived by attaching the job identifier (retrieved by the manager) to the base /jobs resource path.
+derived by attaching the job identifier (retrieved by the manager) to the base *stanbol-base-url/*jobs/ resource path.
For example:
@@ -43,12 +44,13 @@ For example:
* Location: `http://localhost:8080/jobs/1234`
The `org.apache.stanbol.commons.jobs.web.resources.JobsResource` class in /web includes a method to create a 'test' job,
-it behaves as described above and returns a text/plain description with the job location.
+it behaves as described above and returns a text/plain description.
It can be used as a reference implementation.
Obtaining the job results
------------------
+
A request to /jobs/*jobs-identifier* will include info about the status of the job and the location of the result output.
This service supports application/json response type.
The JSON object includes the following properties:
@@ -67,3 +69,4 @@ You can create a test job by invoking:
which will create a dummy job, returning response code `201` and `Location` header pointing to the job resource.
You can then follow the `Location` to check the status of the job. When it is `finished`, you can follow the Location provided
to see the result.
+
Modified: incubator/stanbol/trunk/commons/jobs/api/pom.xml
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/jobs/api/pom.xml?rev=1206121&r1=1206120&r2=1206121&view=diff
==============================================================================
--- incubator/stanbol/trunk/commons/jobs/api/pom.xml (original)
+++ incubator/stanbol/trunk/commons/jobs/api/pom.xml Fri Nov 25 11:16:40 2011
@@ -12,7 +12,6 @@
<artifactId>org.apache.stanbol.commons.jobs.api</artifactId>
<packaging>bundle</packaging>
<name>Apache Stanbol Commons Jobs API</name>
- <version>0.1</version>
<description>Background jobs, API and Manager </description>
<build>
Modified: incubator/stanbol/trunk/commons/jobs/web/pom.xml
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/jobs/web/pom.xml?rev=1206121&r1=1206120&r2=1206121&view=diff
==============================================================================
--- incubator/stanbol/trunk/commons/jobs/web/pom.xml (original)
+++ incubator/stanbol/trunk/commons/jobs/web/pom.xml Fri Nov 25 11:16:40 2011
@@ -187,5 +187,4 @@
</repository>
</repositories>
- <version>0.1</version>
</project>
Modified: incubator/stanbol/trunk/commons/pom.xml
URL: http://svn.apache.org/viewvc/incubator/stanbol/trunk/commons/pom.xml?rev=1206121&r1=1206120&r2=1206121&view=diff
==============================================================================
--- incubator/stanbol/trunk/commons/pom.xml (original)
+++ incubator/stanbol/trunk/commons/pom.xml Fri Nov 25 11:16:40 2011
@@ -36,6 +36,7 @@
<modules>
<module>jsonld</module>
+ <module>jobs</module>
<!--
Deactivated as not releasable under Apache because of license issue. The
opennlp bundle is only added when using the 'stack' profile.