Overview of the ssopatch Utility

The ssopatch utility is a Java command-line utility that is available on Solaris and Linux systems as ssopatch and on Windows systems as ssopatch.bat.

The syntax for ssopatch in OpenSSO Enterprise 8.0 update releases has changed considerably since the OpenSSO Enterprise 8.0 release. For the new syntax, see Running the ssopatch Utility in this section.

The ssopatch patch utility can perform these functions:

• Compares an OpenSSO Enterprise WAR to its original manifest, to determine if the WAR file has been customized or modified

• Compare two OpenSSO Enterprise WAR files, to determine the differences between the two files including any customizations made to the original WAR file and any changes in the new WAR file

• Generates a staging area of the files required to generate a new patched OpenSSO Enterprise WAR file

The ssopatch utility uses a manifest file to determine the contents of a specific OpenSSO Enterprise WAR file. A manifest file is an ASCII text file that contains:

• A string that identifies the specific version of the OpenSSO Enterprise WAR file

• All of the individual files in the OpenSSO Enterprise WAR file, with checksum information for each file

The manifest file is usually named OpenSSO.manifest and is stored in the in the META-INF directory of the OpenSSO Enterprise WAR file. The ssopatch utility sends its results to the standard output (stdout). If you prefer, you can capture the ssopatch output by redirecting the output to a file. If ssopatch finishes successfully, it returns a zero (0) exit code. If errors occur, ssopatch returns a non-zero exit code.

Running the ssopatch Utility

To run the ssopatch utility, follow this usage:

ssopatch --help|-? [--locale|-l]

ssopatch --war-file|-o [--manifest|-m] [--locale|-l]

ssopatch --war-file|-o 
--war-file-compare|-c 
[--staging|-s] 
[--locale|-l] 
[--override|-r] 
[--overwrite|-w]

where the options are: