Changes for page WOApplication

Summary

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

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.paulh
	1	+XWiki.apl

Content

...	...	@@ -10,144 +10,36 @@
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.wolocalroot | 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}}{{/wo.woroot}}/Local
	16	+|wo.homeroot|Usually this is a user home directory.|${{user.home}}{{/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		-| 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		-\\Defaults to '/WebObjects/Frameworks'.
46		-\\The URL is relative to the webserver document root.
47		-\\For example: frameworksBaseURL="/WebObjects/$project.name.woa/Frameworks" | No
48		-| 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	+|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
49	49
50	50	== Nested Elements ==
51	51
52	52	=== classes ===
53	53
54		-The nested ##classes## element specifies a [[FileSet>>http://ant.apache.org/manual/Types/fileset.html]]. All files included in this fileset will end up in the ##Contents/Resources/Java/**.jar**##** file of the application.**
	41	+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.**
55	55
56	56	=== resources ===
57	57
58		-The nested ##resources## element specifies a [[FileSet>>http://ant.apache.org/manual/Types/fileset.html]]. All files included in this fileset will end up in the ##Contents/Resources## directory of the application. For the discussion of resource localization issues follow [[this link>>WOProject-Localization]].
59		-
60		-=== wsresources ===
61		-
62		-The nested ##wsresources## element specifies a [[FileSet>>http://ant.apache.org/manual/Types/fileset.html]]. All files included in this fileset will end up in the ##Contents/WebServerResources## directory of the application. For the discussion of resource localization issues follow [[this link>>WOProject-Localization]].
63		-
64		-=== frameworks ===
65		-
66		-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).**
67		-
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		-
80		-=== lib ===
81		-
82		-The nested lib element specifies a [[FileSet>>http://ant.apache.org/manual/Types/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.
83		-
84		-To embed jars set embed to true.
85		-
86		-=== otherclasspath ===
87		-
88		-This nested element is used to add an arbitrary directory or file path to the runtime classpath. For example on Mac OS X, the directory at APPROOT/Resources/SSLKeyStore/ can be added to the runtime classpath by doing something like this:
89		-
90		-{{code}}
91		-
92		-<woapplication>
93		- [...]
94		- <otherclasspath dir="." embed="true">
95		- <include name="Resources/SSLKeyStore" />
96		- </otherclasspath>
97		-</woapplication>
98		-
99		-{{/code}}
100		-
101		-== Examples ==
102		-
103		-Create an application "MyApp" with a set of standard frameworks:
104		-
105		-{{noformat}}
106		-
107		-<taskdef name="woapplication" classname="org.objectstyle.woproject.ant.WOApplication">
108		- <classpath refid="classpath"/>
109		-</taskdef>
110		-
111		-<woapplication name="MyApp" destDir="${dist}/WebObjects/Applications">
112		- <classes dir="${build}/common">
113		- <exclude name="*.properties"/>
114		- </classes>
115		- <classes dir="${build}/business">
116		- <exclude name="*.properties"/>
117		- </classes>
118		- <resources dir="src/resources">
119		- <include name="*.eomodeld/**"/>
120		- <include name="*.wo/**"/>
121		- </resources>
122		- <wsresources dir="src/frameworks/WSResources">
123		- <include name="Images/**"/>
124		- </wsresources>
125		-</woapplication>
126		-
127		-{{/noformat}}
128		-
129		-Create an application "MyApp" with no implicit standard frameworks and a set of custom frameworks located under HOMEROOT (defined from the value of ##wo.homeroot## property):
130		-
131		-{{noformat}}
132		-
133		-<woapplication name="MyApp" stdFrameworks="false" destDir="${dist}/WebObjects/Applications">
134		- ...
135		- <frameworks dir="../Frameworks">
136		- <include name="**/*.framework"/>
137		- </frameworks>
138		-</woapplication>
139		-
140		-{{/noformat}}
141		-
142		-Create an application "MyApp" with embedded frameworks:
143		-
144		-{{noformat}}
145		-
146		-<woapplication name="MyApp" destDir="${dist}/WebObjects/Applications">
147		- ...
148		- <frameworks dir="../Frameworks"embed="true">
149		- <include name="**/*.framework"/>
150		- </frameworks>
151		-</woapplication>
152		-
153		-{{/noformat}}
	45	+The nested ##resources## 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## directory of the application. For the discussion of resource localization issues follow this link.