Uiinfrastructure API Docs  
 

AppWarmUp Members

AppWarmUp overview

Public Static Fields

APP_KEY_NUM_CUSTOM_VARPACKS This counter is used in the diagnostic page.
FILE_ACTIVITY_SPACES_XML 
FILE_CUSTOM_ACTIVITY_SPACES_XML 
FILE_CUSTOM_VAR_PACKS_XML 
FILE_PORTAL_CONFIG_XML 
FILE_SERVER_CONFIG_XML 
FILE_VAR_PACKS_XML 
FOLDER_COMMON 
FOLDER_DYNAMIC_LOADS 
FOLDER_I18N 
FOLDER_PORTAL 
FOLDER_SETTINGS 
KEY_APP_WARMUP_HELPER 
KEY_BASE_CONFIG_VARPACK 
KEY_CACHEMAN_CLASS_TYPE_MANAGER 
KEY_CACHEMAN_IMAGE_SERVER_HELPER 
KEY_CACHEMAN_JS_REGISTRY 
KEY_CACHEMAN_RESOURCE_MANAGER 
KEY_CACHEMAN_SECURE_JS_REGISTRY 
KEY_FILE_ACTIVITY_SPACES 
KEY_FILE_CUSTOM_ACTIVITY_SPACES 
KEY_FILE_CUSTOM_VAR_PACKS 
KEY_FILE_VAR_PACKS 
KEY_PATH_LIB_HOME 
KEY_PATH_PORTAL_CONFIG 
KEY_PATH_PORTAL_DYNAMIC_LOADS 
KEY_PATH_PORTAL_HOME 
KEY_PATH_PORTAL_I18N 
KEY_PATH_PORTAL_SETTINGS 
KEY_PATH_WEB_HOME 
KEY_STR_APPLICATION_NAME 
KEY_STR_DEV_KIT_VERSION 
KEY_STR_IMAGESERVER_BASE_URL 
KEY_STR_IMAGESERVER_CONNECTION_URL 
KEY_STR_PLATFORM 
KEY_STR_SECURE_IMAGESERVER_BASE_URL 
m_configContext 
m_portalComponent 
PARAM_APPWARMUPHELPER_LIBFILE 
PARAM_APPWARMUPHELPER_NAME 
PARAM_PTHOME_ENVVAR_NAME 
PARAM_PTHOME_PRODUCT_NAME 
PATH_SEPARATOR 
s_htInitSettings Hashtable that stores all of the settings gathered from initialization. It is static because we need it to be updateable by all the static methods of this class. It was private to prevent tampering of the data, but is now public to allow unit testing.
STR_SUPPORTED_DOTNET_SDK 
STR_SUPPORTED_JAVA_JDK_1 
STR_SUPPORTED_JAVA_JDK_2 
STR_SUPPORTED_JAVA_JDK_3 
SUFFIX_WAR_FILE 
SUFFIX_XML_FILE 

Public Static Methods

GenerateFailureErrorReport Handle exception in startup, and general failure messages. Also handles really intensely bad errors like path missing, jars missing, dlls missing and so forth. This is for XPExceptions and Throwables caught by the standard runner.
GetOKConfigContext Get the OpenConfig context for use by OpenKernel services.
GetSettingValue Helper to return the setting value from the settings hashtable.
GetSettingValueAsString Helper to return the setting value from the settings hashtable.
getStartupNotificationErrorLogs Gets the error report from the startup noitication service, Identical to the information generated by the diagnostic tool.
getStartupNotificationErrorReport Gets the error report from the startup noitication service, Identical to the information generated by the diagnostic tool.
HelperDeterminePaths Helper that determines some of the more complex paths. The WebHome and LibHome paths are constructed here.
HelperLoadVarPacks Helper that loads VarPacks from a config file.
HelperTestLanguages Helper that tests our language files.
Init This is the main method used to initialize the Portal Application. There are three steps to getting the Portal up and running. First, we perform any preinitialization checks. If the checks succeed, we initialize our Portal. When initialization is complete, we finally load any customized objects that we have. The difference between the initialization and loading steps is that the loading steps can be invoked again for reloading purposes. The initializations steps are not designed to be rerun.
LoopStartupTasks Actual executor for the startup tasks; handles the concept of "preflight", which the progress indicator uses to estimate the number of tasks and task-steps to run for an accurate representation of true progress. This *is* the new application warmup. Each warmup step is managed through this looping mechanism.
RunStartupTasks Execute the startup tasks defined in PTStartupTasks. Note that the handling of each return value is delegated to the notification factory. The default handling is to continue until a fatal error is encountered.
setNotification This is the first method any tool should call that wants to know if startup is successful. It sets a callback class used by the startup for notification. Calling this is optional.
setStartupNotificationErrorLogs Gets the error report from the startup noitication service, Identical to the information generated by the diagnostic tool.

Public Instance Constructors

AppWarmUp Constructor Initializes a new instance of the AppWarmUp class.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

AppWarmUp Class | com.plumtree.uiinfrastructure.application Namespace