Installing Patches for Java CAPS

This topic provides instructions that lead you through the procedures to successfully install the Java^TM Composite Application Platform Suite (Java CAPS) patches. Release 6 features one access point for all patches at Java CAPS Support, http://goldstar.stc.com.

What You Need to Know

• Java CAPS 6 Patch Overview

• Java CAPS 6 Patch Management Tools

What You Need to Do

• Installing Java CAPS 6 Patches

• Uninstalling Java CAPS 6 Patches

Java CAPS 6 Patch Overview

The Java CAPS 6 distribution consists of NetBeans^TM IDE and Sun GlassFish Enterprise Server in addition to Java CAPS specific components. The patching of NetBeans IDE and Sun GlassFish Enterprise Server are done by the respective product patches. Java CAPS 6 supports command-line patch installation and uninstallation. These patches will be made available to download at the Java CAPS Support site at http://goldstar.stc.com. See the web site and Installing Java CAPS 6 Patches for instructions on applying these patches.

---

Note –

In Release 5.1.x patches were known as emergency software releases (ESRs) and temporary patches were known as a hot fixes.

---

Java CAPS 6 Patches

The Java CAPS 6 specific component patches can be applied to five environments:

• Design Time – NetBeans IDE (DT-NB)

  ---

  Note –

  This patches modules specific to Java CAPS and does not update NetBeans IDE core, which is patched by NetBeans patches.

  ---

• Design Time – Command-line Codegen (DT-CLI)

  ---

  Note –

  Java CAPS provides a command-line environment to build projects. The command-line build brings over the project from the Java CAPS Repository and builds it using the NBM downloaded form the Repository. This utility caches a version of the NBM in its local environment. This cache is patched in the command-line Codegen's local environment.

  ---

• Repository Server (REP)

• Enterprise Manager (EM)

• Sun GlassFish Enterprise Server (runtime RT)

  ---

  Note –

  This patches Java CAPS components and does not patch the application server components.

  ---

Types of Patches

There are two types of Java CAPS 6 patches:

• A Temporary Patch provides a short-term solution to the specific problems

  These patches usually consist of a minimal set of artifacts that address the problem. In Java CAPS 6 these patches are similar to a normal patch. They are made available to customers who request them, but if not thoroughly tested are not made available on the Java CAPS Support Web Site.

  This patch uses the file name Tnnnnnnn-nn-descriptor, where

  • T designates the patch as temporary

  • nnnnnnn lists the patch number

  • -nn lists the version number of the patch

  • descriptor defines the type of patch; for example, REP for Repository

• An Update Release Patch contains a cumulative set of the five environment patches from the Java CAPS 6 GA release, including

  • Runtime Patch

  • Design Time (NetBeans)

  • Design Time (CLI)

  • Enterprise Manager Server

  • Repository Server

  This patch uses the file name nnnnnnn-nn-descriptor, where

  • nnnnnnn lists the patch number

  • -nn lists the version number of the patch

  • descriptor defines the type of patch; for example, DT—NB for Design-time NetBeans IDE

  ---

  Note –

  Each temporary patch is superseded by the next update patch.

  ---

Java CAPS 6 Patch Management Tools

This topic discusses the Java CAPS patch management tools, including the Install Tool, Uninstall Tool, and the Patch Information Tool.

Parameters determine the behavior of the patch options. Let us use the domain name, which is an application server environment option, as an example. If we do not specify the option, the patch is applied to the installation base directory.

---

Note –

The environment of the patch is determined from the patch itself. If the environment does not exist the -basedir and -type options allow the new environment to be added. By default, this option should not be used; it is used only for initializing a new environment.

---

Java CAPS 6 Patch Install Tool

Use the tool to install patches.

Usage: caps-patch-install [-help]  [-nobackup] 
[-reinstall] [-basedir base directory] 
[-type environment type] [-domaindir domains directory]
[-domain domain name] [-clirepdir command-line local repository]
[-verbose] [-patch distributionFile/directory]

---

Note –

The Patch Install Tool requires the -patch distributionFile/directory option or the -help option to be present. The -patch option is required in all cases except when attempting to obtain help.

The -basedir and -type options are required to patch a non -default installation location for the first time. These are added to specify the base directory and type of the new environment.

---

-basedir	The location of the component installation directory. This is used when the component is installed in a non-default location. For example, the application server installation directory. The -type command-line option must be specified with this option.
-help	Prints Installation Tool usage and version information.
-nobackup	Does not create a backup file.  Note – If you use this option you cannot uninstall this patch.
-patch	The path to the patch distribution file.
-reinstall	Installs an already installed patch.  Note – This patch cannot be uninstalled.
-type	The type of environment. Valid values are DT-NB, DT-CLI, RT, EM, and REP.
-verbose	Prints detailed patch information during the patch installation process.
Application Server Domain Specific Patching in a Runtime Environment Additional command-line options patch specific domains when using the caps-patch-uninstall script in a runtime environment.
-domaindir	Lists the directory where the domain is located. If specified, the path must be accessible in the file system. If not specified, the domain is expected in the default domain directory of the Sun GlassFish Enterprise Server (SGES).
-domain	Names the domain that is being patched. A valid domain name should be specified.
Command-line Codegen In command-line Codegen a specific local repository has to be patched, and the installation script takes this local Repository as an additional parameter. If this parameter is specified only the non-repository-specific components are patched.  Note – While using the Command-line Codegen Patch Install Tool you have specify the local cache for storing repository components. Command-line Codegen can support multiple local repositories. The option -clirepdir points to the particular directory to be patched.
-clirepdir	Lists the command-line Repository directory that is being patched. There is no default value for this variable.

Java CAPS 6 Patch Uninstall Tool

Use the tool to uninstall patches as well as to cleanup an interrupted patch installation or uninstallation.

---

Note –

You do not need to run the uninstall script for normal failures.

---

The command syntax for uninstalling patches is

Usage: caps-patch-uninstall [-verbose] [-help] [-cleanup] [-domain domain name] 
[-clirepdir command-line local repository] PatchId

The command syntax for cleanup of an interrupted installation or uninstallation is

Usage: caps-patch-uninstall [-verbose] -cleanup [PatchId]

default	Uninstalls the patch PatchId.
-cleanup	Cleans up a previously interrupted installation or uninstallation.
-help	Prints Uninstallation Tool usage and version information.
-verbose	Prints detailed patch README information.
Application Server Domain Specific Patching in a Runtime Environment Additional command-line options patch specific domains in the runtime environment.
-domain	Names the domain from which the patch is be removed.
Command-line Codegen Additional command-line options are used by the caps-patch-uninstall tool in the command—line Codegen environment.
-clirepdir	Lists the command-line Repository directory from which the patch is being removed.

Java CAPS 6 Patch Information Tool

The command syntax for patch information is

Usage: caps-patch-info [-verbose] [-help] [-patch PatchId]

-patch	Prints information about a specific installed patch.
-help	Prints patch usage and version information.
-verbose	Prints detailed patch information for each JAR file.

Installing Java CAPS 6 Patches

This topic provides instructions on how to install Java CAPS 6 patches, including information that helps you verify that the installation completed successfully. Before installing patches you must obtain them from Java CAPS Support at http://goldstar.stc.com. For information about patches, script variables, and uninstallation procedures, see Java CAPS 6 Patch Overview, Java CAPS 6 Patch Management Tools, and Uninstalling Java CAPS 6 Patches.

---

Note –

As in previous releases, Java CAPS user applications will have to be rebuilt and redeployed if you want to use the patched product component. This situation can arise after a design-time NetBeans IDE, design-time Command-line Codegen, and/or a Repository patch has been installed.

---

If you have installed Java CAPS across multiple servers, such as NetBeans IDE on server 1 and Sun GlassFish Enterprise Server on server 2, you need to install the patch(es) on more than one machine. The tool informs you of a successful patch installation at the conclusion of the process.

---

Note –

If a patch installation is interrupted, use the uninstall script to remove the patch before applying the patch again.

---

To Install a Sun GlassFish Enterprise Server Environment Patch

This procedure installs a runtime patch on the Sun GlassFish Enterprise Server, with the ZIP file name using the format of nnnnnnn-nn–RT.zip.

---

Note –

The -domain option is used to patch a particular domain. If you want to patch only the application server installation directory you must run the patch without the -domain option.

---

1. Change directory to JavaCAPS6–INSTALL-DIR/appserver/domains/domain-name/bin.

   ---

   Note –

   JavaCAPS6–INSTALL-DIR is the directory where you installed Java CAPS.

   ---

2. From the command line, run ./stopserver.sh or (stopserver.bat) to stop the application server.

3. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

4. At the command line, enter ./caps-patch-install -verbose -domain domain-name -patch any-directory/nnnnnnn-nn-RT.zip.

   ---

   Note –

   any-directory is the path to the patch.

   ---

5. Change directory to JavaCAPS6–INSTALL-DIR/appserver/domains/domain-name/bin.

6. From the command line, run ./startserver.sh (or startserver.bat) to start the application server.

To Install an Enterprise Manager Environment Patch

This procedure installs a patch on the Enterprise Manager Server, with the ZIP file name using the format of nnnnnnn-nn–EM.zip.

1. Change directory to JavaCAPS6–INSTALL-DIR/emanager.

   ---

   Note –

   JavaCAPS6–INSTALL-DIR is the directory where you installed Java CAPS.

   ---

2. From the command line, run ./stopserver.sh (or stopserver.bat) to stop the Enterprise Manager server.

3. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

4. At the command line, enter ./caps-patch-install -patch any-directory/nnnnnnn-nn-EM.zip.

   ---

   Note –

   any-directory is the path to the patch.

   ---

5. Change directory to JavaCAPS6–INSTALL-DIR/emanager.

6. From the command line, run ./startserver.sh (or startserver.bat) to start the Enterprise Manager server.

To Install a Design-time NetBeans IDE Environment Patch

This procedure installs a patch on NetBeans IDE, with the ZIP file name using the format of nnnnnnn-nn–DT-NB.zip.

1. Close NetBeans IDE.

2. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

   ---

   Note –

   JavaCAPS6–INSTALL-DIR is the directory where you installed Java CAPS.

   ---

3. At the command line, enter ./caps-patch-install -verbose -patch any-directory/nnnnnnn-nn-DT-NB.zip.

   ---

   Note –

   any-directory is the path to the patch.

   ---

To Install a Command-line Codegen Environment Patch

This procedure installs a command-line Codegen patch with the ZIP file name using the format of nnnnnnn-nn–DT-CLI.zip.

1. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

   ---

   Note –

   JavaCAPS6–INSTALL-DIR is the directory where you installed Java CAPS.

   ---

2. At the command line, enter ./caps-patch-install -verbose -clirepdir cmdlineCodegenRepositoryDir -patch any-directory/nnnnnnn-nn-DT-CLI.zip.

   ---

   Note –

   any-directory is the path to the patch.

   ---

To Install a Repository Environment Patch

This procedure installs a Repository patch with the ZIP file name using the format of nnnnnnn-nn–REP.zip.

---

Caution –

This patch cannot be uninstalled.

---

1. Change directory to JavaCAPS6–INSTALL-DIR/repository/repository.

   ---

   Note –

   JavaCAPS6–INSTALL-DIR is the directory where you installed Java CAPS.

   ---

2. From the command line, run ./stopserver.sh (or stopserver.bat) to stop the Repository.

3. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

4. At the command line, enter ./caps-patch-install -verbose -patch any-directory\nnnnnnn-nn-REP.zip.

   ---

   Note –

   any-directory is the path to the patch.

   ---

5. Change directory to JavaCAPS6–INSTALL-DIR/repository/repository.

6. From the command line, run ./startserver.sh (or startserver.bat) to start the Repository.

7. Start NetBeans IDE, or if it is already running, refresh it.

Uninstalling Java CAPS 6 Patches

This topic provides instructions on how to uninstall Java CAPS 6 patches. The tool informs you of a successful patch installation at the conclusion of the process. For information about patches and installation procedures, see Java CAPS 6 Patch Overview and Installing Java CAPS 6 Patches.

---

Note –

You do not need to run the uninstall script for normal failures.

---

To Uninstall a Java CAPS Patch

This procedure uninstalls a Java CAPS 6 patch using the format of nnnnnnn-nn for the patch number.

1. Change directory to JavaCAPS6–INSTALL-DIR/caps-patch/util/bin.

2. At the command line, enter ./caps-patch-uninstall patch-number, for example, nnnnnnn-nn.

   Where patch-number is the identifying number of the patch you are uninstalling.

   ---

   Note –

   For details about the script variables see Java CAPS 6 Patch Management Tools.

   ---