Sun Java Enterprise System 5 Installation Guide for UNIX

Chapter 1 Preparing for Installation

This chapter provides information that will help you install the Sun JavaTM Enterprise System (Java ES) software. Before starting the tasks documented in this guide, you should have already planned your installation according to the Sun Java Enterprise System 5 Installation Planning Guide. You should also be familiar with the reference material associated with Java ES installation in the Sun Java Enterprise System 5 Installation Reference for UNIX.

This chapter contains the following sections:

How the Java ES Installer Works

Sun Java Enterprise System (Java ES) integrates a number of Sun server-side products to support distributed enterprise applications. In this document, these products are referred to as the Java ES product components. A collection of supporting software, called the shared components, is also included. The Java ES installer installs the Java ES product components and shared components in various combinations, one host at a time. Because of the complex interrelationships of the components, installation requires more preinstallation and postinstallation effort than is required to install a single product component.

The Java ES installer adds component packages (Solaris OS), RPMs (Linux), or Depots (HP-UX) on the local host. To uninstall a product component, an uninstallation utility with an unconfiguration interface is provided. During the course of operation, log records are generated and saved into files.

This section contains the following subsections:

Java ES Installation Utilities

The installation utility (installer) is located in the platform directory where you are installing Java ES, for example, /jes5install/Solaris_sparc. You will see a Product directory, a text file called release_info, and the executable installer script. This is the location for invoking the installer unless your installer has been patched.

There is another directory that contains a packaged version of the installer that is used for patching. The patch installation script (install) is located in the following directory along with the Log Viewer utility (viewlog):

If there is a bug in the installer, Sun can fix the installer and create a patch for the installer package. After the patch is applied, the packaged version of the installer should thereafter be used for the release, thus launching the version of the installer that contains the fixes from the patch.

Note –

You only use the patch utility if your deployment is using a patched version of the Java ES installer.

After installation, the Java ES uninstallation utility (uninstall) is located here:

Syntax and examples for the Java ES installation utilities are contained in Appendix B, Installation Commands.

Java ES Components Used in This Release

The Java ES software consists of a collection of Sun server-side products and their supporting shared components that work together to support distributed applications across a network. The Java ES 5 release presents the following selectable components, many of which have selectable subcomponents.

Any alternate or abbreviated names used in this guide are in parentheses following the component name and version.

Note –

HP-UX does not support Sun Cluster components, Directory Preparation Tool, HADB, or third-party web containers. Linux does not support Sun Cluster components, and only supports the BEA WebLogic third-party container for Configure Now.

Note –

The Directory Preparation Tool is only used with Communications products, and is included with Directory Server in the Java ES release as a convenience. Information on the Directory Preparation Tool can be found in Chapter 8, Directory Preparation Tool (, in Sun Java Communications Suite 5 Installation Guide.

To see the full list of services and subcomponents as displayed in the Java ES installer, refer to Appendix A, Java ES Components for This Release. This appendix also lists the shared components that are provided with this release.

Available Installer Modes

The Java ES installer is an installation framework that uses the Solaris pkgadd, Linux rpm, or HP-UX swinstall utility to transfer Java ES software to your system. You can install Java ES interactively or by means of a reusable script.

Tip –

You can run the Java ES installer without installing software. This is useful for surveying existing Java ES software on your hosts.

How Language Selection Works

The interactive Java ES installer runs in the language specified by the operating system locale setting on the host. The following languages are available:

If your operating system language is not listed, the installer runs in English. The installer automatically installs English versions of all Java ES components. By default, multilingual packages are selected when components are selected for installation.

The installer cannot install additional language packages for previously-installed components. However, you can use the pkgadd, rpm, or swinstall utilities to install localization packages at any time. Language packages are list in Chapter 5, List of Installable Packages, in Sun Java Enterprise System 5 Installation Reference for UNIX.

How the Installer Checks for Preexisting Components

During installation, the Java ES installer surveys the software that is already installed on the host where you are installing and identifies the following:

How the Installer Checks Component Dependencies

Many product components depend on the presence of other components to provide their core functions. The installer does extensive cross checking of product components to verify that the components you select during installation will function properly together. For this reason, the installer might prompt you to include certain product components as you make your selections.

In general, the installer uses the following rules for handling dependencies among the Java ES product components:

How the Installer Checks for System Readiness

After the components you have selected are found to be acceptable for installation and you have indicated their target installation directories, the Java ES installer performs a system check to determine if your host meets the requirements for the components you selected.

The installer checks for disk space, memory, swap space, operating system, patches and operating system resources based on the selected components and the installation directories provided. The following messages inform you about the state of your host:

How the Installer Handles Configuration and Parameter Setting

Many Java ES product components are eligible for some degree of installation-time configuration. The extent of installation-time configuration you are required to perform depends on which product components you select and which installation type you choose.

Note –

The following components cannot be configured by the Java ES installer, and, therefore, must the configured after installation: Directory Proxy Server, Java DB, Monitoring Console, Service Registry, and Sun Cluster components.

The following configuration types are available in the installer:

It is important to keep track of the configuration information values as you proceed through installation-time configuration or postinstallation configuration. Many of the product components rely on the specifics of other component configuration parameters in order to function correctly. At the end of a Configure Now installation, you can view the configuration parameters that were specified by examining the Installation Summary.

Common server settings are parameters that affect multiple product. For example, most product components require that you specify an administrative ID and password. By setting the these common values, you are setting default administrative IDs and passwords for the product components you are installing.

Product component configuration settings are parameters that apply to a particular product component. These settings are requested during installation only if you have selected the Configure Now type. Some of these settings are populated from the common server settings.

How Upgrading Works

The Java ES installer automatically upgrades shared components for the selected product components to match the level required for the release of Java ES. If you want to upgrade shared components manually, you must exit the installer, upgrade the shared component, then return to the installer. Shared components can also be installed or upgraded in a dedicated installation session that installs only shared components, enabling them to be synchronized to the current release. If you choose to install the Shared Components item, all required shared components for the Java ES release are installed or upgraded.

Note –

If the installer is run in a non-global Solaris zone with a sparse root file system, the Shared Component item is not available for selection.

On Solaris OS, some product components are already installed with the operating system. In this case, you can upgrade these product components using the Java ES installer. In a graphical installation session, if upgradable product components are detected on your host, the Status column of the Choose Software Components page indicates Upgradable. For the text-based installer, a separate list displays the upgradable product components. The components that can be upgraded by the installer are listed in the following table, along with explanation on any Solaris zones issues that might apply.

Table 1–1 Upgrade Support Within the Java ES Installer


Situation Where the Java ES Installer Can Upgrade 

Solaris Zones Issues 

Application Server 

Application Server 7.0 bundled with Solaris 9 

Application Server 8.0 bundled with Solaris 10 

Application Server 8.1.0 installed with Java ES 3 (2005Q1) 

Application Server 8.1.2 installed with Java ES 4 (2005Q4) 

Before Application Server can be installed into a non-global sparse-root zone, the bundled version must be removed from the global zone. 

Upgrading Application Server in the global zone will replace the existing version in the global zone and any versions in whole root or sparse root zones. 


HADB installed with Java ES 2005Q1 (release 3) 

HADB installed with Java ES 2005Q4 (release 4) 


Message Queue 

Message Queue bundled with Solaris 9 

Message Queue bundled with Solaris 10 

Message Queue installed with Java ES 3 (2005Q1) 

Message Queue installed with Java ES 4 (2005Q4) 

Message Queue can only be installed in the global zone, or in a whole root non-global zone. 

From the global zone, Message Queue always propagates to non-global zones. 

If the installer identifies incompatible versions of product components that cannot be upgraded by the installer, you will receive messages saying that certain product components must be removed or manually upgraded before you can continue with installation. Such upgrading is fully documented in the Sun Java Enterprise System 5 Upgrade Guide for UNIX.

How Logging Works

During the course of installation or uninstallation, log records are generated for the operations that occur. These records are saved into a single file in a format called Unified Logging Format (ULF). The Java ES installer Log Viewer utility (viewlog) provides a user-friendly interface for examining these log records. After Java ES installation is complete, the Log Viewer is located here:

After uninstallation, the viewlog utility is removed. The ULF logs themselves are not removed, and are located here:

For instructions on using the Java ES logs and Log Viewer, refer to Examining Installation Log Files.

How Java ES Reporter Works

Java ES Reporter is a command-line utility that performs anonymous product registration after a successful interactive Java ES installation session. Immediately after the Java ES components are installed, the Reporter installation starts. On the command line, you are prompted to enter the URL or IP address of a proxy that Reporter will use to access Sun through the internet. The installation proceeds silently and no further action is required.

If you do not want to install Reporter, you can specify the -noreporter option to the installer command when you start the Java ES installation session. To install only Reporter (after using the –noreporter option, or after a silent Java ES installation), there is another option available (-reporter) on UNIX platforms. The Reporter options for the Java ES installer are explained in installer or install Command.

After Reporter is installed, you can enable or disable Reporter by editing a configuration file. These instructions are contained in Java ES Reporter Postinstallation Configuration.

Because Reporter is not a Java ES component of the installer, it cannot be uninstalled using the Java ES uninstaller. Instructions for uninstalling Reporter are contained in Uninstalling Java ES Reporter.

How Uninstalling Works

Java ES provides an uninstallation utility (uninstall) for removing component products that were installed on the local host using the Java ES installer. The Java ES uninstaller checks product dependencies for the host on which it is running, issuing warnings when it discovers a dependency. For some product components, certain files remain after uninstallation and might need to be removed manually. For uninstallation specifics on each product component, refer to Reviewing Uninstallation Behavior for Java ES Product Components.

The uninstaller can be run in graphical, text-based, or silent mode. After Java ES installation is complete, the uninstaller is located here:

After uninstallation, the uninstall utility is removed from the host. For instructions on using the uninstaller, refer to Chapter 8, Uninstalling.

Shared components cannot be removed using the Java ES uninstaller. Shared components are upgraded by the Java ES installer when you install a later version of Java ES. Some shared component can be manually upgraded using procedures in the Sun Java Enterprise System 5 Upgrade Guide for UNIX. Instructions for uninstalling Java ES Reporter are contained in Uninstalling Java ES Reporter.

An installed version of Sun Cluster software cannot be removed using the Java ES uninstaller. For information on uninstalling Sun Cluster software, refer to Uninstalling Sun Cluster Software and Sun Cluster Software and Sun Cluster Geographic Edition Uninstallation Behavior.

Surveying Existing Hosts

Before installation, it is important to know what resides on the hosts where you plan to install the Java ES software. If you have ordered a new Solaris system with Java ES software preloaded, you do not need to survey your host. However, if your existing hosts have versions of Java ES components already installed, you might need to upgrade or remove some software before running the Java ES installer for the new Java ES release.

This section contains the following subsections:

When Java ES Software Is Preloaded on Solaris OS

If you ordered a Sun Solaris hardware system with preloaded software, the installation image for the Java ES software has already been copied to your system. If Java ES software is preloaded on a host, the following directory exists:


The architecture variable indicates the system’s hardware architecture, such as, SPARC or x86.

You will need to expand the installation image and use the Java ES installer to install and configure the preloaded Java ES software as described in this manual. Some Java ES components are bundled with the Solaris OS and will be present on the host. In this case, the installer presents an option of upgrading these components. For more information, refer to How Upgrading Works.

Note –

If your preloaded Java ES software is on a Solaris 10 system, refer to Solaris 10 Zones Examples before expanding the installation image.

When Incompatible Components Are Installed

During installation, the installer verifies that any Java ES components that are already installed on the host are compatible with the release of Java ES you are installing. If some components are not compatible, your installation is likely to be interrupted by incompatibility error messages. Therefore, it is best to survey installed software and do any upgrading before actually installing the Java ES software.

When you run the installer, you can see which incompatible components are on your host. If you want to install Application Server, Message Queue, or HADB, you can let the installer upgrade these components. For other product components, you cannot use the installer to upgrade, but instead must remove or upgrade the incompatible components by following instructions in the Sun Java Enterprise System 5 Upgrade Guide for UNIX.

The Java ES installer upgrades or installs any shared components that are required for the product components you are installing.

You can use Solaris commands such as prodreg and pkginfo, the Linux rpm command, or the HP-UX swlist command to examine installed software. The following table lists the basic package command equivalencies for the UNIX platforms.

Table 1–2 UNIX Package Command Equivalencies





Show installed package 


rpm –qa


Install package 


rpm -i


Remove package 


rpm –e


You can also use the installer itself to examine package-based software installations as described in the procedures in this section.

Note –

Do not rely only on the Java ES installer for information about installed software. You must also perform an independent survey of the host to determine what software is currently installed.

ProcedureTo Provide Access to Your Local Display for the Graphical Installer

  1. Set your DISPLAY environment variable.

    If you are logging in to a remote host, make sure your DISPLAY environment variable is properly set to the local display. If the DISPLAY variable is not set properly, the installer runs in text-based mode.

    • Example for C Shell (host name myhost):

      setenv DISPLAY myhost:0.0
    • Example for Korn Shell (host name myhost):

  2. Grant display authorization.

    You might need to grant display authorization to run the installer on your local display. For example, you can use the following command to grant display authority from myhost to the root user on serverhost:

    myhost\> xauth extract - myhost:0.0|rsh -l root serverhost xauth merge -

    For full instructions on granting such authorization safely, refer to the “Manipulating Access to the Server” chapter in the Solaris X Window System Developer's Guide.

ProcedureTo Use the Installer for Identifying Upgrade Issues

  1. Start the installer using the -no option to indicate that no software is to be installed.

    For the graphical installer:

    ./installer -no

    For the text-based installer:

    ./installer -nodisplay -no
  2. Proceed to component selection.

  3. Select the product components you are planning to install on this host.

    The Status column indicates products that are required for the product components you have selected and what components are upgradable.

  4. If an incompatible version of a selectable product component is detected by the installer, you are prompted to upgrade or remove the incompatible version.

    In the case of Solaris bundled Application Server, Message Queue, and HADB, you can have the installer do the upgrading. For further information, refer to How Upgrading Works.

    After resolving the problem, you can refresh the selection list, make your selection, and then ask the installer to proceed.

  5. If an incompatible version of a shared component is detected by the installer, the Shared Component Upgrades Required list is displayed.

    For each shared component listed, review the Installed Version against the Required Version to determine if any upgrading will need to be done. You must determine whether the newer Java ES version of a shared component is compatible with other applications on the host that use that shared component.

  6. If necessary, exit the installer and do any upgrading necessary.

  7. Repeat the procedure for each host.

    Note –

    The installer detects the Directory Server version that is distributed with the Solaris OS and warns you that the Directory Server script belonging to the Solaris distribution will be renamed by the installer. No action is required.

Determining If Your Hosts Are Ready

Before you start the installer, review the issues that determine system readiness:

Access Privileges

To install Java ES software, you must be logged in as root, or become superuser.

Memory, Disk Space, and Swap Space Requirements

The installer runs a check to determine if your host has sufficient memory, disk space, and swap space for the components you selected.

Note –

On Solaris 10, memory check is not performed if you are installing into a non-global zone.

System Requirements

Before you install Java ES, ensure that the hosts in your deployment meet the minimum hardware and operating system requirements. For the latest information on the supported platforms and software and hardware requirements, refer to “Hardware and Software Requirements” in the Sun Java Enterprise System 5 Release Notes for UNIX. If the operating system found on the host does not satisfy Java ES requirements, the installer cannot proceed. You must resolve this problem before installation.

As a convenience, recommended Java ES patch clusters are provided for the Solaris OS on the Sunsolve site: A Java ES patch cluster contains all the Solaris patches required for the particular release of Java ES. These patch clusters might contain Solaris kernel patches, so be sure to read the patch cluster Readme file carefully, and especially any Readme files for kernel patches. A patch cluster must be installed in single-user mode, and the host must be rebooted after installation.

Tip –

If you apply the patch cluster for your platform before running the Java ES installer, you can avoid delays when the installer performs the system check on your host and finds patches missing. However, if you are running a recent version of Solaris OS, you might prefer to run the Java ES installer first and only update those patches that the installer identifies as missing.

Patch Requirements

During installation, the Java ES installer identities any missing software patches and asks you to install these patches on the host. You must install most missing patches before proceeding with installation. However, in some cases, you are allowed to proceed without installing a missing patch. In this case, if you choose to proceed, you are warned that installation might fail or software might malfunction. To continue with installation, you must confirm that you want to proceed without installing the missing patches.

For information on patches required for this release of Java ES, refer to the Sun Java Enterprise System 5 Release Notes for UNIX.

ProcedureTo Install a Patch

The following example procedure provides instructions for installing a Solaris OS patch.

  1. Go to the Sunsolve site:

    (Location for HP-UX patches:; Location for Linux patches:

  2. Click Patches and Updates.

  3. Enter the patch number in the PatchFinder text box, and click Find Patch.

  4. Download the zip file for the patch.

  5. Expand the zip file. For example: unzip

    A directory is created for the patch files.

  6. Apply the patch. For example: patchadd 117885-44

  7. Back in the Java ES installer, click Check Again. All system requirements are rechecked.

Determining If You Can Use an Installation Sequence Example

The order in which you install the Java ES product components on the hosts of your system is crucial to installation success. You might be able to use one or more of the sequence examples provided in Chapter 2, Example Installation Sequences to guide you. These sequences include the high-level tasks that are required for some typical Java ES installations.

Full instructions for planning your installation are contained in the Sun Java Enterprise System 5 Installation Planning Guide.

Verifying Installation Prerequisites

The following table lists the tasks that you should perform before beginning any type of installation. The left column lists the order in which you should perform the tasks, and the right column contains the location of instructions and other useful information. Not all tasks are required for all installations.

Note –

HP-UX does not support Sun Cluster components, Directory Preparation Tool, HADB, or third-party web containers. Linux does not support Sun Cluster components, and only supports BEA WebLogic as a third party container for Configure Now.

Table 1–3 Preinstallation Checklist


Instructions and Helpful Information 

1. Plan your JavaES installation. 

Refer to the Sun Java Enterprise System 5 Installation Planning Guide.

If installing Sun Cluster software, see Sun Cluster Software Example.

If installing Monitoring Console, see Sun Java Enterprise System 5 Monitoring Guide

2. Determine if any release noted issues affect your installation. 

Before performing any of the procedures described in the Installation Guide, you should read the Sun Java Enterprise System 5 Release Notes for UNIX. These notes address installation issues that might affect your deployment.

3. Survey your hosts for existing software. 

Refer to Surveying Existing Hosts.

If you need to upgrade, refer to the Sun Java Enterprise System 5 Upgrade Guide for UNIX

4. Upgrade any existing components that are incompatible with the Java ES 5 release. 

Note: On Solaris OS, existing versions of Application Server and Message Queue can usually be upgraded by the Java ES installer. 

Refer to When Incompatible Components Are Installed.

Refer to the Sun Java Enterprise System 5 Upgrade Guide for UNIX.

For information on using the platform package commands, refer to their respective man pages. 

5. Verify that system requirements are met. 

Refer to Determining If Your Hosts Are Ready.

Refer to Platform Requirements and Issues in Sun Java Enterprise System 5 Release Notes for UNIX,

6. Determine if an installation sequence example can be used. 

Refer to Chapter 2, Example Installation Sequences.

7. For a Configure Now installation, gather configuration information for product components. 

Chapter 3, Configuration Information, in Sun Java Enterprise System 5 Installation Reference for UNIX provides product component configuration information.

Chapter 4, Configuration Worksheets, in Sun Java Enterprise System 5 Installation Reference for UNIX provides worksheets for gathering your data.

8. Make a copy of the product registry file. A backup copy is helpful in recovering if installation fails.

Solaris OS: /var/sadm/install/productregistry

Linux: /var/opt/sun/install/productregistry

HP-UX: /var/adm/sw/productregistry

9. To run as a non-root user for Directory Server, create system accounts before configuring. 

Create the necessary system accounts required for non-root. 

10. If installing product components that depend on servers or services that are already installed, ensure that the existing servers and services are accessible. 

For example, If you are installing a Portal Server Secure Remote Access subcomponent, Secure Remote Access Core must be running and accessible. 

11. If installing Directory Server, verify that Perl is installed.

Solaris OS: Perl packages (SUNWperl5*) can be found on the Solaris media.

Linux: /usr/bin/perl

HP-UX: /opt/perl/bin/perl

Perl must be present before installation. If Perl is not present, use pkgadd, rpm -i, or swinstall to add the packages.

12. Verify that the second column returned by getent hosts for your target system contains the FQDN rather than the simple hostname.

Run this command: 

getent hosts ip-address

13. If installing the Load Balancing Plugin with Apache Web Server, Apache Web Server must be installed and configured before beginning Java ES installation.  

On Linux only, you must first install Application Server, then install Apache Web Server, and finally install the Load Balancing Plugin. 

HP-UX does not support Apache Web Server. 

If not already done, install and configure Apache Web Server. For more information, see Configuring Web Servers for HTTP Load Balancing in the Sun Java System Application Server Enterprise Edition 8.2 High Availability Administration Guide.

14. If installing Access Manager for deployment on a third-party web container, you must choose the Configure Later type and run a postinstallation configuration script. 

Note: HP-UX does not support third-party web containers. For Config Now, Linux only supports BEA WebLogic as a third-party web container. 

For more information, see the Sun Java System Access Manager 7.1 Postinstallation Guide.

15. If this is a reinstallation, verify that the Web Server installation directory does not exist. If it does, remove or rename the directory.

Default installation directory for Web Server: 

Solaris OS: /opt/SUNWwbsvr7

Linux and HP-UX: /opt/sun/webserver7

16. If you are upgrading J2SE software, verify that you have stopped other products that depend on the J2SE component during installation. 

For further information, refer to the Sun Java Enterprise System 5 Upgrade Guide for UNIX.

17. If your host does not have direct connectivity to the Internet, an HTTP proxy needs to be specified. 

An Application Server example can be found in the Sun Java System Application Server Enterprise Edition 8.2 Administration Guide

18. On Linux, remove the /usr/share/bdb/db.jar link if it exists.


19. On Linux, verify that Ant 1.5.2 is not on the host: rpm –qa | grep ant

To remove it:  

rpm –e ant-1.5.2-23 ant—libs-1.5.2-23

20. On Linux, verify that Korn shell is installed. 

If Korn shell is not installed , go to the RPM directory and run the rpm –i pdksh command.

21. On HP-UX, verify that version 5.0 Update 3 of Java is installed before starting the installer. 

To verify the version of the JDK that is installed on your host: 

“swlist Jdk15”

If needed, download and install the correct version of Java from this location:

22. On HP-UX, if Web Proxy Server is installed with default settings, verify that user nobody is a valid user.

User ID and group ID of nobody should be a positive value in the /etc/passwd and /etc/group files.

23. Follow any installation sequence guidelines that apply to your installation. 

Refer to Table 2–1

In addition to these prerequisites, refer to Table 2–1 for information that might be helpful before installing Java ES.

Getting the Java ES Software

You can get the Java ES software in the following ways:

For a listing of the distribution bundles for this release, refer to Chapter 1, Java ES Distribution Bundles, in Sun Java Enterprise System 5 Installation Reference for UNIX.

Making an Installation Image on Your Network

The Java ES distribution is designed so that you can put the installation files in a shared location. The benefit of this is that the installation files can then be run from this shared location as often as needed.

ProcedureTo Create an Image from the DVD

Java ES supports multiple architectures. This example procedure provides instructions for making a Solaris SPARC installation image available on your site network.

  1. Log in as root or become superuser.

  2. Create a shared directory on your network. For example:

    mkdir shared-location/java_es-5
  3. Access your installation files from the DVD.

    The DVD contains Java ES versions of multiple architectures. Copy only what you need.

  4. Copy the files and media structure in the media root directory.

    find . -print -maxdepth 1 | cpio -pdum shared-location/java_es-5  
  5. Copy the License folder.

    find ./License -print  | cpio -pdum shared-location/java_es-5
  6. Copy the README folder.

    find ./README -print | cpio -pdum shared-location/java_es-5 
  7. Copy the architecture you need.

    find ./Solaris_sparc -print | cpio -pdum shared-location/java_es-5 

    Note –

    To copy all architectures:

    cd /cdrom/cdrom0
    find . -print | cpio -pdum shared-location/java_es-5

ProcedureTo Create an Image from the Compressed Archive

  1. Log in as root or become superuser.

  2. Create a shared directory on your network. For example:

    mkdir shared-location/java_es-5
  3. Access your installation files from the web site.

  4. Create an installation image from the compressed archive. For example:

    cd shared-location/java_ent_sys_5
    unzip pathname/
  5. Repeat this step for any other compressed archive files.

    Note –

    If you copy files for multiple platforms to the shared location, you will receive a query similar to the following in relation to the README file and the COPYRIGHT file:

    File already exists. OK to overwrite?

    Type Yes. These files are identical for all platforms.