J2EE SDK Installation

Document Revised: 3/6/01

Note on beta 1.3: This page describes how to install version 1.2.1. In the beta 1.3 documentation bundle, a bad link in the index.html file points to this page. If you want to install the beta 1.3 version, please go to the Beta 1.3 Installation Instructions.

Before you can install the software or documentation onto your system, you must download the appropriate bundle from our web site. For instructions on downloading bundles, see the Download Bundles page. After downloading a bundle, please follow the installation instructions for your platform:

Solaris Operating Environment

• Installing the Solaris Software Bundle
• Installing the Solaris Documentation Bundle

Windows

• Installing the Windows Software Bundle
• Installing the Windows Documentation Bundle

Linux

• Installing the Linux Software Bundle
• Installing the Linux Documentation Bundle

After you've performed the installation, please read the section "Where do I go from here?"

Installing the Solaris Software Bundle

1. Change to the directory where you want to install the software.

For example, if you want to install the software under /usr/local you would type this command:

cd /usr/local

In step 2, unpacking the bundle automatically creates a subdirectory called j2sdkee1.2.1.

2. Unpack the download bundle.

The download bundle for the software is in the j2sdkee-1_2_1-solsparc.sh file. In the following commands, replace <path> with the actual path of the download bundle:

chmod a+x <path>/j2sdkee-1_2_1-solsparc.sh
<path>/j2sdkee-1_2_1-solsparc.sh

After you agree to the license, the j2sdkee1.2.1 directory is created and the software is installed into it.

The Java 2 SDK, Enterprise Edition relies on the environment variables that are set in the user configuration script. This script is in the userconfig.sh file of the bin directory of your installation.

The userconfig.sh file sets these environment variables:

• J2EE_CLASSPATH - the classpath referenced by the J2EE server. J2EE_CLASSPATH must include the location of JDBC driver classes (except for those used by the Cloudscape DBMS included in this download bundle). Each location is delimited by a colon. J2EE_CLASSPATH does not need to include the Java 2 SDK, Enterprise Edition classes (j2ee-jar); the Java 2 SDK, Standard Edition software; or the classes contained in the enterprise application.

• JAVA_HOME - the absolute path of the directory in which the Java 2 SDK, Standard Edition is installed.

Here's an example of how you might edit the userconfig.sh file:

J2EE_CLASSPATH=/opt/oracle/jdbc:/usr/local/db/driver.zip export J2EE_CLASSPATH JAVA_HOME=/usr/local/java/jdk1.2.2 export JAVA_HOME

4. Install the documentation.

If you haven't already done so, install the documentation bundle. See the next section for instructions.

5. See "Where do I go from here?"

Installing the Solaris Documentation Bundle

1. Change to the directory above the one in which you've installed the software.

For example, if you installed the software in /usr/local/j2sdkee1.2.1 you would type this command:

cd /usr/local

The download bundle for the documentation is in the j2sdkee-1_2_1-doc-solsparc.zip file. In the following command, replace <path> with the actual path of the download bundle:

unzip <path>/j2sdkee-1_2_1-doc-solsparc.zip

The j2sdkee1.2.1/doc directory is created and the documentation is installed into it.

Installing the Windows Software Bundle

1. Run the setup program.

Double-click on the icon of the j2sdkee-1_2_1-win.exe file, and then follow the instructions provided by the setup program. By default, the setup program installs the software in C:\j2sdkee1.2.1.

If you install the software after you install the documentation, you should install the software in the parent directory of the documentation.

2. Edit the user configuration script.

The Java 2 SDK, Enterprise Edition relies on the environment variables that are set in the user configuration script. This script is in the userconfig.bat file of the bin directory of your installation.

The userconfig.bat file sets these environment variables:

• J2EE_CLASSPATH - the classpath referenced by the J2EE server. J2EE_CLASSPATH must include the location of JDBC driver classes (except for those used by the Cloudscape DBMS included in this download bundle). Each location is delimited by a semicolon. J2EE_CLASSPATH does not need to include the Java 2 SDK, Enterprise Edition classes (j2ee-jar) or the Java 2 SDK Standard Edition software.

• JAVA_HOME - the directory where the Java 2 SDK Standard Edition is installed.

Here's an example of how you might edit the userconfig.bat file:

set J2EE_CLASSPATH=C:\oracle\jdbc;C:\db\driver.zip
set JAVA_HOME=C:\jdk1.2.2

3. Set the environment variables.

You can set the environment variables either by executing the bin\userconfig.bat script in your shell window or by using the Environment tab of the System Properties window. To access the System Properties window, from the Settings menu select Control Panel and from the panel select System.

4. Install the documentation.

If you haven't already done so, install the documentation bundle. See the next section for instructions.

5. See "Where do I go from here?"

Installing the Windows Documentation Bundle

1. If you downloaded the documentation as one large .exe file, then run the setup program.

Double-click on the icon of the j2sdkee-1_2_1-doc-win.exe file, and then follow the instructions provided by the setup program.

If you install the documentation after you install the software, the setup program chooses the proper directory in which to install the documentation.

2. See "Where do I go from here?"

Installing the Linux Software Bundle

1. Change to the directory where you want to install the software.

For example, if you want to install the software under /usr/local you would type this command:

cd /usr/local

In step 2, unpacking the bundle automatically creates a subdirectory called j2sdkee1.2.1.

2. Unpack the download bundle.

The download bundle for the software is in the j2sdkee-1_2_1-linux.tar.gz file. To uncompress and unpack the download bundle bundle, run this command:

tar xvzf j2sdkee-1_2_1-linux.tar.gz

After you agree to the license, the j2sdkee1.2.1 directory is created and the software is installed into it.

The Java 2 SDK, Enterprise Edition relies on the environment variables that are set in the user configuration script. This script is in the userconfig.sh file of the bin directory of your installation.

The userconfig.sh file sets these environment variables:

• J2EE_CLASSPATH - the classpath referenced by the J2EE server. J2EE_CLASSPATH must include the location of JDBC driver classes (except for those used by the Cloudscape DBMS included in this download bundle). Each location is delimited by a colon. J2EE_CLASSPATH does not need to include the Java 2 SDK, Enterprise Edition classes (j2ee-jar); the Java 2 SDK, Standard Edition software; or the classes contained in the enterprise application.

• JAVA_HOME - the absolute path of the directory in which the Java 2 SDK, Standard Edition is installed.

Here's an example of how you might edit the userconfig.sh file:

J2EE_CLASSPATH=/opt/oracle/jdbc:/usr/local/db/driver.zip export J2EE_CLASSPATH JAVA_HOME=/usr/local/java/jdk1.2.2 export JAVA_HOME

4. Install the documentation.

If you haven't already done so, install the documentation bundle. See the next section for instructions.

5. See "Where do I go from here?"

Installing the Linux Documentation Bundle

1. Change to the directory above the one in which you've installed the software.

For example, if you installed the software in /usr/local/j2sdkee1.2.1 you would type this command:

cd /usr/local

2. If you downloaded the documentation as one large .exe file, then unpack the download bundle as follows.

The download bundle for the documentation is in the j2sdkee-1_2_1-doc-linux.tar.gz file. To uncompress and unpack the bundle, run this command:

tar xvzf j2sdkee-1_2_1-doc-linux.tar.gz

The j2sdkee1.2.1/doc directory is created and the documentation is installed into it.

3. See "Where do I go from here?"

Where do I go from here?

After you've installed the documentation, you can use your browser to read the following HTML files.

• The Release Notes list software requirements, supported platforms, and current limitations. The Release Notes are in the doc/release/ReleaseNotes.html file.

• The Configuration Guide explains how to configure JDBC drivers and various J2EE properties. If you are using the Cloudscape DBMS included with the J2EE software bundle, you do not have to configure the Cloudscape JDBC drivers. The Configuration Guide is in the doc/release/ConfigGuide.html file.

• The Getting Started chapter explains how to code, deploy, and run a simple client-server application that uses an enterprise bean. The Getting Started chapter is in the doc/guides/ejb/html/Started.fm.html file.

• The main page of the J2EE SDK documentation bundle is in the doc/index.html file. We recommend that you add a bookmark to this file in your browser.

• The Code Examples appendix lists the sample enterprise beans documented and shipped with this release. The appendix is in the doc/guides/ejb/html/ZExamplesAppend.fm.html file. The source code for the examples is in the doc/guides/ejb/examples directory.

Comments? Please send us feedback at j2ee-ri-feedback@sun.com.