Dinesh Patil's Weblog
Dinesh Patil's Weblog
Friday February 17, 2006 |
|
GlassFish Build
GlassFish Build made Easy
Introduction: Welcome to the wonderful world of GlassFish! GlassFish is the name for the open source development project for bulding a Java EE 5 application server. It is based on the source code for Sun Java System Application Server PE 9 donated by Sun Microsystems and TopLink persistence code donated by Oracle. It is the response to Java developers who want access to the source code and the ability to contribute to the development of Sun's next generation application server which is based on GlassFish. This project is designed to encourage communication between Sun and Oracle engineers and the community and will enable all developers to participate in the application server development process. This document will focus on the glassfish project workspace and will show you how to:
To follow the GlassFish workspace, simply read the sections in order and perform the tasks which each section defines. Requirements:First of all, you need to sign up to
get java.net User
ID
from GlassFish developers community https://glassfish.dev.java.net. Glassfish
workspace is built using
Apache Maven
1.0.2. All GlassFish modules use Maven as a
build tool, which replaces gmake. Maven is
available on all platform supporting Java.
Build tools requirement to start working with GlassFish workspace:
Following OS specific requirements:
You can get the sources for the glassfish project from CVS. To get the sources from CVS, follow the instructions on the CVS page to get and setup your CVS client. Once you have done that you can check out the module: You should see output similar to: U glassfish/bootstrap/ant-common.xml To get the source for the AS9_BETA_BRANCH
Branches use one of the following
commands: Create
glassfish/bootstrap/build.properties or for re-usable
GlassFish workspace, one-time process is to create ${HOME}/build.properties
(Unix) or %HOMEPATH%\build.properties (Windows) and set
following variables: Once you have checked out glassfish/bootstrap module, do following step to checkout all modules.
Now you will have glassfish directory with a sub-directory layout similar* to this: activation appserv-http-engine CVS mail * The exact directory layout will change as modules are added or removed from the project. As long as there were no problems durring the checkout everything should be fine. Understand Your Build EnvironmentNow that you have the sources you might want to browse through the workspace to become more comfortable with the module and directory structure. The sub-directories inside of glassfish/ are each module directories (except for the CVS/ directory, which we will ignore from now on). Each module contains the same basic layout with a few exceptions, which you are about to learn. The bootstrap module is a special module which contains top level build scripts, property files to specify binary libraries and other files which are required for the the build system to function. Unless you are adding new functionality to the build system or updating a binary dependency, you can safely ignore it. This module controls the building of all other modules and is responsible for generating project release directory called ${glassfish.home} and SNAPSHOT files like glassfish-image-SNAPSHOT.jar for installable application server image.. All of the other modules follow a standard layout and usually
contain source files in the src/java
sub-directory. The build system is based on Maven which calls Ant scripts in each
module. To build complete GlassFish workspace you will have to
start build from glassfish/bootstrap module. Once you are comfortable we can start building. As a mandatory
configuration step, you need to pre-initialize the
build system and define or set some user local properties like your
java.net userid as glassfish.cvs.user and glassfish.os.name. These two
variables can be defined in a glassfish/bootstrap/build.properties
file or user's home directory ~/build.properties. This file allows you
to change how the build system
works with on different platform. If this is the first time you are
building the sources you might want to look at detailed Glassfish
Build Instructions if you run into problems. GlassFish can be build with NetBeans or using the command line
options. The article has more information on building and
developing the GlassFish project with NetBeans. Command line
options for building GlassFish are below. You need
to define 2 properties to build the workspace in
${HOME}/build.properties to do Initial
Configuration.
glassfish.os.name= The OS name, values can be WINNT, SunOS, SunOS_X86, Linux, Darwin glassfish.cvs.username=<java.net -id> Use
following command to
login to java.net CVS at least once so build checks out sources from
java.net repository. Building entire GlassFish workspace: % maven bootstrap-all checkout buildThis may take minutes or hours depending on how fast (or slow) your computer is. On an Sun LX50 x86 running solaris 9 it takes about 20 minutes. The output of the build look something like this: You may see some warnings durring the build, probably due to the
usage of deprecated methods or something, but you can safely ignore
those. If everything built with no errors you should see a BUILD
SUCCESSFUL message at the end (as shown above). Checking out a subset of the
workspace and build it: so
your workspace will look like this after the complete build. glassfish.home=${glassfish.root}/publish/glassfish maven.repo.local=${glassfish.root}/glassfish_dependencies To Configure the GlassFish Server
runtime: following step will
create the asadmin
script (CLI utility to administer application server), run
create-domain, etc which are needed to run
the GlassFish server.
% cd glassfish/bootstrap All GlassFish
server commands are located in the ${glassfish.home}/bin
directory.
For more documentation on how to administer the application server
domain and instances please refer to
the documentation
for the Sun Java System Application Server PE.
To Start the
Application Server, follow the steps below:
When the server
has started, this message appears:
Domain
domain1 is ready to receive client requests. Additional services are
being
started in the background.
To verify GlassFish server is running on your system, click
this URL: http://localhost:8080.
Refer to GlassFish Quickstart Guide for deploying and running a sample application. Quicklook tests are breadth tests with
high-level coverage of many
functions in the
Application Server. They are meant to give the developer a way
of testing major functionality in the Application Server and of running
a sanity check to ensure that nothing major is broken.
What's Next:
To run the Quicklook tests:
cd workspace (directory where you have the server code) Great! You should be proud of yourself for getting this far. As for what you will do next, only you really know that. We suggest reading over the Glassfish Build System Guide, the GlassFish FAQ to get the full view of the build system. If you are looking for other non-build system developer docs, you can probably find them in the guides section. Be sure to check out the Project Info for GlassFish on java.net as well as the Contributors Guide. If you have any ideas, suggestions to enhance on any of the above
build steps like some of the ideas listed on GlassFish
Enhancement document, just drop an email to dev@glassfish.dev.java.net. Good luck, happy coding and remember we love you! Posted by dpatil ( Feb 20 2006, 02:22:43 PM PST / Feb 17 2006, 05:00:00 PM PST ) Permalink Comments [0] Trackback: http://blogs.sun.com/dpatil/entry/glassfish_build |
| February 2006 » | ||||||
| Sun | Mon | Tue | Wed | Thu | Fri | Sat |
|---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | |||
5 | 6 | 7 | 8 | 9 | 10 | 11 |
12 | 13 | 14 | 15 | 16 | 18 | |
19 | 20 | 21 | 22 | 23 | 24 | 25 |
26 | 27 | |||||
| Today | ||||||
- Eduardo Pelegri-Llopart
- Jerome Dochez
- Ken Paulsen
- Sridatta
- The Aquarium
- blogs.sun.com
- java.com
- java.net
- opensolaris.org
Today's Page Hits: 25