WOFramework Task Manual

This has been transcribed by Andrew Lindesay from the old WOProject site.

Description

WOFramework is an Ant task to build WebObjects (5.1 or higher) frameworks from a set of files. It does not enforce any particular project structure and can be used to create frameworks without using the ProjectBuilder or X-Code tool.

Parameters

Attribute	Description	Required
name	Name of the framework (without `.framework` extension).	Yes
destDir	Destination directory where the framework should be created.	Yes
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/Frameworks/FrameworkName.framework/`.	No
principalClass	The value of the NSPrincipal class in the Info.plist to use.	No
customInfoPListContent	String to append to the Info.plist.	No
eoAdaptorClassName	EOAdaptorClassName. Only useful for EOAdaptor frameworks.	No
version	Version for the Info.plist	No

Nested Elements

classes

The nested classes element specifies a FileSet. All files included in this fileset will end up in the Resources/Java/*.jar file of the framework.

resources

The nested resources element specifies a FileSet. All files included in this fileset will end up in the Resources directory of the framework. For the discussion of resource localization issues follow this link.

wsresources

The nested wsresources element specifies a FileSet. All files included in this fileset will end up in the WebServerResources directory of the framework. For the discussion of resource localization issues follow this link.

lib

The nested lib element specifies a FileSet. This should be a fileset of jar libraries required by your framework. All files in this fileset will end up in the Resources/Java folder of the framework, and will be included on the classpath for this framework.

Examples

<taskdef name="woframework" classname="org.objectstyle.woproject.ant.WOFramework">
     <classpath refid="classpath"/>
</taskdef>
<woframework name="MyFramework" destDir="${dist}/Frameworks">
   <classes dir="${build}/common">
      <exclude name="*.properties"/>
   </classes>
   <classes dir="${build}/business">
       <exclude name="*.properties"/>
   </classes>
   <resources dir="src/resources">
       <include name="*.eomodeld/**"/>
       <include name="*.wo/**"/>
   </resources>
   <wsresources dir="src/frameworks/WSResources">
       <include name="Images/**"/>
   </wsresources>
   <lib dir="lib">
       <include name="**/*.jar"/>
   </lib>
</woframework>

Note that it can be useful to build a framework with only libraries - what you get is a framework that is just a wrapper around one or more existing jar files. For example this enables you to create a framework of a set of third party jar files that your other WOFrameworks and WOApplications can include.

<taskdef name="woframework" classname="org.objectstyle.woproject.ant.WOFramework">
     <classpath refid="classpath"/>
</taskdef>
<woframework name="JavaMail" destDir="${dist}/Frameworks">
   <lib dir="lib">
       <include name="activation.jar"/>
       <include name="mail.jar"/>
   </lib>
</woframework>