-
Notifications
You must be signed in to change notification settings - Fork 0
/
cabio43_source_readme.txt
281 lines (187 loc) · 9.37 KB
/
cabio43_source_readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
caBIO: Source Code and Server Installation
Version 4.3
July, 2009
================================================================
Contents
================================================================
1.0 Introduction
2.0 Required Software
2.1 Java 2 Platform
2.2 Servlet Container
3.0 Install in Tomcat
3.1 Edit server.xml
3.2 Deploy the war file
4.0 Install in JBoss
4.1 Deploy configuration files
4.2 Deploy the war file
5.0 Tests
5.1 Web application
5.2 Unit tests
6.0 Building caBIO
7.0 License
================================================================
1.0 Introduction
================================================================
This document contains the instructions for installing
a local version of caBIO version 4.3 on a machine running a
Windows 2000/NT/UNIX/LINUX operating system.
================================================================
2.0 Required Software
================================================================
----------------------------------------------------------------
2.1 Java 2 Platform (required)
----------------------------------------------------------------
Java 2 Platform Enterprise Edition (J2EE) or Standard
Edition (J2SE) is required to compile and run caCORE.
J2SDK jdk1.5.0.08 or later version is required. You can
download_scripts the JDK from Sun Microsystems, Inc. at the
following locations:
http://java.sun.com/j2ee/
http://java.sun.com/j2se/
----------------------------------------------------------------
2.2 Servlet Container
----------------------------------------------------------------
This installation assumes that you have either JBoss 4.0.5.GA
or Tomcat 4.1 or later installed.
If using JBoss skip to section "4.0. Install in JBoss"
If using Tomcat proceed to the next section.
If you don't have either they can be found at:
JBOSS: http://sourceforge.net/projects/jboss/
TOMCAT: http://jakarta.apache.org/tomcat/
================================================================
3.0 Install in Tomcat
================================================================
----------------------------------------------------------------
3.1 Edit server.xml
----------------------------------------------------------------
Consult Tomcat documentation on the proper way to configure
your data sources in the server.xml file.
----------------------------------------------------------------
3.2 Deploy the war file
----------------------------------------------------------------
The cabio43.war file should be dropped into the Tomcat
webapps directory.
Restart Tomcat.
================================================================
4.0 Install in JBoss
================================================================
----------------------------------------------------------------
4.1 Deploy configuration files
----------------------------------------------------------------
The server-specific configuration files can be found under the
deploy directory in the source distribution.
1) Install data directory
Copy the provided deploy/data directory to some place
accessible by the JBoss instance, such as
$JBOSS_HOME/server/default/data
2) Configure Grid Id Handle API
Configure the data/cacore.properties file to point to the
location you installed the data directory in Step 1.
Configure the data/svr_1/config.dct file with your Oracle
database connection information.
3) Install FreestyleLM indexes
If you generated indexes for the database, place them
under data/indexes.
4) Install JDBC drivers
Copy the deploy/lib/ojdbc14.jar file into
$JBOSS_HOME/server/default/lib if you are using an
Oracle database.
5) Deploy cabio-oracle-ds.xml
Configure the deploy/conf/cabio-oracle-ds.xml file with
your Oracle database connection information, and place it
into the JBoss deploy directory.
6) Deploy properties-service.xml
Configure the deploy/conf/properties-service.xml file to
point to the data/cacore.properties file you installed
in Step 1. Deploy the properties-service.xml into
the JBoss deploy directory.
----------------------------------------------------------------
4.2 Deploy the war file
----------------------------------------------------------------
Copy the deploy/cabio43.war to the JBoss deploy directory
and restart JBoss.
================================================================
5.0 Tests
================================================================
Assuming you are running Tomcat or JBoss locally, the
following tests should work.
----------------------------------------------------------------
5.1 Web application
----------------------------------------------------------------
The following URL should display the caBIO Home Page if
everything is working correctly:
http://localhost:8080/cabio43
----------------------------------------------------------------
5.1 Unit tests
----------------------------------------------------------------
Run the unit tests by typing:
cd test
ant alltests
================================================================
6.0 Building caBIO
================================================================
To rebuild the caBIO war file, the directory structures must
be appropriately configured. The caBIO root directory must
be called "cabioapi", or configured differently in the
build.xml. The best way to achieve this is to simply rename
the source directory to cabioapi.
You will also need to have installed the caCORE SDK version
4.1 in the ../cacoresdk directory. You can obtain the
SDK zip file caCORE_SDK_411-src.zip from NCICB download_scripts site:
http://gforge.nci.nih.gov/svnroot/commonlibrary/trunk/cacore-sdk/4.1.1/
Once the SDK is in place, just run "ant build-system" from
your base caBIO installation directory.
The following arguments are optional:
-DSERVER_URL="http://yourserver/cabio43"
Configures the default server pointed to by the clients
which are built.
-DCACHE_PATH="/path/to/cache"
Configures the Hibernate EHCache path (defaults to
the JVM's temp directory).
-DINDEX_BASE="/path/to/indexes"
Configures the FreestyleLM index path.
The cabio43.war file will be saved to your output\webapp
directory. In order for the war file to work properly with
your client, use the client found in output/remote-client.
To rebuild the source package, type "ant dist-source". This
will create the source distribution under output/source.
================================================================
7.0 License
================================================================
The caBIO version 4.3 software is licensed under the terms
contained in the license located at:
http://ncicb.nci.nih.gov/download_scripts/cabiolicenseagreement.jsp
This product includes software developed by the
Apache Software Foundation (http://www.apache.org/).
-Apache SOAP, Crimson, Xerces, and Xalan are part of Apache
XML project.
-Tomcat, ORO, and Lucene are part of the Apache Jakarta project.
All aforementioned Apache projects are trademarks of
the Apache Software Foundation. For further
open source licensing issues pertaining to Apache Software
Foundation, visit:
http://www.apache.org/LICENSE
Hibernate is Free Software. The LGPL license is sufficiently
flexible to allow the use of Hibernate in both open source
and commercial projects.
http://www.gnu.org/copyleft/lesser.html
This product includes software developed by Castor
(http://www.castor.org), which is licensed under the
Exolab license:
http://www.castor.org/license.html
Sun, Sun Microsystems, Solaris, Java, JavaServer Web
Development Kit, and JavaServer Pages are trademarks or
registered trademarks of Sun Microsystems, Inc. The jaxp.jar
and jaxb-rt-1.0-ea.jar are redistributed as whole binary
jars and are subject to the Sun license terms as stated in
http://java.sun.com/xml/docs/summer02/LICENSE.html
UNIX is a registered trademark in the United States and
other countries, exclusively licensed through X/Open
Company, Ltd.
Oracle is a registered trademark of Oracle Corporation.
Windows, WindowsNT, and Win32 are registered trademarks of
Microsoft Corp.
All other product names mentioned herein and throughout the
entire caBIO project are trademarks of their respective
owners.
//end