Changes for page WOApplication

Last modified by Andrew Lindesay on 2011/07/17 09:52

From version 36.1
edited by Kieran Kelleher
on 2007/10/08 08:14
Change comment: There is no comment for this version
To version 42.1
edited by Gavin Eadie
on 2009/02/17 17:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.kieran
1 +XWiki.gavineadie
Content
... ... @@ -12,7 +12,7 @@
12 12  
13 13  |= Property from the wobuild.properties file |= Description |= Default
14 14  | wo.wosystemroot | Usually this is a WebObjects installation directory, like "C:pple". | NEXT//ROOT environment variable, or root directory "/". //
15 -| wo.localroot | Usually this is a "Local" directory under the directory specified by "wo.woroot". | $wo.woroot/Local
15 +| wo.wolocalroot | Usually this is a "Local" directory under the directory specified by "wo.woroot". | $wo.woroot/Local
16 16  | wo.homeroot | Usually this is a user home directory. | $user.home
17 17  
18 18  == Parameters ==
... ... @@ -25,7 +25,10 @@
25 25  | principalClass | Subclass of WOApplication to use. | Application
26 26  | customInfoPListContent | String to append to the Info.plist. | No
27 27  | stdFrameworks | If set to true, a set of standard frameworks will be associated with the deployed application (default is true). "Standard" frameworks are: JavaWebObjects, JavaWOExtensions, JavaEOAccess, JavaEOControl, JavaFoundation, JavaJDBCAdaptor, JavaXML. | No
28 +| jvm | Path to the JVM binary. Defaults to 'java' | No
28 28  | jvmOptions | String for the JVM options in the classpath. | No
30 +| jdb | Path to the JVM binary. Defaults to 'java' | No
31 +| jdbOptions | String for the jdb options in the classpath. | No
29 29  | webXML | Generate web.xml | No
30 30  | webXML//WOROOT //| Optional parameter for the web.xml | No
31 31  | webXML//LOCALROOT //| Optional parameter for the web.xml | No
... ... @@ -33,11 +33,15 @@
33 33  | webXML//WOAppMode //| Optional parameter for the web.xml | No
34 34  | webXML//WOtaglib //| Optional parameter for the web.xml | No
35 35  | webXML//CustomContent //| Optional parameter for the web.xml | No
36 -| version | Version for the Info.plist | No
39 +| cfBundleVersion | CFBundleVersion for the Info.plist. Default is no version. | No
40 +| cfBundleShortVersion | CFBundleShortVersionString for the Info.plist. Default is no version. | No
41 +| cfBundleID | CFBundleIndetifier for the Info.plist. Defaults to 'com.myapp'. | No
42 +| javaVersion | JVMVersion for the Info.plist. Used for selecting JVM compatibility. Defaults to '1.5+'. | No
37 37  | frameworksBaseURL | This denotes the directory containing the framework webserver resources bundles (MyFramework.framework, ERExtensions.framework, etc.).
38 -This is typically useful for a embedded split install whereby all webserver resource frameworks are embedded in the webserver split install application bundle. The advantage of doing this is of course is clean upgrades with current versions of framework resources being used independently of what is installed on the deployment server.
39 - The URL is relating to the webserver document root.
40 - For example: frameworksBaseURL="/WebObjects/$project.name.woa/Frameworks" | No
44 +\\ This is typically useful for a embedded split install whereby all webserver resource frameworks (all = localroot and systemroot) are embedded in the webserver split install application bundle. The advantage of doing this is of course is clean upgrades with current versions of framework resources being used independently of what is installed on the deployment server.
45 +\\Defaults to '/WebObjects/Frameworks'.
46 +\\ The URL is relative to the webserver document root.
47 +\\ For example: frameworksBaseURL="/WebObjects/$project.name.woa/Frameworks" | No
41 41  | startupScriptName | ..... | No
42 42  
43 43  == Nested Elements ==
... ... @@ -58,10 +58,24 @@
58 58  
59 59  The nested ##frameworks## is a [[FrameworkSet>>WOProject-FrameworkSet]] structure that specifies the names of the WebObjects Frameworks that this application is dependant upon. The jar files from these frameworks will be referenced in varios platform-specific depoyment files (such as CLASSPATH.TXT), and specified in the web.xml classpath if an application is deployed as a servlet. When building a FileSet, path should match up to the "**.framework" directory (no need to match individual JAR files).**
60 60  
68 +To embed frameworks set embed to true.
69 +
70 +{{note title="Nov13/08 email from Kieran Kelleher" bgColor="#FFFFCE"}}
71 +
72 +Q: _Kieran Kelleher_
73 +With regards the woapplication task and nested elements, what does the eclipse="true" attribute of the 'frameworks' nested element do?
74 + {{<frameworks dir="ProjectLocal" embed="$\{embed.ProjectLocal}" eclipse="true" />}}
75 +
76 +A: _Mike Schrag_
77 +eclipse="true" makes the <frameworks> tag parse your .classpath file to determine framework dependencies.
78 +{{/note}}
79 +
61 61  === lib ===
62 62  
63 63  The nested lib element specifies a [[FileSet>>http://jakarta.apache.org/ant/manual/CoreTypes/fileset.html]]. This should be a fileset of jar libraries required by your application. All files in this fileset will end up in the ##Resources/Java## folder of the application, and will be included on the classpath for this application.
64 64  
84 +To embed jars set embed to true.
85 +
65 65  === otherclasspath ===
66 66  
67 67  ? What does this do ?
... ... @@ -106,3 +106,16 @@
106 106  </woapplication>
107 107  
108 108  {{/noformat}}
130 +
131 +Create an application "MyApp" with embedded frameworks:
132 +
133 +{{noformat}}
134 +
135 +<woapplication name="MyApp" destDir="${dist}/WebObjects/Applications">
136 + ...
137 + <frameworks dir="../Frameworks"embed="true">
138 + <include name="**/*.framework"/>
139 + </frameworks>
140 +</woapplication>
141 +
142 +{{/noformat}}