Changes for page WOApplication

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

From version 25.1
edited by Ulrich Köster
on 2007/02/27 03:01
Change comment: There is no comment for this version
To version 24.1
edited by dlee
on 2007/10/10 21:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.uli
1 +XWiki.dlee
Content
... ... @@ -10,38 +10,47 @@
10 10  
11 11  WOApplication behavior depends on various properties in the wobuild.properties file that specify common locations of the frameworks used by the application. These properties can be initialized with the ant script woproperties.xml. Per default the woapplication task expects this file in $user.home/Library/wobuild.properties. If no file is found the woapplication task resolves the property WOBUILD//PROPERTIES from the java properties and the environment(in this order) to find the file.//
12 12  
13 -|=Property from the wobuild.properties file|=Description|=Default
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
16 -|wo.homeroot|Usually this is a user home directory.|$user.home
13 +|= Property from the wobuild.properties file |= Description |= Default
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
16 +| wo.homeroot | Usually this is a user home directory. | $user.home
17 17  
18 18  == Parameters ==
19 19  
20 -|=Attribute|=Description|=Required
21 -|name|Name of the application (without .woa extension).|Yes
22 -|chmod|Optional value for the chmod command executed by the WOApplication task. The default is "gu+x". The chmod command is only executed on the first build of the application and only on "Unix" platforms. The default is "750".|No
23 -|destDir|Destination directory where the application woa should be created.|Yes
24 -|wsDestDir|Destination directory where WebServerResorces should be copied during split install (presense of this parameter will trigger split install). WebServerResources will be created under [[wsDestDir]]/WebObjects/AppName.woa/Contents/.|No
25 -|principalClass|Subclass of WOApplication to use.|Application
26 -|customInfoPListContent|String to append to the Info.plist.|No
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 -|jvmOptions|String for the JVM options in the classpath.|No
29 -|webXML|Generate web.xml|No
30 -|webXML//WOROOT//|Optional parameter for the web.xml|No
31 -|webXML//LOCALROOT//|Optional parameter for the web.xml|No
32 -|webXML//WOAINSTALLROOT//|Optional parameter for the web.xml|No
33 -|webXML//WOAppMode//|Optional parameter for the web.xml|No
34 -|webXML//WOtaglib//|Optional parameter for the web.xml|No
35 -|webXML//CustomContent//|Optional parameter for the web.xml|No
36 -|version|Version for the Info.plist|No
37 -|frameworksBaseURL|.....|No
38 -|startupScriptName|.....|No
20 +|= Attribute |= Description |= Required
21 +| name | Name of the application (without .woa extension). | Yes
22 +| chmod | Optional value for the chmod command executed by the WOApplication task. The default is "gu+x". The chmod command is only executed on the first build of the application and only on "Unix" platforms. The default is "750". | No
23 +| destDir | Destination directory where the application woa should be created. | Yes
24 +| wsDestDir | Destination directory where WebServerResorces should be copied during split install (presense of this parameter will trigger split install). WebServerResources will be created under [[wsDestDir]]/WebObjects/AppName.woa/Contents/. | No
25 +| principalClass | Subclass of WOApplication to use. | Application
26 +| customInfoPListContent | String to append to the Info.plist. | No
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
29 +| 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
32 +| webXML | Generate web.xml | No
33 +| webXML//WOROOT //| Optional parameter for the web.xml | No
34 +| webXML//LOCALROOT //| Optional parameter for the web.xml | No
35 +| webXML//WOAINSTALLROOT //| Optional parameter for the web.xml | No
36 +| webXML//WOAppMode //| Optional parameter for the web.xml | No
37 +| webXML//WOtaglib //| Optional parameter for the web.xml | No
38 +| webXML//CustomContent //| Optional parameter for the web.xml | 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
43 +| frameworksBaseURL | This denotes the directory containing the framework webserver resources bundles (MyFramework.framework, ERExtensions.framework, etc.).
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 +\\ The URL is relating to the webserver document root.
46 +\\ For example: frameworksBaseURL="/WebObjects/$project.name.woa/Frameworks" | No
47 +| startupScriptName | ..... | No
39 39  
40 40  == Nested Elements ==
41 41  
42 42  === classes ===
43 43  
44 -The nested ##classes## element specifies a [[FileSet>>http://jakarta.apache.org/ant/manual/CoreTypes/fileset.html]]. All files included in this fileset will end up in the ##Contents/Resources/Java/**.jar**##** file of the application.**
53 +The nested ##classes## element specifies a [[FileSet>>http://jakarta.apache.org/ant/manual/CoreTypes/fileset.html]]. All files included in this fileset will end up in the ##Contents/Resources/Java/**.jar**##** file of the application.**
45 45  
46 46  === resources ===
47 47  
... ... @@ -59,6 +59,10 @@
59 59  
60 60  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.
61 61  
71 +=== otherclasspath ===
72 +
73 +? What does this do ?
74 +
62 62  == Examples ==
63 63  
64 64  Create an application "MyApp" with a set of standard frameworks: