Sun Java Enterprise System 5 Update 1 Upgrade Guide for Microsoft Windows

Chapter 4 Directory Proxy Server

This chapter describes how to upgrade Directory Proxy Server from Java ES 5 (Release 5) to Java ES 5 Update 1 (Release 5U1): Sun Java System Directory Proxy Server 6.2.

The chapter provides a general overview of upgrade issues and procedures for the upgrade path supported by Release 5U1. This chapter covers the following topics:

Note –

File locations in this chapter are specified with respect to directory paths referred to as DSEE-base. At least part of these paths might have been specified as installation directories when Directory Proxy Server was installed.

The default value of DSEE-base is C:\Program Files\Sun\JavaES5\DSEE.

The default value of instancePath is C:\Program Files\Sun\JavaES5\DSEE\var\DPSInstance

About Directory Server Enterprise Edition

Directory Server, Directory Proxy Server, and Directory Services Control Center (DSCC) are three components of Directory Server Enterprise Edition (DSEE). The three components can be installed together on the same system or separately on different systems.

In a deployment scenario in which Directory Server, Directory Proxy Server and Directory Server Control Center are installed on the same system, you cannot upgrade any one component without upgrading the other two. When you apply the DSEE patch to upgrade any of the components, all the three are automatically upgraded.

In a deployment scenario in which the three components are installed separately on different systems, you must apply the patch individually on each of the systems to upgrade the components.

On the system running DSCC, DSCC is using a specific Directory Server instance also named DSCC registry. This instance of Directory Server stores the DSCC configuration data. When upgrading DSCC you must stop this instance. The command to identify the instance is:

DSEE-base\dscc6\bin\dsccsetup.exe status

The output will contain the path of the DSCC Registry. During the upgrade procedure described in this chapter, when you are asked to stop the running instances, you must stop the DSCC Registry too.

Execute the command DSEE-base\dscc6\bin\dsccsetup.exe stop instance-path to stop the instance.

Overview of Directory Proxy Server Upgrades

The section describes the following general aspects of Directory Proxy Server that affect upgrading to Release 5U1:

About Release 5U1

Release 5U1 is a maintenance release that fixes bugs in Release 5 Directory Proxy Server . Release 5U1 Directory Proxy Server is still an LDAP proxy, but with new, extensible routing capabilities. Release 5 also enables the Virtual Directory feature, the ability to aggregate multiple data views in a single view. These data views can represent LDAP or SQL accessible data stores.

For more information, see the Sun Java System Directory Server Enterprise Edition 6.2 Release Notes.

Java ES Release 5U1 Upgrade Roadmap

Table 4–1 shows the supported Directory Proxy Server upgrade paths to Release 5:

Table 4–1 Upgrade Paths to Java ES 5 Update 1: Directory Proxy Server 6.2


Java ES Release	Directory Proxy Server Release	General Approach	Reconfiguration Required
Release 5	Sun Java System Directory Proxy Server 6.0	Maintenance upgrade. Apply patches.	None
Release 4		Direct upgrade of Directory Proxy Server from Release 4 to Release 5U1 is not supported. This upgrade path is supported by first upgrading Release 4 Directory Proxy Server to Release 5 Directory Proxy Server and then upgrading Release 5 to Release 5U1. The information about upgrading Release 4 to Release 5 is documented in Sun Java ES 5 Upgrade Guide for Microsoft Windows.

Directory Proxy Server Data

Directory Proxy Server no longer uses Directory Server for storing configuration data. Configuration is performed using the new Directory Service Control Center or Directory Server EE command-line utilities.

The following table shows the type of data that could be impacted by an upgrade of Directory Proxy Server software.

Table 4–2 Directory Proxy Server Data Usage


Type of Data	Location	Usage
Directory Proxy Server configuration data	Directory Proxy Server 6.x: Accessed through Directory Service Control Center and Directory Server Enterprise Edition command-line utilities	Configuration of Directory Proxy Server
Security data	Directory Proxy Server 6.x: SSL configured through Directory Service Control Center and Directory Server Enterprise Edition command-line utilities	Server certificates

Directory Proxy Server Compatibility Issues

Release 5U1 Directory Proxy Server does not introduce any interface changes and is therefore backwardly compatible with Java ES Release 5 Directory Proxy Server.

Directory Proxy Server Dependencies

Dependencies on other Java ES components can impact the procedure for upgrading and reconfiguring Directory Proxy Server software. Directory Proxy Server has dependencies on the following Java ES components: specific Java ES shared components, as listed in Table 1–8. Directory Proxy Server provides front-end access to Directory Server but has no dependency on Directory Server beyond this functional relationship.

Upgrading Directory Proxy Server from Java ES 5

This section includes information about upgrading Directory Proxy Server from Release 5 to Release 5U1. The section covers the following topics:

Introduction
Release 5 Directory Proxy Server Upgrade

Introduction

When upgrading Release 5 Directory Proxy Server to Release 5U1, consider the following aspects of the upgrade process:

General Upgrade Approach. The upgrade is achieved by patching Release 5 Directory Proxy Server.
Upgrade Dependencies. Directory Proxy Server has dependencies on a number of Java ES shared components, (see Table 1–8), of which CAC, MFWK, SJWC, and Security components (NSS,JSS,NSPR) need to be upgraded when you perform a maintenance upgrade of Directory Server.
Backward Compatibility. Release 5U1 Directory Proxy Server is backwardly compatible with the Release 5 version.
Upgrade Rollback. You can do a rollback of the Release 5U1 upgrade by reverting to the previous version, which is left intact by the upgrade.

Release 5 Directory Proxy Server Upgrade

This section describes how to perform an upgrade of Directory Proxy Server from Release 5 to Release 5U1. The section covers the following topics:

Pre-Upgrade Tasks

Before you upgrade Directory Proxy Server, perform the tasks described below.

Verify Current Version Information

Verify the current version of Directory Proxy Server before you upgrade.

To Verify Current Version Information

Check the current version of Directory Proxy Server instance.

DSEE-base\dps6\bin\dpadm.exe -V

Start the new Directory Server Proxy Server instance.

DSEE-base\dps6\bin\dpadm.exe start instance-path
[dpadm] dpadm : 6.0 [Build information]

Upgrade Directory Proxy Server Dependencies

It is generally recommended that all Java ES components on a computer system (and in a computing environment) be upgraded to Release 5U1. Before upgrading Directory Proxy Server, you need to upgrade CAC, MFWK, SJWC, and Security components (NSS,JSS,NSPR). Also, Directory Proxy Server requires that Windows Installer patch (126910–02) is already applied.

Upgrading Release 5 Directory Proxy Server

This section discusses considerations that impact the upgrade procedure for Directory Proxy Server, followed by a description of the procedure itself.

Upgrade Considerations

This upgrade of Directory Proxy Server software to Release 5U1 takes into account the following considerations:

Any Java ES components or applications using a Directory Proxy Server instance should be shut down if performing LDAP queries during the Directory Proxy Server upgrade or if using a library that is being patched.
In a deployment architecture in which there are multiple instances of Directory Proxy Server running on a single computer (all corresponding to the same installed Directory Proxy Server image), you only have to upgrade the Directory Proxy Server image once.
In a maintenance upgrade, you do not have to migrate schema, configuration, security and user data.
The Release 5U1 Directory Proxy Server upgrade patches for Windows OS are shown in the following table:

Table 4–3 Patches to Upgrade Directory Proxy Server on Windows


Description	Patch ID [Patch revision numbers are the minimum required for upgrade to Release 5U1. If newer revisions become available, use the newer ones instead of those shown in the table.]
Directory Server Enterprise Edition core (includes Directory Proxy Server)	125311–05
Directory Proxy Server localization	The localized patch files are delivered within the core patch.

Upgrade Procedure

The procedure documented below applies to Directory Proxy Server instances residing locally on the computer where the upgrade is taking place.

Note –

Directory Server and Directory Proxy Server share the same patch. You require to follow the upgrade procedure listed here only if the Directory Proxy Server is on a separate host. You are not required to execute the Directory Server related stop-commands if the Directory Server is not installed on the same host. However, you can execute the Directory Server stop-command to be sure that the Directory Server process is stopped.

To Upgrade Directory Proxy Server to Release 5U1

Stop any Java ES components which use the Directory Server.

Stop the service using persistent connections like Access Manager. You can stop Access Manager by stopping its web container.

Shut down the Directory Server.

Also shut down Directory Server and Directory Registry if they are on the same system.

DSEE-base\ds6\bin\dsadm.exe stop instancePath

DSEE-base\dps6\bin\dpadm.exe stop instancePath

DSEE-base\dscc6\bin\dsccsetup.exe stop instancePath

Make sure you have upgraded any Java ES components upon which Directory Proxy Server has hard upgrade dependencies (see Upgrade Directory Proxy Server Dependencies.

Obtain the required Directory Proxy Server Release 5U1 upgrade patches, based on Table 4–3.

To obtain the patch, see Accessing Java ES Patches. Patches can be downloaded to \workingDirectory.

Install the patch.

Installation is generally performed by running patch-id.exe, however, be sure to consult the README.patch-id file in the patch directory for installation instructions.

Note –
If you are prompted to restart the system, select No. Wait till the patch installation process is completed and then restart and re-login as the same user to complete the patch installation.

Verify the patch log file.

The log file is found at: %TEMP%\SUNJAVAES_<patch-id>.log

Verify the patch installation with the utility ListJavaESPatches.exe.

Run ListJavaESPatches.exe and check that the output includes the patch id of the patch that you have installed in Step 6. For more information, see Identifying Installed Java ES Patches.

Start the Directory Proxy Server.

Also start Directory Server and Directory Registry if they are on the same system.

DSEE-base\ds6\bin\dsadm.exe start instancePath

DSEE-base\dps6\bin\dpadm.exe start instancePath

DSEE-base\dscc6\bin\dsccsetup.exe start instancePath

Restart CAC.

Start any Java ES components that use Directory Server.

Verifying the Upgrade

You can verify successful upgrade of Directory Proxy Server as follows:

Log in as administrator.
Check the new version of Directory Proxy Server instance:DSEE-base\dps6\bin\dsadm.exe -V
[dsadm] dsadm : 6.2 [Build information]

Post-Upgrade Tasks

There are no post-upgrade tasks beyond the steps described in Upgrade Procedure.

Rolling Back the Upgrade

Log in as administrator.
Shut down the Directory Proxy Server instances.

DSEE-base\ds6\bin\dpadm.exe stop instancePath
Double-click Uninstall_patch-id.bat to uninstall the patch.
Restart the Directory Proxy Server instances that were shut down in step 2.DSEE-base\ds6\bin\dpadm.exe start instancePath
Start the Directory Server Proxy Server instance.

DSEE-base\dps6\bin\dpadm.exe start instancePath
[dpadm] dpadm : 6.0 [Build information]