Date: 2005-01-19T10:32:02
Editor: EddieOneil
Wiki: Apache Beehive Wiki
Page: For Beehive Developers
URL: http://wiki.apache.org/beehive/For Beehive Developers
Update the developer instructions given the build changes from 1/18/05.
Change Log:
------------------------------------------------------------------------------
@@ -19,26 +19,26 @@
= Build Conventions =
The Beehive build is structured such that the Beehive components are peers and
have a location in which to reference shared components. Artifacts of these
shared components are defined as properties in the `/beehive.properties` file,
which can be included by any downstream Ant build file. Some of these
artifacts include references to the XMLBeans JAR, the Servlet and JSP API JARs,
and the common JUnit JAR. The motivation behind this is to minimize the number
of properties used to refer to the same resource, and when possible, these
common properties should be used in component projects.
-The structure of the Beehive source tree from $BEEHIVE_HOME/ is:
+The structure of the Beehive source tree from ${beehive.home}/ is:
{{{
- beehive.properties -- defines properties that are shared among Beehive
components
- build.xml -- top-level build targets that can be used to clean,
build, deploy, and test Beehive components
- build/ -- a transient top-level directory in which project wide
build artifacts are placed
- controls/ -- the Controls component
- external/ -- 3rd party libraries / software that is shared among
Beehive components
- installed/ -- installed 3rd party software such as Ant and Tomcat
- netui/ -- the NetUI component
- site/ -- the Beehive website
- test/ -- test infrastructure shared among Beehive components
- wsm/ -- the Web Service Metadata component.
+ ant/ -- Ant build files shared among Beehive components
+ beehive-imports.xml -- defines Ant paths, filesets, and macros that are
shared among the Beehive components
+ build.xml -- top-level build targets that can be used to clean,
build, deploy, and test Beehive components
+ build/ -- a transient top-level directory in which project wide
build artifacts are placed
+ controls/ -- the Controls component
+ external/ -- 3rd party libraries / software that is shared among
Beehive components
+ installed/ -- installed 3rd party software such as Ant and Tomcat
+ netui/ -- the NetUI component
+ site/ -- the Beehive website
+ wsm/ -- the Web Service Metadata component.
}}}
In order to track dependencies between Beehive components, it's best practice
to define resources at the top-level that are shared across components.
Otherwise, scoping resources to the components that use them makes them easier
to change, and it's always easy to promote resources up the tree but harder to
move them down. Generally, one component should never directly reference
another for files, properties, etc.
-The top-level `test/` directory contains source and Ant files that are shared
among components. This includes Ant which can be used to start / stop Tomcat
(the default Servlet container for Beehive) and to deploy / undeploy / build a
Beehive web application. The Ant files used to perform these operations are:
+The top-level `ant/` directory contains source and Ant files that are shared
among components. This includes Ant which can be used to start / stop Tomcat
(the default Servlet container for Beehive) and to deploy / undeploy / build a
Beehive web application. The Ant files used to perform these operations are:
- *
[http://cvs.apache.org/viewcvs.cgi/*checkout*/incubator/beehive/trunk/test/ant/buildWebapp.xml?root=Apache-SVN
buildWebapp.xml]
- *
[http://cvs.apache.org/viewcvs.cgi/*checkout*/incubator/beehive/trunk/test/ant/runTomcat.xml?root=Apache-SVN
runTomcat.xml]
+ *
[http://cvs.apache.org/viewcvs.cgi/*checkout*/incubator/beehive/trunk/ant/buildWebapp.xml?root=Apache-SVN
buildWebapp.xml]
+ *
[http://cvs.apache.org/viewcvs.cgi/*checkout*/incubator/beehive/trunk/ant/tomcat-importsxml?root=Apache-SVN
runTomcat.xml]
and are defined as top-level properties in the beehive.properties file so that
components need not reference the build files directly.
@@ -173,8 +173,8 @@
Then, apply the patch and run the following:
{{{
- $ ant -f $BEEHIVE_HOME/netui/ant/build-schema.xml
- $ ant -f $BEEHIVE_HOME/wsm/build-schema.xml
+ $ ant -f ${beehive.home}/netui/ant/build-schema.xml
+ $ ant -f ${beehive.home}/wsm/build-schema.xml
}}}
This will generate two jar files, `netui-schema.jar` and `wsm-schema.jar`
@@ -187,7 +187,7 @@
'''Controls Project'''
-Controls Project rooted at `$BEEHIVE_HOME/controls`
+Controls Project rooted at `${beehive.home}/controls`
Set the source and library dependencies as specified previously.
@@ -195,7 +195,7 @@
'''Netui Project'''
-Netui Project rooted at `$BEEHIVE_HOME/netui`
+Netui Project rooted at `${beehive.home}/netui`
Set the source and library dependencies as specified previously.
Additionally, make sure that you add the `netui-schema.jar` which you generated
earlier to the library path.
@@ -203,7 +203,7 @@
'''Wsm Project'''
-Wsm Project rooted at `$BEEHIVE_HOME/wsm`
+Wsm Project rooted at `${beehive.home}/wsm`
Set the source and library dependencies as specified previously.
Additionally, make sure that you add the `wsm-schema.jar` which you generated
earlier to the library path.
@@ -211,7 +211,7 @@
=== Ant Setup ===
Please add junit.jar in ANT's classpath. (NOT eclipse's classpath)
-( window -> Preferences -> Runtime under Ant tree -> add
$BEEHIVE_HOME/external/junit/junit.jar in Global Entries in the Classpath tab)
+( window -> Preferences -> Runtime under Ant tree -> add
${beehive.home}/external/junit/junit.jar in Global Entries in the Classpath tab)
== IDEA ==
Tested with IDEA 4.5.1
