com.plumtree.portaluiinfrastructure.application
Class PTAppWarmUpHelper

java.lang.Object
  com.plumtree.portaluiinfrastructure.application.PTAppWarmUpHelper

All Implemented Interfaces:

IAppWarmUpHelper

public class PTAppWarmUpHelper
extends java.lang.Object
implements IAppWarmUpHelper

This class provides the portal specific jumpable initialization code so it can be separate from the servlet and .aspx code, as well as the base app initialization code.

Constructor Summary

PTAppWarmUpHelper()

Method Summary

ReturnValue	InitializeManagers(java.lang.String strLibHomePath, java.lang.String strBaseConfigDirectory) This method is used to initialize any additional managers.
ReturnValue	InitializeObjects(ConfigVarPack vpConfig, java.lang.String strApplicationName, java.lang.String strImageServerBaseURL, java.lang.String strSecureImageServerBaseURL, CachingManager cmCachingManager) This method is used to initialize miscellaneous objects.
ReturnValue	InitializeVarPacks(VarPackManager vpmVarPackManager, java.lang.String strSettingsConfigFolder, java.lang.String strPlatform) This method is used to load custom var packs.
ConfigVarPack	LoadConfigVarPack(java.lang.String strSettingsConfigFolder, java.lang.String strPlatform) This method loads a custom config var pack that will be used to initialize the rest of the application.
ReturnValue	LoadManagers(java.lang.String strLibHomePath, java.lang.String strBaseConfigDirectory) This method is used to initialize any additional managers.
ReturnValue	LoadObjects(ConfigVarPack vpConfig, java.lang.String strApplicationName, java.lang.String strImageServerBaseURL, java.lang.String strSecureImageServerBaseURL, CachingManager cmCachingManager) This method is used to initialize miscellaneous objects.
ReturnValue	LoadVarPacks(VarPackManager vpmVarPackManager, java.lang.String strSettingsConfigFolder, java.lang.String strPlatform) This method is used to load custom var packs.

Methods inherited from class java.lang.Object

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

Constructor Detail

PTAppWarmUpHelper

public PTAppWarmUpHelper()

Method Detail

LoadConfigVarPack

public ConfigVarPack LoadConfigVarPack(java.lang.String strSettingsConfigFolder,
                                       java.lang.String strPlatform)

Description copied from interface: IAppWarmUpHelper

This method loads a custom config var pack that will be used to initialize the rest of the application. To use the standard config var pack, simply return null from this method. In order for the config varpack to be recognized correctly by the application, it must use the following varpack ID: com.plumtree.uiinfrastructure.application.varpacks.ConfigVarPack.VARPACK_ID If the config var pack fails to load, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

LoadConfigVarPack in interface IAppWarmUpHelper

Returns:

ConfigVarPack the ConfigVarPack to use

See Also:

com.plumtree.portaluiinfrastructure.application.AAppWarmUpHelper#LoadConfigVarPacks(String, String)

InitializeVarPacks

public ReturnValue InitializeVarPacks(VarPackManager vpmVarPackManager,
                                      java.lang.String strSettingsConfigFolder,
                                      java.lang.String strPlatform)

Description copied from interface: IAppWarmUpHelper

This method is used to load custom var packs. This method will be called along with the other initialization methods. At this point, the base VarPacks and ResourceManager will have been loaded. The difference between this method and the LoadVarPacks method is that this method will only be called once, so put non-reloaded VarPacks here. Add varpacks to the varpack manager as follows: varPackManager.AddVariablePackage(vpConfig); If any of the var packs fail to load, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

InitializeVarPacks in interface IAppWarmUpHelper

LoadVarPacks

public ReturnValue LoadVarPacks(VarPackManager vpmVarPackManager,
                                java.lang.String strSettingsConfigFolder,
                                java.lang.String strPlatform)

Description copied from interface: IAppWarmUpHelper

This method is used to load custom var packs. The difference between this method and the Initialize VarPacks method is that by this point all of the non-customized initialization has been completed. Also, this method will be used to reload VarPacks. Add varpacks to the varpack manager as follows: varPackManager.AddVariablePackage(vpConfig); If any of the var packs fail to load, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

LoadVarPacks in interface IAppWarmUpHelper

InitializeObjects

public ReturnValue InitializeObjects(ConfigVarPack vpConfig,
                                     java.lang.String strApplicationName,
                                     java.lang.String strImageServerBaseURL,
                                     java.lang.String strSecureImageServerBaseURL,
                                     CachingManager cmCachingManager)

Description copied from interface: IAppWarmUpHelper

This method is used to initialize miscellaneous objects. This method will be called along with the other initialization methods. The difference between this method and the LoadObjects method is that this method will only be called once, so put non-reloadable objects here. Also, customized spaces will not be available yet. If any of the objects fail to initialize properly, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

InitializeObjects in interface IAppWarmUpHelper

See Also:

com.plumtree.portaluiinfrastructure.application.AAppWarmUpHelper#InitObjects(ConfigVarPack, String, String, String, CachingManager)

LoadObjects

public ReturnValue LoadObjects(ConfigVarPack vpConfig,
                               java.lang.String strApplicationName,
                               java.lang.String strImageServerBaseURL,
                               java.lang.String strSecureImageServerBaseURL,
                               CachingManager cmCachingManager)

Description copied from interface: IAppWarmUpHelper

This method is used to initialize miscellaneous objects. The difference between this method and the InitializeObjects method that by this point customized activity spaces will have been loaded. Also, this method can be used reload objects. If any of the objects fail to initialize properly, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

LoadObjects in interface IAppWarmUpHelper

See Also:

com.plumtree.portaluiinfrastructure.application.AAppWarmUpHelper#InitObjects(ConfigVarPack, String, String, String, CachingManager)

InitializeManagers

public ReturnValue InitializeManagers(java.lang.String strLibHomePath,
                                      java.lang.String strBaseConfigDirectory)

Description copied from interface: IAppWarmUpHelper

This method is used to initialize any additional managers. This method will be called along with the other initialization methods. The difference between this method and the LoadManagers method is that by this method occurs before customized code is loaded, and will only be run once. If any manager fails to initialize properly, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

InitializeManagers in interface IAppWarmUpHelper

LoadManagers

public ReturnValue LoadManagers(java.lang.String strLibHomePath,
                                java.lang.String strBaseConfigDirectory)

Description copied from interface: IAppWarmUpHelper

This method is used to initialize any additional managers. The difference between this method and the InitializeManagers method is that by this point customized activity spaces will have been loaded. Also, this method can be used to reload managers. If any manager fails to initialize properly, throw an XPException. This will cause the App WarmUp to fail and disable the portal.

Specified by:

LoadManagers in interface IAppWarmUpHelper