Project

General

Profile

Documentation » History » Version 25

chin-yeh, 10/31/2011 04:58 PM

1 1 chin-yeh
{{toc}}
2
3
h1. Documentation
4
5 20 chin-yeh
The main documentation for *DP Client*.
6
7
h2. Programming Guide
8
9 24 chin-yeh
* [[Programming Guide]] - _web services + event persistence_
10
* [[Programming Guide for Batch Program]] - _event persistence only_
11 20 chin-yeh
12
h2. Deployment Guide
13
14
* [[Deploy dp-client]]
15 22 chin-yeh
* [[Deploy dp-batch]]
16 20 chin-yeh
17
18 3 chin-yeh
h2. List of Components
19 1 chin-yeh
20 12 chin-yeh
|_.Name|_.Latest Stable Version|_.Description|
21 25 chin-yeh
|dp-stub|1.2-RELEASE|The client stub of DP web services|
22 17 chin-yeh
|dp-client|1.3.3-[version]|The client of DP web services|
23
|dp-test|1.2.4-SNAPSHOT|A demo application for *dp-client*|
24 21 chin-yeh
|dp-batch|HEAD tag| dp related batch programs|
25 16 chin-yeh
26
where *version* refer to:
27
* *SNAPSHOT* - for development environment
28
* *RELEASE* - for production environment
29 3 chin-yeh
30
The binary of the above components can be found in:
31
> http://192.168.2.13:8081/nexus/
32
33 10 chin-yeh
h2. Compile from source files
34 3 chin-yeh
35 19 chin-yeh
*Important Note:*
36
> This section is not applicable to *dp-batch* as its deployment files have to be compiled individually and only upload those which are needed.
37
38
39 8 chin-yeh
All of the projects are built and maintained using "Maven 2":http://maven.apache.org/. 
40
> Those projects can be imported into *Eclipse IDE* but the *m2 Maven* plugin is needed.
41 3 chin-yeh
42 9 chin-yeh
The *source files* are stored in:
43
> [[wiki#scm|SCM]]
44
45 3 chin-yeh
*Prerequisite:*
46
* Eclipse IDE (optional)
47
* Apache Maven 2
48
* CVS client, e.g TortoiseCVS, Eclipse IDE
49 14 chin-yeh
* Project or module name, e.g. dp-client
50 1 chin-yeh
51 14 chin-yeh
By default, all of the project is configured to include *development properties files* when packaging the binary file. To include production properties files, activate the *prod* profile.
52 1 chin-yeh
53 14 chin-yeh
*Steps:*
54
# checkout the project or module using the CVS client
55
# <code>cd</code> to the checkout folder, e.g. dp-client
56
** *Example:*
57 3 chin-yeh
<pre>
58
$ cd dp-client
59
</pre>
60
# execute the maven goal, *clean* and *package*:
61 14 chin-yeh
** compile for *development* environment:
62 3 chin-yeh
*** change the artifact version to *x.x-SNAPSHOT*
63 14 chin-yeh
<pre>
64 15 chin-yeh
$ mvn clean package
65
</pre>
66
** compile for *production* environment:
67
*** change the artifact version to *x.x-RELEASE*
68
<pre>
69
$ mvn -P prod clean package
70
</pre>
71
# if success, the binary file can be found in the *target* folder