annotate Changes @ 88:69c84cf7c5d7

Added javadoc to the REST package of the artifact database (complete). artifacts/trunk@840 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Fri, 26 Mar 2010 15:05:11 +0000
parents 66f43d1e69eb
children f03a309a037f
rev   line source
74
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
1 2010-01-27 RELEASE 0.4
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
2
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
3 New:
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
4
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
5 * Extended XML helper utilities a bit more
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
6 * Added a new interface describing services
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
7 via XML documents via /services
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
8
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
9
63
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
10 2009-12-17 RELEASE 0.3
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
11
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
12 New:
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
13
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
14 * Extended XML helper utilities a bit
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
15 * Added a new general proxy artifact.
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
16
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
17 FIXED:
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
18
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
19 * issue106: Konfiguration der GNV-Chart-Templates gehört nicht in das Artefakt-Framework
824dd614e647 Release 0.3
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 57
diff changeset
20
57
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
21 2009-11-13 RELEASE 0.2
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
22
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
23 New:
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
24
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
25 * Configuration documents can be made relativ to
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
26 ${artifacts.config.dir}
74
66f43d1e69eb Summarized Changes and NEWS for Release 0.4
Hans Plum <hans.plum@intevation.de>
parents: 63
diff changeset
27
57
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
28 * Splitting up configuration of artifacts in depence to the
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
29 product.
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
30
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
31 * Added a first HOWTO for setting up the environemt and the
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
32 artifact server
cf9848c85755 RELEASE 0.2: Summarized NEWS and Changes
Hans Plum <hans.plum@intevation.de>
parents: 53
diff changeset
33
53
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
34 2009-10-07 RELEASE 0.1
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
35
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
36 New:
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
37
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
38 * Two sub projects: 'artifacts' and 'artifact-database'
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
39
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
40 - 'artifacts' is a set of generic interfaces modelling
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
41 the workflow to parameterize a process and producing
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
42 outputs.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
43
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
44 An artifact is created via factories. It describes
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
45 itself via 'describe', it is parameterized via
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
46 'feed' and brought to new states with 'advance'.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
47 Once able to produce output 'out' returns the
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
48 requested product.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
49
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
50 - 'artifact-database' is the default implemention
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
51 of the workflow described with 'artifact'.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
52
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
53 * artifact-database persists artifacts with a H2-database
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
54 [http://www.h2database.com] (default) or a
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
55 PostgeSQL 8.3+ database [http://www.postgresql.org/] (optional)
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
56
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
57 * artifacts may spawn background threads to copy with long running
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
58 processes. After finishing work they are able to re-synchronize
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
59 themselves to the artifact database.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
60
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
61 * artifact-database is accessible via an HTTP REST server
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
62 implemented on top of the Restlet API http://www.restlet.org/
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
63 It has to be started as a service. Default TCP port: 8181
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
64
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
65 HTTP GET '/factories' returns list of available factories.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
66 HTTP GET '/create' creates new artifact.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
67 HTTP GET '/artifact/{uuid}' returns a description of an artifact.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
68 HTTP POST '/artifact/{uuid}' modifies an artifact ('feed', 'advance')
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
69 HTTP POST '/artifact/{uuid}/{out}' delivers output for an artifact.
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
70
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
71 * artifact-database is configured with as XML file named conf.xml
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
72 (default placement in directory $HOME/.artitactdb, directory
fecd142b6856 RELEASE 0.1
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 0
diff changeset
73 may be changed with system property "artifact.database.dir")

http://dive4elements.wald.intevation.org