Skip to Content

Changes for page Embedding WOFrameworks

Last modified by Gavin Eadie on 2011/07/29 18:09
From version 57.1
edited by Kieran Kelleher
on 2008/09/04 12:55
Change comment: There is no comment for this version
To version 58.1
edited by Philippe Rabier
on 2011/07/29 18:09
Change comment: Migrated to Confluence 4.0

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.kieran
1 +XWiki.prabier
Content
... ... @@ -1,8 +1,41 @@
1 +== WOLips 3.4.x, and later, Side-note ==
2 +
3 +{{warning}}
4 +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.
5 +{{/warning}}
6 +
7 +For WOLips 3.4.x and later, while embedding is built-in, it's not enabled by default. To enable embedding:
8 +
9 +* make sure you are in the WO Explorer view
10 +* right-click your project folder, select Properties, select WOLips Deployment
11 +* check the related, if not all, options under Embed Frameworks
12 +
13 +To create a versioned/dated bundle of your app and resources:
14 +
15 +* make sure you are in the Navigator view
16 +* edit build.properties, and add:
17 +* {{code language="none"}}build.app.name=MyApp-2009-07-14{{/code}}
18 +
19 +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:
20 +
21 +* {{code language="none"}}setFrameworksBaseURL("/WebObjects/MyApp-2009-07-14.woa/Frameworks");{{/code}}
22 +
23 +Another way to fix this bug is to set the following launch parameter:
24 +
25 +-DWOFrameworksBaseURL=/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 +* {{code language="none"}}frameworksBaseURL=/WebObjects/${build.app.name}.woa/Frameworks{{/code}}
30 +
31 +There was an old bug in the build.xml file but fixed if you have WOLips more recent than october 2010:
32 + [[http:~~/~~/issues.objectstyle.org/jira/browse/WOL-979>>url:http://issues.objectstyle.org/jira/browse/WOL-979||shape="rect"]]
33 +
1 1  == Introduction ==
2 2  
3 -Below is outlined "simple embedding" concepts, however __full embedding__ **and** __split-installing__ are really recommended. This provides fully versioned self-contained bundles of both the application deployment bundle and the webserver deployment bundle. Read the docs on that technique for more **advantages**. This technique fully explained along with a ready-to-use ant build script is available at:
36 +Below is outlined "simple embedding" concepts, however (% style="text-decoration: underline;" %)full embedding(%%) **and** (% style="text-decoration: underline;" %)split-installing(%%) are really recommended. This provides fully versioned self-contained bundles of both the application deployment bundle and the webserver deployment bundle. Read the docs on that technique for more **advantages**. This technique fully explained along with a ready-to-use ant build script is available at:
4 4  
5 -[[Alternative Ant Build Script for Fully Embedded and Split Install Bundles]]
38 +[[doc:Alternative Ant Build Script for Fully Embedded and Split Install Bundles]]
6 6  
7 7  == Simple Approach ==
8 8  
... ... @@ -54,17 +54,31 @@
54 54  
55 55  The various dirs referenced in the build.xml from which you can select the embed option are:
56 56  
57 -|= dir name |= Description
58 -| wo.wolocalroot | /Library/Frameworks/
59 -\\Embedding these is most useful especially if you the codebase for these, like WOnder frameworks or your own, is frequently updated
60 -| user.home | /Library/Frameworks/
61 -| wo.systemroot | /System/Library/Frameworks/
62 -\\This is where Apple's WebObjects frameworks are installed and if your WebObjects version is consistent between your deployment and development platforms, then embedding these is not of much benefit.
90 +|=(((
91 +dir name
92 +)))|=(((
93 +Description
94 +)))
95 +|(((
96 +wo.wolocalroot
97 +)))|(((
98 +/Library/Frameworks/
99 +Embedding these is most useful especially if you the codebase for these, like WOnder frameworks or your own, is frequently updated
100 +)))
101 +|(((
102 +user.home
103 +)))|(((
104 +~~/Library/Frameworks/
105 +)))
106 +|(((
107 +wo.systemroot
108 +)))|(((
109 +/System/Library/Frameworks/
110 +This is where Apple's WebObjects frameworks are installed and if your WebObjects version is consistent between your deployment and development platforms, then embedding these is not of much benefit.
111 +)))
63 63  
64 64  {{note title="Remember to..." bgColor="#FFFFCE"}}
65 -
66 -If you are working with framework source in your Eclipse workspace (which you should be\!), then it is critical that you build and install all frameworks before building the deployment bundles to ensure that the embedded frameworks are the same as the source you have been developing and testing with. See next subsection for one approcah to automating this.
67 -
114 +If you are working with framework source in your Eclipse workspace (which you should be!), then it is critical that you build and install all frameworks before building the deployment bundles to ensure that the embedded frameworks are the same as the source you have been developing and testing with. See next subsection for one approcah to automating this.
68 68  {{/note}}
69 69  
70 70  === Pre-installing Workspace Frameworks Before Embedded Build ===
... ... @@ -73,7 +73,7 @@
73 73  
74 74  {{code}}
75 75  
76 - <!-- Install my own dependent frameworks in final local install location before embedding -->
123 +<!-- Install my own dependent frameworks in final local install location before embedding -->
77 77   <target name="installMyFrameworks">
78 78   <ant dir="../WKDemography" target="install" inheritall="false" />
79 79   <ant dir="../WKEmailData" target="install" inheritall="false" />
... ... @@ -91,7 +91,7 @@
91 91  
92 92  {{code}}
93 93  
94 - <target name="build.woapp" depends="installMyFrameworks">
141 +<target name="build.woapp" depends="installMyFrameworks">
95 95  
96 96  {{/code}}
97 97  
... ... @@ -101,7 +101,7 @@
101 101  
102 102  ----
103 103  
104 -See also [[FrameworkSet>>WOProject-FrameworkSet]] documentation.
151 +See also [[FrameworkSet>>doc:WOProject-FrameworkSet]] documentation.
105 105  
106 106  Example for embedding WOFrameworks.
107 107  
... ... @@ -109,10 +109,10 @@
109 109  
110 110  Assume two projects: One named Foo( a framework) and the other named Uli (an application). The parent folder has another folder named packandgo.
111 111  
112 -[[image:Folders.png]]
159 +[[image:attach:Folders.png]]
113 113  
114 -The [[^packageandgobuild.xml]] from the application. Two minor changes to the default build.xml:
115 -1 application target
161 +The [[attach:packageandgobuild.xml]]from the application. Two minor changes to the default build.xml:
162 + 1 application target
116 116  
117 117  {{code}}
118 118  
... ... @@ -134,8 +134,8 @@
134 134  
135 135  {{/code}}
136 136  
137 -The [[^build.xml]] from the packageandgo folder:
184 +The [[attach:build.xml]]from the packageandgo folder:
138 138  
139 139  Just invoke ant in the packageandgo folder and grap the App from the applications folder within the packageandgo folder.
140 140  
141 -[[image:FoldersAfterBuild.png]]
188 +[[image:attach:FoldersAfterBuild.png]]