com.ptc.windchill.instassm
Class IAConstants

java.lang.Object
  com.ptc.windchill.instassm.IAConstants

public final class IAConstants

extends Object

Constants for use by InstalledAssembly(Registry) classes.

Supported API: false

Extendable: false

Field Summary

(package private) static String	BASE_INSTALLER_SEQUENCE_ATTRIBUTE
(package private) static String	BASE_RELEASE_IDENTIFIER_ATTRIBUTE
(package private) static String	BASE_SUPPORT_DATE_CODE_ATTRIBUTE
(package private) static String	COMPONENT_ELEMENT
(package private) static String	COMPONENT_NAME_ATTR
(package private) static String	COMPONENT_SHORT_NAME_ATTR
(package private) static String	COMPONENT_UID_ATTR
(package private) static String	COMPONENT_VERSION_ATTR
(package private) static String	DISPLAY_LABEL_ATTRIBUTE
(package private) static String	DISPLAY_NAME_ATTRIBUTE
(package private) static boolean	IN_AN_INSTALLER
(package private) static String	INCOMPLETE_ATTRIBUTE
(package private) static boolean	initFromWindchillRoot_
(package private) static String	INSTALLATION_REGISTRY_DIR_NAME
(package private) static String	INSTALLATION_REGISTRY_FILE_NAME
(package private) static String	INSTALLATION_REGISTRY_MERGE_DIR_NAME
(package private) static String	INSTALLATION_REGISTRY_PARENT_DIR_NAME
(package private) static String	INSTALLED_ASSEMBLY_ELEMENT
(package private) static String	INSTALLED_ASSEMBLY_EXT
(package private) static String	INSTALLED_COMPONENT_COMP_VERSION_ATTR
(package private) static String	INSTALLED_COMPONENT_ELEMENT
(package private) static String	INSTALLED_COMPONENT_NAME_ATTR
(package private) static String	INSTALLED_COMPONENT_PROD_VERSION_ATTR
(package private) static String	INSTALLED_COMPONENT_SHORT_NAME_ATTR
(package private) static String	INSTALLED_COMPONENT_UID_ATTR
private static String	INSTALLER_DATA_DIR_NAME
private static String	INSTALLER_DATA_DIR_REL_PATH
(package private) static String	INSTALLER_ELEMENT
(package private) static String	INSTALLER_SEQUENCE_ATTRIBUTE
(package private) static File	installerCdRoot_
(package private) static File	installerExtractionRoot_
(package private) static File	installRoot_
(package private) static String	INSTREG_VERSION
(package private) static String	INTERMEDIATE_INSTALLER_SEQUENCE_LIST_ATTRIBUTE
(package private) static String	INTERMEDIATE_RELEASE_IDENTIFIERS_LIST_ATTRIBUTE
(package private) static String	INTERMEDIATE_SUPPORT_DATE_CODES_LIST_ATTRIBUTE
(package private) static String	LOCALE_CODE_ATTR
(package private) static String	LOCALE_ELEMENT
(package private) static String	LOCALE_EXT
(package private) static String	LOCALE_NAME_ATTR
private static String	NS
(package private) static String	PRODUCT_ELEMENT
(package private) static String	PRODUCT_NAME_ATTR
(package private) static String	PRODUCT_UID_ATTR
private static File	registryDir_
(package private) static String	RELEASE_IDENTIFIER_ATTRIBUTE
(package private) static File	secondaryInstRegDir_
(package private) static String	SUPPORT_DATE_CODE_ATTRIBUTE
(package private) static String	SUPPORT_RELEASE_NUMBER_ATTRIBUTE
(package private) static String	TEMP_PATCH_DESCRIPTION_ATTR
(package private) static String	TEMP_PATCH_ELEMENT
(package private) static String	TEMP_PATCH_EXT
(package private) static String	TEMP_PATCH_NAME_ATTR
(package private) static boolean	treatAsR70WindchillInstallReg_
(package private) static String	VERSION_CODE_ATTRIBUTE

Constructor Summary

IAConstants()

Method Summary

static boolean	doesRegistryDirExist()
static boolean	doesRegistryDirExist(boolean use_treat_r70_when_set)
static boolean	doesRegistryMergeDirExist()
static boolean	doesSecondaryRegistryDirExist()
static void	ensureRegistryDirExists()
static String	getFileNameForIaFile(String assembly_id) Standard method for computing prescribed file name for .ia files based on the assembly id.
static String	getFileNameForLocFile(String locale_name) Standard method for computing prescribed file name for .loc files based on the locale name.
static String	getFileNameForTempPatchFile(String temp_patch_name) Standard method for computing prescribed file name for .tp files based on the temp patch name.
static String	getInstallationRegistryDirName()
(package private) static String	getInstalledAssembliesDirWinchillUrl()
static File	getInstallersCdRoot() When inside an installer some registry processes require access to the installer's CD ROOT.
static File	getInstallersExtractionDir() When inside an installer some registry processes require access to the installer's Temp Extraction Root.
static File	getInstallersInstallerDataDir() When inside an installer some registry processes require access to the installer's InstallerData directory.
static File	getInstallersInstallerDataDir(File cd_root) When inside an installer some registry processes require access to the installer's InstallerData directory.
static File	getInstallRoot() When inside an installer some registry processes require access to the install directory.
(package private) static File	getRegistryDir(boolean fail_if_doesnt_exist) Determine the registry location by querying the wt.properties off of the classpath.
(package private) static File	getRegistryDir(boolean fail_if_doesnt_exist, boolean use_treat_r70_when_set) Determine the registry location by querying the wt.properties off of the classpath.
(package private) static File	getRegistryMergeDir() Determine the registry merge directory.
(package private) static File	getSecondaryRegistryDir(boolean fail_if_null) Return the secondary registry location, if any.
static File	getStandardRegistryDirFromLoadPoint(File load_point)
static File	getWindchillProductInstallationRegistryDir(File product_root)
static boolean	inAnInstaller() Standard method for determining if this process is running within an installer.
static void	initFor3rdPartyProduct(File registry_dir)
static void	initFor3rdPartyProduct(File registry_dir, File installer_cd_root, File installer_extraction_root)
static void	initFromWindchillRootDir(File windchill_root)
static void	initFromWindchillRootDir(File windchill_root, File installer_cd_root, File installer_extraction_root)
static void	initFromWtProperties()
static void	initFromWtProperties(File installer_cd_root, File installer_extraction_root)
private static void	initRegDirFromCodebase(File codebase, File installer_cd_root, File installer_extraction_root)
static boolean	inWindchillRoot()
private static void	reportOnInitialization(boolean init_from_codebase)
private static void	setInstallerCdRoot(File installer_cd_root) When inside an installer some registry processes require access to the installer's CD ROOT.
private static void	setInstallersExtractionDir(File installer_extraction_root) When inside an installer some registry processes require access to the installer's Temp Extraction Root.
void	setInstallRoot(File install_root) When inside an installer some registry processes require access to the install directory.
private static void	setRegistryDir(File registry_dir) Set registry directory as specified.
static boolean	treatAsR70WindchillInstallReg()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

registryDir_

private static File registryDir_

IN_AN_INSTALLER

static final boolean IN_AN_INSTALLER

NS

private static final String NS

INSTALLATION_REGISTRY_PARENT_DIR_NAME

static final String INSTALLATION_REGISTRY_PARENT_DIR_NAME

See Also:

Constant Field Values

INSTALLATION_REGISTRY_DIR_NAME

static final String INSTALLATION_REGISTRY_DIR_NAME

See Also:

Constant Field Values

INSTALLATION_REGISTRY_MERGE_DIR_NAME

static final String INSTALLATION_REGISTRY_MERGE_DIR_NAME

See Also:

Constant Field Values

INSTALLATION_REGISTRY_FILE_NAME

static final String INSTALLATION_REGISTRY_FILE_NAME

See Also:

Constant Field Values

INSTALLER_DATA_DIR_NAME

private static final String INSTALLER_DATA_DIR_NAME

See Also:

Constant Field Values

INSTALLER_DATA_DIR_REL_PATH

private static final String INSTALLER_DATA_DIR_REL_PATH

INSTREG_VERSION

static final String INSTREG_VERSION

See Also:

Constant Field Values

INSTALLED_ASSEMBLY_ELEMENT

static final String INSTALLED_ASSEMBLY_ELEMENT

See Also:

Constant Field Values

INSTALLED_ASSEMBLY_EXT

static final String INSTALLED_ASSEMBLY_EXT

See Also:

Constant Field Values

LOCALE_ELEMENT

static final String LOCALE_ELEMENT

See Also:

Constant Field Values

LOCALE_CODE_ATTR

static final String LOCALE_CODE_ATTR

See Also:

Constant Field Values

LOCALE_NAME_ATTR

static final String LOCALE_NAME_ATTR

See Also:

Constant Field Values

LOCALE_EXT

static final String LOCALE_EXT

See Also:

Constant Field Values

TEMP_PATCH_ELEMENT

static final String TEMP_PATCH_ELEMENT

See Also:

Constant Field Values

TEMP_PATCH_NAME_ATTR

static final String TEMP_PATCH_NAME_ATTR

See Also:

Constant Field Values

TEMP_PATCH_DESCRIPTION_ATTR

static final String TEMP_PATCH_DESCRIPTION_ATTR

See Also:

Constant Field Values

TEMP_PATCH_EXT

static final String TEMP_PATCH_EXT

See Also:

Constant Field Values

installerExtractionRoot_

static File installerExtractionRoot_

installerCdRoot_

static File installerCdRoot_

treatAsR70WindchillInstallReg_

static boolean treatAsR70WindchillInstallReg_

initFromWindchillRoot_

static boolean initFromWindchillRoot_

installRoot_

static File installRoot_

secondaryInstRegDir_

static File secondaryInstRegDir_

RELEASE_IDENTIFIER_ATTRIBUTE

static final String RELEASE_IDENTIFIER_ATTRIBUTE

See Also:

Constant Field Values

DISPLAY_NAME_ATTRIBUTE

static final String DISPLAY_NAME_ATTRIBUTE

See Also:

Constant Field Values

DISPLAY_LABEL_ATTRIBUTE

static final String DISPLAY_LABEL_ATTRIBUTE

See Also:

Constant Field Values

VERSION_CODE_ATTRIBUTE

static final String VERSION_CODE_ATTRIBUTE

See Also:

Constant Field Values

SUPPORT_RELEASE_NUMBER_ATTRIBUTE

static final String SUPPORT_RELEASE_NUMBER_ATTRIBUTE

See Also:

Constant Field Values

SUPPORT_DATE_CODE_ATTRIBUTE

static final String SUPPORT_DATE_CODE_ATTRIBUTE

See Also:

Constant Field Values

INSTALLER_SEQUENCE_ATTRIBUTE

static final String INSTALLER_SEQUENCE_ATTRIBUTE

See Also:

Constant Field Values

INCOMPLETE_ATTRIBUTE

static final String INCOMPLETE_ATTRIBUTE

See Also:

Constant Field Values

BASE_RELEASE_IDENTIFIER_ATTRIBUTE

static final String BASE_RELEASE_IDENTIFIER_ATTRIBUTE

See Also:

Constant Field Values

BASE_SUPPORT_DATE_CODE_ATTRIBUTE

static final String BASE_SUPPORT_DATE_CODE_ATTRIBUTE

See Also:

Constant Field Values

BASE_INSTALLER_SEQUENCE_ATTRIBUTE

static final String BASE_INSTALLER_SEQUENCE_ATTRIBUTE

See Also:

Constant Field Values

INTERMEDIATE_RELEASE_IDENTIFIERS_LIST_ATTRIBUTE

static final String INTERMEDIATE_RELEASE_IDENTIFIERS_LIST_ATTRIBUTE

See Also:

Constant Field Values

INTERMEDIATE_SUPPORT_DATE_CODES_LIST_ATTRIBUTE

static final String INTERMEDIATE_SUPPORT_DATE_CODES_LIST_ATTRIBUTE

See Also:

Constant Field Values

INTERMEDIATE_INSTALLER_SEQUENCE_LIST_ATTRIBUTE

static final String INTERMEDIATE_INSTALLER_SEQUENCE_LIST_ATTRIBUTE

See Also:

Constant Field Values

INSTALLER_ELEMENT

static final String INSTALLER_ELEMENT

See Also:

Constant Field Values

INSTALLED_COMPONENT_ELEMENT

static final String INSTALLED_COMPONENT_ELEMENT

See Also:

Constant Field Values

INSTALLED_COMPONENT_UID_ATTR

static final String INSTALLED_COMPONENT_UID_ATTR

See Also:

Constant Field Values

INSTALLED_COMPONENT_NAME_ATTR

static final String INSTALLED_COMPONENT_NAME_ATTR

See Also:

Constant Field Values

INSTALLED_COMPONENT_SHORT_NAME_ATTR

static final String INSTALLED_COMPONENT_SHORT_NAME_ATTR

See Also:

Constant Field Values

INSTALLED_COMPONENT_COMP_VERSION_ATTR

static final String INSTALLED_COMPONENT_COMP_VERSION_ATTR

See Also:

Constant Field Values

INSTALLED_COMPONENT_PROD_VERSION_ATTR

static final String INSTALLED_COMPONENT_PROD_VERSION_ATTR

See Also:

Constant Field Values

COMPONENT_ELEMENT

static final String COMPONENT_ELEMENT

See Also:

Constant Field Values

COMPONENT_UID_ATTR

static final String COMPONENT_UID_ATTR

See Also:

Constant Field Values

COMPONENT_NAME_ATTR

static final String COMPONENT_NAME_ATTR

See Also:

Constant Field Values

COMPONENT_SHORT_NAME_ATTR

static final String COMPONENT_SHORT_NAME_ATTR

See Also:

Constant Field Values

COMPONENT_VERSION_ATTR

static final String COMPONENT_VERSION_ATTR

See Also:

Constant Field Values

PRODUCT_ELEMENT

static final String PRODUCT_ELEMENT

See Also:

Constant Field Values

PRODUCT_UID_ATTR

static final String PRODUCT_UID_ATTR

See Also:

Constant Field Values

PRODUCT_NAME_ATTR

static final String PRODUCT_NAME_ATTR

See Also:

Constant Field Values

Constructor Detail

IAConstants

public IAConstants()

Method Detail

initFromWtProperties

public static void initFromWtProperties()
                                 throws IAException

Throws:

IAException

initFromWtProperties

public static void initFromWtProperties(File installer_cd_root,
                                        File installer_extraction_root)
                                 throws IAException

Throws:

IAException

initFromWindchillRootDir

public static void initFromWindchillRootDir(File windchill_root)
                                     throws IAException

Throws:

IAException

initFromWindchillRootDir

public static void initFromWindchillRootDir(File windchill_root,
                                            File installer_cd_root,
                                            File installer_extraction_root)
                                     throws IAException

Throws:

IAException

initFor3rdPartyProduct

public static void initFor3rdPartyProduct(File registry_dir)
                                   throws IAException

Throws:

IAException

initFor3rdPartyProduct

public static void initFor3rdPartyProduct(File registry_dir,
                                          File installer_cd_root,
                                          File installer_extraction_root)
                                   throws IAException

Throws:

IAException

getWindchillProductInstallationRegistryDir

public static File getWindchillProductInstallationRegistryDir(File product_root)

Returns:

non-null File

getStandardRegistryDirFromLoadPoint

public static File getStandardRegistryDirFromLoadPoint(File load_point)

Returns:

non-null File

inWindchillRoot

public static boolean inWindchillRoot()

treatAsR70WindchillInstallReg

public static boolean treatAsR70WindchillInstallReg()

ensureRegistryDirExists

public static void ensureRegistryDirExists()
                                    throws IAException

Throws:

IAException

initRegDirFromCodebase

private static void initRegDirFromCodebase(File codebase,
                                           File installer_cd_root,
                                           File installer_extraction_root)
                                    throws IAException

Throws:

IAException

reportOnInitialization

private static void reportOnInitialization(boolean init_from_codebase)

setRegistryDir

private static void setRegistryDir(File registry_dir)
                            throws IAException

Set registry directory as specified.

Throws:

IAException

getRegistryDir

static File getRegistryDir(boolean fail_if_doesnt_exist)
                    throws IAException

Determine the registry location by querying the wt.properties off of the classpath.

Throws:

IAException

getRegistryDir

static File getRegistryDir(boolean fail_if_doesnt_exist,
                           boolean use_treat_r70_when_set)
                    throws IAException

Determine the registry location by querying the wt.properties off of the classpath.

Throws:

IAException

doesRegistryDirExist

public static boolean doesRegistryDirExist()
                                    throws IAException

Throws:

IAException

doesRegistryDirExist

public static boolean doesRegistryDirExist(boolean use_treat_r70_when_set)
                                    throws IAException

Throws:

IAException

getRegistryMergeDir

static File getRegistryMergeDir()
                         throws IAException

Determine the registry merge directory.

Throws:

IAException

doesRegistryMergeDirExist

public static boolean doesRegistryMergeDirExist()
                                         throws IAException

Throws:

IAException

getSecondaryRegistryDir

static File getSecondaryRegistryDir(boolean fail_if_null)
                             throws IAException

Return the secondary registry location, if any.

Throws:

IAException

doesSecondaryRegistryDirExist

public static boolean doesSecondaryRegistryDirExist()
                                             throws IAException

Throws:

IAException

getInstalledAssembliesDirWinchillUrl

static String getInstalledAssembliesDirWinchillUrl()

getInstallationRegistryDirName

public static String getInstallationRegistryDirName()

getFileNameForIaFile

public static String getFileNameForIaFile(String assembly_id)

Standard method for computing prescribed file name for .ia files based on the assembly id.

getFileNameForLocFile

public static String getFileNameForLocFile(String locale_name)

Standard method for computing prescribed file name for .loc files based on the locale name.

getFileNameForTempPatchFile

public static String getFileNameForTempPatchFile(String temp_patch_name)

Standard method for computing prescribed file name for .tp files based on the temp patch name.

inAnInstaller

public static final boolean inAnInstaller()

Standard method for determining if this process is running within an installer.

setInstallersExtractionDir

private static final void setInstallersExtractionDir(File installer_extraction_root)
                                              throws IAException

When inside an installer some registry processes require access to the installer's Temp Extraction Root. May be set to null.

Throws:

IAException

getInstallersExtractionDir

public static final File getInstallersExtractionDir()
                                             throws IAException

When inside an installer some registry processes require access to the installer's Temp Extraction Root.

Returns:

The root location of the running installer, e.g. the directory where autorun.inf lives, may be null when outside an installer. When this is accessed in an installer context it must not be null, otherwise an exception will be thrown.

Throws:

IAException

setInstallerCdRoot

private static final void setInstallerCdRoot(File installer_cd_root)
                                      throws IAException

When inside an installer some registry processes require access to the installer's CD ROOT. May be set to null.

Parameters:

installer_cd_root - The root location of the running installer, e.g. the directory where autorun.inf normally lives

Throws:

IAException

getInstallersCdRoot

public static final File getInstallersCdRoot()
                                      throws IAException

When inside an installer some registry processes require access to the installer's CD ROOT.

Returns:

The root location of the running installer, e.g. the directory where autorun.inf lives, may be null when outside an installer. When this is accessed in an installer context it must not be null, otherwise an exception will be thrown.

Throws:

IAException

getInstallersInstallerDataDir

public static final File getInstallersInstallerDataDir()
                                                throws IAException

When inside an installer some registry processes require access to the installer's InstallerData directory.

Returns:

The location of the InstallerData directory in the running installer, may be null when outside an installer. When this is accessed in an installer context it must not be null, otherwise an exception will be thrown.

Throws:

IAException

getInstallersInstallerDataDir

public static final File getInstallersInstallerDataDir(File cd_root)
                                                throws IAException

When inside an installer some registry processes require access to the installer's InstallerData directory.

Parameters:

cd_root - The CD image root directory

Returns:

The location of the InstallerData directory in the running installer, may be null when outside an installer. When this is accessed in an installer context it must not be null, otherwise an exception will be thrown.

Throws:

IAException

setInstallRoot

public final void setInstallRoot(File install_root)
                          throws IAException

When inside an installer some registry processes require access to the install directory. When this is set it must exist, otherwise an exception will be thrown.

Returns:

The install location

Throws:

IAException

getInstallRoot

public static final File getInstallRoot()
                                 throws IAException

When inside an installer some registry processes require access to the install directory. When this is set it must exist, otherwise an exception will be thrown.

Returns:

The install location

Throws:

IAException