Changes for page Alternative Ant Build Script for Fully Embedded and Split Install Bundles

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.gedo820
	1	+XWiki.kieran

Content

...	...	@@ -1,36 +34,3 @@
1		-{{warning}}
2		-This script can be used for WOLips 3.3.x only, the build.xml in WOLips 3.4.x and later already have the split install/embedded stuff built-in.
3		-{{/warning}}
4		-
5		-== WOLips 3.4.x, and later, Side-note ==
6		-
7		-{{warning}}
8		-If you are updating an older project, make sure you get the latest build.xml file. Create a new project, then copy/paste the contents of the fresh build.xml file into your project's build.xml file.
9		-{{/warning}}
10		-
11		-For WOLips 3.4.x and later, while embedding is built-in, it's not enabled by default. To enable embedding:
12		-
13		-* make sure you are in the WO Explorer view
14		-* right-click your project folder, select Properties, select WOLips Deployment
15		-* check the related, if not all, options under Embed Frameworks
16		-
17		-To create a versioned/dated bundle of your app and resources:
18		-
19		-* make sure you are in the Navigator view
20		-* edit build.properties, and add:
21		-* ##build.app.name=MyApp-2009-07-14##
22		-
23		-There is a known bug with WO 5.4.x (for those not using the latest Wonder release) regarding proper linking to your web server resources within the embedded frameworks. The WOFrameworksBaseURL isn't set correctly. To do this you'll need to programmatically set this within your Application constructor:
24		-
25		-* ##setFrameworksBaseURL("/WebObjects/MyApp-2009-07-14.woa/Frameworks");##
26		-
27		-Within build.properties (I may need to be corrected on this), the best approach to linking your embedded framework's web server resources automatically is to include (however the bug noted above breaks this):
28		-
29		-* ##frameworksBaseURL=/WebObjects/$build.app.name.woa/Frameworks##
30		-
31		-And finally, there is a bug in the build.xml file that you may need to clean-up:
32		-[[http://issues.objectstyle.org/jira/browse/WOL-979]]
33		-
34	34	== Introduction ==
35	35
36	36	The previous tutorial articles provide details of customization of the default ant build script that is present in your WebObjects projects. This article provides a fully custom build script that you can just drop into your project and use it as an alternative to the default build.xml. This script is called the "split//embedded//build" script. Along with providing the script, this article explains in detail what deployment artifacts are produced by the build. Hopefully the functionality in this script will make their way into the standard script someday with configuration parameters settable in a simple way in the build.properties file.
...	...	@@ -37,7 +37,7 @@
37	37
38	38	== Pre-requisites ==
39	39
40		-This [[script>>^split_embedded_build.xml]] only works with the modern WOLips project format and the WOnderApplication project template format (since the layout of regular projects is now similar to Wonder layout). However the script is easily changed to accommodate the "old" standard format by changing the dir names in the script (for example "Sources" in the new project layout was "src" in the old layout)
	7	+This script only works with the modern WOLips project format and the WOnderApplication project template format (since the layout of regular. However the script is easily changed to accommodate the "old" standard format by changing the dir names in the script (for example "Sources" in the new project layout was "src" in the old layout)
41	41
42	42	{{info title="Modern WebObjects Project Layout"}}
43	43
...	...	@@ -51,8 +51,7 @@
51	51
52	52	Have no fear ;-) , you will not break anything by dropping this script as is into your project and trying it out. You can just use it as is without replacing your default build.xml
53	53
54		-* So, download the [[script>>^split_embedded_build.xml]] by right-clicking this [[link>>^split_embedded_build.xml]] and selecing Save As... or whatever your browser uses for saving contents at a link destination.
55		-* Drag it to the root of your project.
	21	+* So, download the script and drag it to the root of your project.
56	56
57	57	* Open the Ant run configuration for the script by right-clicking on the script and selecting the menu shown below.
58	58
...	...	@@ -94,27 +94,17 @@
94	94	* Self-contained deployment bundles - all required frameworks are embedded - minimal dependency on target server configuration and versions. For example, there is no need to install Wonder frameworks on your deployment server since the ones you developed and tested with are embedded in the deployment bundles. Experience has shown that this improves consistency of deployment reliability.
95	95	* Compressed gzipped tar archives of both application and webserver bundles are created, ready for copying to target server(s)
96	96	** This is easily decompressed on the server using
97		-** $ sudo tar xvzf bundle.tar.gz
	63	+** $ sudo tar --xvzf bundle.tar.gz--
98	98
99	99	== Anatomy of Embedded Split Install Bundles produced by this Ant Script ==
100	100
101		-{{info title="The Deployment Files"}}
102		-
103		-The two compressed "ready-to-deploy" bundles are highlighted below
104		-!build_artifacts.jpg!
105		-
106		-{{/info}}
107		-
108	108	The notable aspects of the embedded build structure are shown below.
109	109
110	110	=== Application Bundle ===
111	111
112	112	{{info title="Embedded Application Bundle Layout"}}
	72	+ !app_bundle_layout.jpg!
113	113
114		-!app_bundle_layout.jpg!
115		-* Opening the app executable (command line script at bundle root having the application name as its name) and looking at the end will reveal that the WOFrameworksBaseURL references the frameworks inside the webserver embedded bundle.
116		-* Examining the Contents/MacOS/MacOSClassPath.txt file will reveal that the java classpath refers to all the jars inside the embedded bundle.
117		-
118	118	{{/info}}
119	119
120	120	The application bundle typically gets installed as follows: