Project

General

Profile

Documentation » History » Version 20

chin-yeh, 09/23/2011 09:55 AM

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