HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.runtime
Class RuntimeFunctions

java.lang.Object
  extended by com.ibm.hats.runtime.RuntimeFunctions
All Implemented Interfaces:
com.ibm.hats.common.CommonConstants, com.ibm.hats.common.connmgr.ConnMgrConstants, com.ibm.hats.runtime.RuntimeConstants, com.ibm.hats.util.HatsConstants, com.ibm.hats.util.HatsCopyright, com.ibm.hats.util.RasConstants, com.ibm.logging.IRecordType

public class RuntimeFunctions
extends Object
implements com.ibm.hats.util.HatsConstants, com.ibm.hats.common.CommonConstants, com.ibm.hats.runtime.RuntimeConstants

HATS Runtime Utility Methods


Field Summary
 
Fields inherited from interface com.ibm.hats.util.HatsConstants
HATS_INSTANCE_NAME, HatsConstantsC, KEY_SCAFFOLDING_FLAG, NULL_TYPE, RCP_TYPE, RTE_RUNNING, RTE_SHUTTING_DOWN, RTE_STOPPED, SCAFFOLDING_OFF, SCAFFOLDING_ON, SCAFFOLDING_UNKNOWN, SKEY_USER_LOCALE, SYSPROP_INSTALL_DIR, WEB_TYPE
 
Fields inherited from interface com.ibm.hats.util.RasConstants
CKEY_ADMIN_PORTNUM, CKEY_APPLET_SERVER_SOCKET_BACKLOG, CKEY_COMP_MASK_PREFIX, CKEY_COMP_PREFIX, CKEY_CONFIG_DIRECTORY, CKEY_HATS_INSTANCE_NAME, CKEY_HOD_DISPLAY_TERMINAL, CKEY_HOD_MACRO_TRACING_LEVEL, CKEY_HOD_PS_TRACING_LEVEL, CKEY_HOD_SESSION_TRACING_LEVEL, CKEY_HOD_SUPPORT_TRACING, CKEY_HOD_TRACING_PREFIX, CKEY_HOD_TRANSPORT_TRACING_LEVEL, CKEY_HOD_USER_MACRO_TRACING, CKEY_IO_PATTERN, CKEY_LAST_CHECKED_CONFIG, CKEY_LICENSE_HARD_LIMIT, CKEY_LICENSE_TRACKING, CKEY_LICFILE, CKEY_LOG_DIRECTORY, CKEY_LOGFILE, CKEY_LOGMASK, CKEY_MAX_HOD_EVENT_THREADS, CKEY_MAX_HOD_THREAD_MANAGER_THREADS, CKEY_MAX_LOGFILES, CKEY_MAX_SIMULATIONFILES, CKEY_MAX_SIZE_LOGFILE, CKEY_MAX_SIZE_TRACEFILE, CKEY_MAX_TRACEFILES, CKEY_NUM_LICENSES, CKEY_RECORD_SIMULATION_TRACE, CKEY_SERVLET_CONTEXT_NAME, CKEY_SERVLET_REAL_PATH, CKEY_SIMULATOR_END_PORT, CKEY_SIMULATOR_START_PORT, CKEY_TRACEFILE, CKEY_TRACELOG_DIRECTORY, COMP_ACTION, COMP_ACTION_KEY, COMP_ALL, COMP_ALL_KEY, COMP_APPLET, COMP_APPLET_KEY, COMP_COMPONENT, COMP_COMPONENT_KEY, COMP_HOD, COMP_HOD_COMMEVENT, COMP_HOD_COMMEVENT_KEY, COMP_HOD_DISPLAYTERMINAL, COMP_HOD_DISPLAYTERMINAL_KEY, COMP_HOD_DS, COMP_HOD_DS_KEY, COMP_HOD_KEY, COMP_HOD_MACRO, COMP_HOD_MACRO_KEY, COMP_HOD_OIAEVENT, COMP_HOD_OIAEVENT_KEY, COMP_HOD_PS, COMP_HOD_PS_KEY, COMP_HOD_PSEVENT, COMP_HOD_PSEVENT_KEY, COMP_HOD_SESSION, COMP_HOD_SESSION_KEY, COMP_HOD_TRANSPORT, COMP_HOD_TRANSPORT_KEY, COMP_HOD_USERMACRO, COMP_HOD_USERMACRO_KEY, COMP_IO, COMP_IO_KEY, COMP_RUNTIME, COMP_RUNTIME_KEY, COMP_SIMULATION_KEY, COMP_TRANSFORM, COMP_TRANSFORM_KEY, COMP_UTILITY, COMP_UTILITY_KEY, COMP_WIDGET, COMP_WIDGET_KEY, CONFIG_CHECK_INTERVAL, DEFAULT_ADMIN_PORTNUM, DEFAULT_LIC_FILE_NUMBER, DEFAULT_LIC_FILE_SIZE, DEFAULT_LOG_FILE_NUMBER, DEFAULT_LOG_FILE_SIZE, DEFAULT_SIMULATION_FILE_NUMBER, DEFAULT_SIMULATION_RECORDING_STATE, DEFAULT_SIMULATOR_END_PORT, DEFAULT_SIMULATOR_START_PORT, DEFAULT_TRACE_FILE_NUMBER, DEFAULT_TRACE_FILE_SIZE, DEFAULT_TRACE_MASK, enableTracing, Err, HOD_MACRO_TRACER_LEVEL_1, HOD_MACRO_TRACER_LEVEL_2, HOD_TRACE_MAXIMUM, HOD_TRACE_MINIMUM, HOD_TRACE_NONE, HOD_TRACE_NORMAL, hodPrefix, Info, LICENSE_FILE_NAME, LOG_FILENAME, LOG_TYPE_ERROR, LOG_TYPE_INFO, LOG_TYPE_WARNING, NUM_TRACE_MASKS, RAS_CALLED_CLASS, RAS_CALLED_METHOD, RAS_CALLING_CLASS, RAS_CALLING_METHOD, RasConstantsC, RUNTIME_DEBUG_PROPERTIES_FILENAME, RUNTIME_DEBUG_PROPERTIES_SHORTNAME, RUNTIME_PROPERTIES_FILENAME, RUNTIME_PROPERTIES_SHORTNAME, Sev, specialKeyPrefix, SYS_PROP_OS_NAME, SYS_PROP_OVERRIDE_OS_NAME, SYS_PROP_RUNTIME_PROPERTIES, TRACE_FILENAME, TRACE_LEVEL_NONE, TRACE_LEVEL_NOT_SPECIFIED, TRACE_MASK_NONE, Warn
 
Fields inherited from interface com.ibm.logging.IRecordType
TYPE_ALL, TYPE_API, TYPE_CALLBACK, TYPE_DEBUG_MAX, TYPE_DEBUG_MID, TYPE_DEBUG_MIN, TYPE_DEFAULT_MESSAGE, TYPE_DEFAULT_TRACE, TYPE_ENTRY, TYPE_ENTRY_EXIT, TYPE_ERR, TYPE_ERROR, TYPE_ERROR_EXC, TYPE_EXIT, TYPE_FATAL, TYPE_INFO, TYPE_INFORMATION, TYPE_LEVEL1, TYPE_LEVEL2, TYPE_LEVEL3, TYPE_MISC_DATA, TYPE_NONE, TYPE_OBJ_CREATE, TYPE_OBJ_DELETE, TYPE_PERF, TYPE_PRIVATE, TYPE_PUBLIC, TYPE_STATIC, TYPE_SVC, TYPE_WARN, TYPE_WARNING
 
Fields inherited from interface com.ibm.hats.common.connmgr.ConnMgrConstants
ADMIN_EJB_INSTANCE, ADMIN_PARAM_ADMIN_JNDINAME, ADMIN_PARAM_APPLICATIONS_DIR, ADMIN_PARAM_APPMANIFESTS_DIR, ADMIN_PARAM_BEANS_DIR, ADMIN_PARAM_COMMON_DIR, ADMIN_PARAM_DOCUMENTS_DIR, ADMIN_PARAM_INSTALL_DIR, ADMIN_PARAM_LICENSE_HARD_LIMIT, ADMIN_PARAM_LOG_DIR, ADMIN_PARAM_NUM_LICENSES, ADMIN_PARAM_POOLSPECS_DIR, ADMIN_PARAM_PRODUCTION_DIR, ADMIN_PARAM_RMIREG_PORTNUM, ADMIN_PARAM_RTE_DIR, ADMIN_PARAM_RTE_JNDINAME, ADMIN_PARAM_RTE_LIB_DIR, ADMIN_PARAM_SERVER_DIR, ADMIN_PARAM_SHARED_DIR, ADMIN_PARAM_STAGING_DIR, ADMIN_RMIREG_PORTNUM_DEFAULT, ADMINRTE_SLEEP_TIME, ADMINRTE_TIMEOUT, APP_UNREMOVABLE, BASE_EJB_INSTANCE, BUFFER_SIZE, BUILD_LEVEL_IDX, BUILD_RLSE_IDX, BUILD_VER_IDX, connspecExtension, DEFAULT_APPSERVER_NAME, DEFAULT_POOLMGR_CLASSNAME, DRTE_EJB_LOCK_REBIND_HOLDTIME, DRTE_EJB_LOCK_TIMEOUT, DRTE_EJB_TIMEOUT, DRTE_SLEEP_TIME, enableTracing, Err, HARD_SHUTDOWN, HARD_TEARDOWN, HOST_LIST_FILE_NAME, HP_ADMIN_JNDINAME, HP_RTE_JNDINAME, HPADMINEJB_REFERENCE, Info, IWA_PKG, KEY_DIGEST_DIGEST_FILENAME, KEY_NON_WEBCONN, KEY_ORIGINAL_FILENAME, KEY_POOLMGR_CLASSNAME, KEY_WEBADMINCLIENT, KEY_WEBCONN, KEYRINGPW, LICENSE_COUNT_SAMPLE_SIZE, LOCALHOST_NAME_SPACE_PROVIDER, logonspecExtension, MAINTAIN_MIN_CONNS, manifestExtension, MAX_NUM_ADMIN_WORKER_THREADS, MAX_NUM_POLL_WORKER_THREADS, MAX_VALID_PORT_NUM, MESSAGE_FILE_NAME, NAME_SPACE_PROVIDER_PREFIX, NONDRTE_EJB_INSTANCE, NUM_ADMIN_WORKER_THREADS, PKCS12_FILENAME, poolspecExtension, PROFILENAMEKEY, PROPERTY_FILENAME, PS_CONNECT_TIMEOUT, PS_CONNS_PER_THREAD, PS_CONNS_VECTOR_CAPACITY, PS_CONNS_VECTOR_INCREMENT, PS_INITIAL_CONNECTIONS, PS_MAX_BUSYTIME, PS_MAX_CONNECTIONS, PS_MAX_IDLETIME, PS_MAX_WORKER_THREADS, PS_MEASUREMENTS, PS_MEASUREMENTS_INTERVAL, PS_MIN_CONNECT_TIMEOUT, PS_MIN_CONNECTIONS, PS_MIN_MAX_BUSYTIME, PS_MIN_MAX_IDLETIME, PS_NEVER, PS_OVERFLOW_ALLOWED, PS_POOLING_ENABLED, PS_RECOVERY_TIME, RAS_PROPERTIES_FILENAME, RECOVER_CONNS, RTE_VERSION, RUNTIME_PARAM_HPAPPLEJB_HANDLE, RUNTIME_PARAM_HPAPPLEJB_HOME, SERVER_PROPERTIES_FILENAME, Sev, SHUTDOWN_CONNS, SHUTDOWN_DISCONNECT_TIMEOUT, SOFT_SHUTDOWN, SOFT_TEARDOWN, SR_SEPARATOR_CHAR, STASHKEYRINGPW, STASHUSERLISTPW, SYS_PROP_FOR_APPSERVER_NAME, SYS_PROP_FOR_CA400, SYS_PROP_FOR_INSTALL_DIR, SYS_PROP_FOR_JVM_ADMINISTRATION, SYS_PROP_FOR_JVM_SUFFIX, SYS_PROP_FOR_JVM_ZOSADMIN, SYS_PROP_FOR_ZOSADMIN_DRTE, SYS_PROP_FOR_ZOSLOGGING, TS_SEPARATOR_CHAR, USERLISTPW, userpoolExtension, Warn, ZOS_EJB_INSTANCE
 
Fields inherited from interface com.ibm.hats.common.CommonConstants
_ERROREVENT, _STOPEVENT, ADMIN_MSGS_COMPONENT, APPLICATION_EVENT_FOLDER, APPLICATION_FILENAME, ASI_ATTRIBUTE, BMS_MAP_FILE_EXTENSION, BMS_SOURCE_FILE_EXTENSION, CAPTURED_SCREEN_FILE_EXTENSION, CAPTURED_SCREEN_FOLDER, CLASS_FOLDER, CLASSNAME_APPLICATION, CLASSNAME_APPLICATIONSPECIFICINFO, CLASSNAME_CLIENTSPECIFICINFO, CLASSNAME_CONNSPEC, CLASSNAME_REQUEST, CLASSNAME_RESPONSE, COMMON_FOLDER, COMMON_IMAGE_FOLDER, COMMON_IMAGE_FOLDER_LENGTH, COMMON_PROPERTIES_CLASS, COMMON_STYLESHEET_FOLDER, COMPONENT_WIDGET_PROPERTIES_CLASS, CONFIG_MSGS_COMPONENT, CONNECTION_FILE_EXTENSION, CONNECTION_FOLDER, CONNECTIONNAME, CONTEXT_ATTR_IN_PORTAL, CONTEXT_ATTR_IN_RCP, CONTEXT_ATTR_RCP_PRINT_JOB_LOCATION, DEFAULT_ACCESS_SERVLET_NAME, DEFAULT_CONNECTION_PARAMETER_OVERRIDES_SETTING, DEFAULT_DELAY_INTERVAL, DEFAULT_DELAY_START, DEFAULT_GV_OVERRIDES_SETTING, DEFAULT_TEMPLATE, DEFAULT_TN_PORT, DEFAULT_WF_PORT, EVENT_FILE_EXTENSION, EVENT_FOLDER, FILENAMESPACESEPARATOR, FORM_AUTOPUSH, FORM_CARETPOS, FORM_COMMAND, FORM_CURSORPOSITION, FORM_FORMNAME, FORM_IMMEDIACY, FORM_KEYBOARDTOGGLE, FORM_PAGE_UID, FORM_PERFTIMESTAMP, FORM_SESSIONID, FORM_SESSIONNUMBER, FRAGMENT_FOLDER, HATS_CURREVENT_DESC, HATS_ERROR_PAGE_MSGS, HATS_EVENT, HATS_EXISTING_CONN, HOD_CONST_24X132, HOD_CONST_24X80, HOD_CONST_27X132, HOD_CONST_32X80, HOD_CONST_43X80, HOST_SIMULATION_FILE_EXTENSION, HOST_SIMULATION_FOLDER, HPUB_LINK_KEY, INFINITE_LICENSES, IO_JSP_FOLDER, JAVA_SOURCE_FILE_EXTENSION, JSF_FOLDER, KEY_CONTINUOUS_132_COLUMNS, KEY_CONTINUOUS_80_COLUMNS, KEY_EXECUTIVE, KEY_HATS_ClientFolderPath, KEY_ISO_A3, KEY_ISO_A4, KEY_ISO_A5, KEY_ISO_B4, KEY_ISO_B5, KEY_ISO_C5, KEY_ISO_DESIGNATED_LONG, KEY_JIS_B4, KEY_JIS_B5, KEY_LEDGER, KEY_MONARCH_ENVELOPE, KEY_NA_LEGAL, KEY_NA_LETTER, KEY_NA_NUMBER_10_ENVELOPE, KEY_NA_NUMBER_9_ENVELOPE, KEY_PDF_FONT_COURIER, KEY_PDF_FONT_COURIERNEWPSMT, KEY_PDF_FONT_COURIERTHAI, KEY_PDF_FONT_CUMBERLAND, KEY_PDF_FONT_HYSMYEONGJOSTD, KEY_PDF_FONT_KOZMINPRO, KEY_PDF_FONT_LUCIDACONSOLE, KEY_PDF_FONT_MSUNGSTD, KEY_PDF_FONT_NARKISS_TAM, KEY_PDF_FONT_NARKISSIM, KEY_PDF_FONT_SHALOM, KEY_PDF_FONT_STSONGSTD, KEY_PDF_FONT_TYPING_ARABIC, KEY_PDF_ORIENTATION_LANDSCAPE, KEY_PDF_ORIENTATION_PORTRAIT, KEYPAD_BUTTON_SIZE, KEYPAD_BUTTONS, KEYPAD_DROPDOWN, KEYPAD_HORIZONTAL, KEYPAD_ICONS, KEYPAD_LINKS, KEYPAD_SHOW, KEYPAD_STYLE, KEYPAD_VERTICAL, LIB_FOLDER, LICENSE_TYPE_PROCESSOR, LICENSE_TYPE_TIER, LICENSE_TYPE_USER, MACRO_FILE_EXTENSION, MACRO_FOLDER, MACRO_HANDLER_FILE_EXTENSION, MACRO_HANDLER_FOLDER, MACRO_INFO_FILE_EXTENSION, PARAM_NO_CHAINING, PARAM_NO_CONNECTION, PB_ACTION, PB_ACTION_RECEIVE, PB_ACTION_SEND, PORTLET_ACTION_POST, PROFILE_FOLDER, PROP_LICENSE_TYPE, REQ_ATTR_STEAL_FOCUS, REQ_DELETE_PRINT_URI, REQ_EDIT_MODE_URI, REQ_FORM_ID, REQ_FROM_PORTLET_ACTION, REQ_IN_PORTAL, REQ_IN_PORTLET_ACTION, REQ_IS_JSR168, REQ_IS_JSR286, REQ_PAGE_UID, REQ_PORTLET_ACTION, REQ_RESUME_APPLICATION_URI, REQ_SUBMIT_URI, REQ_TEMPLATE_REDIRECT, REQ_TRANSFORM_REDIRECT, REQ_TRANSFORMINFO, REQ_URL_REDIRECT, REQ_VIEW_PRINT_URI, RESOURCE_NAME_SEPARATOR, RESOURCE_UPDATE_FILE, REST_MAPPING_FILENAME, SCREEN_COMBINATION_EVENT_FOLDER, SCREEN_RECOGNIZE_EVENT_FOLDER, SESSION_EVENT_FOLDER, SESSION_TYPE_3270E_STR, SESSION_TYPE_5250WF_STR, SESSION_TYPE_VT100_STR, SESSION_TYPE_VT420_7_STR, SESSION_TYPE_VT420_8_STR, SESSION_TYPE_VT52_STR, SETTING_KEY_KEY_SEPARATOR, SETTING_KEY_KEY_SEPARATOR_AS_CHARACTER, SETTING_KEY_TEMPORARY_REPLACED_STRING, SETTING_KEY_VALUE_SEPARATOR, SOURCE_FOLDER, SRC_FOLDER, STOP_LAST_ACTION, STRUTS_FOLDER, SUGGESTED_NAME_LENGTH, TEMPLATE_FILE_EXTENSION, TEMPLATE_FOLDER, TLD_FOLDER, TRANSFORMATION_FILE_EXTENSION, TRANSFORMATION_FOLDER, WEB_INF_FOLDER, WSDL_FILE_EXTENSION, WSDL_FOLDER
 
Fields inherited from interface com.ibm.hats.runtime.RuntimeConstants
_BLANKSCREENEVENT, _CONNECTEVENT, _DISCONNECTEVENT, _ERROREVENT, _EVENTCOMPLETE, _EVENTINCOMPLETE, _EVENTNOTSTARTED, _MACROERROREVENT, _NOMOREEVENT, _SCREENRECOEVENT, _STARTEVENT, _STOPEVENT, _TIMEOUTEVENT, _UNMATCHEDSCREENEVENT, ACTIONNOTSTARTED, ACTIONSNOTSTARTED, ALLOW_START_WITH_COMMAND, BLANKSCREENEVENT, CLASSNAME_HOSTCONNECTION, CLASSNAME_SESSION, CMD_CONTINUE, CMD_DEFAULT, CMD_DEFAULTCMDREPLACMENT, CMD_DISCONNECT, CMD_NULL, CMD_REFRESH, CMD_REVERSE, CMD_TOGGLE, COMMANDIMMEDIACYSTRING, CONNECTEVENT, CONST_FALSE, CONST_TRUE, DEFAULTKEYBOARDTOGGLEVALUE, DISCONNECT_TRANSFORM, DISCONNECTEVENT, DOGET_AUTOCONNECT, DOGET_AUTORECONNECT, DOGET_CODEPAGE, DOGET_DELAYINTERVAL, DOGET_DELAYSTART, DOGET_HISTORY, DOGET_HOST, DOGET_HOSTTYPE, DOGET_OTHER, DOGET_PASSWORD, DOGET_PORT, DOGET_SIZE, DOGET_SSL, DOGET_SSL_SERVER_AUTH, DOGET_USERNAME, ERROR_BAD_ADDRESS, ERROR_EXPORTING, ERROR_GENERIC_TITLE, ERROR_LOADING_FILE, ERROR_SAVING_FILE, ERROREVENT, EVENTCOMPLETE, EVENTINCOMPLETE, EVENTNOTSTARTED, FIRSTACTION, FLAG_BAD_LOGIN, FLAG_TIMED_OUT, FORWARDTOURL_COMPLETION_SENDKEY, FUNCTION_LOGIN, FUNCTION_LOGOUT, FUNCTION_SET_LANGUAGE, HODPARAMSTARTCHAR, ID_GVNAME_ID, ID_NAME_ENPTUI_ID, ID_NAME_ID, ID_NAME_SEPARATOR, ID_SGVNAME_ID, LANGUAGE_COOKIE_LIFE, LANGUAGE_COOKIE_NAME, MACRO_COMPLETION_SENDKEY, MACROERROREVENT, NOMOREEVENT, NULLVAL, OVERRIDE_PARAMS_STORAGE, PAGE_ERROR, PAGE_LANGUAGE, PAGE_LOGIN, PARAM_ACTIVE, PARAM_AS400_MACHINE, PARAM_AUTHENTICATOR, PARAM_ERROR_MESSAGE, PARAM_ERROR_MESSAGE_TITLE, PARAM_FLUSH, PARAM_FUNCTION, PARAM_IS_AUTHENTICATED_USER, PARAM_LANGUAGE, PARAM_LOGIN_DATE, PARAM_NEXT_PAGE, PARAM_NEXT_STEP, PARAM_OPERATION, PARAM_PASSWORD, PARAM_PROXY_URL, PARAM_RAS_INITIALIZED, PARAM_REQUIRED_PRODUCT_CHECK_PERFORMED, PARAM_REQUIRED_PRODUCT_INSTALLED, PARAM_RESOURCE_LOADER, PARAM_RETURN_PAGE, PARAM_RETURN_PAGE_DESC, PARAM_SERVLET, PARAM_SERVLET_CONTEXT_INIT, PARAM_SESSION_ID, PARAM_SHOW_STUDIO_RUNTIME_MESSAGES, PARAM_SKIP_PRODUCT_LICENSE_CHECK, PARAM_SUCCESS, PARAM_USER_LANGUAGE, PARAM_USER_LOCALE, PARAM_USER_NAME, PARAM_WIZARD_USER, PARAM_WIZARD_USERS, PARAM_WRITE_FAILURE, PLAY_MACRO_CMD_PREFIX, PREF_CONNECTION_PARAM_ENABLED, PREF_CONNECTION_PARAM_NAME, PREF_CONNECTION_PARAM_VALUE, PREF_VARIABLE_ENABLED, PREF_VARIABLE_NAME, PREF_VARIABLE_SHARED, PREF_VARIABLE_VALUE, PRINT_JOB_PAGE, PROFILE_FOLDER, PROPERTY_APPLICATION, REQ_PRINT_RESOURCE, REQ_PRINT_URL, RESOURCE_NAME, RESOURCE_PATH, SAVE_LUNAME_TO_PREF, SAVE_WORKSTATION_ID_TO_PREF, SCREENRECOEVENT, SENDKEY_COMPLETION_SENDKEY, SESSION_STOP_BUTTON, SESSION_STOP_ERROR, SESSION_STOP_KEY, SIZE_CONST_24X132, SIZE_CONST_24X80, SIZE_CONST_27X132, SIZE_CONST_32X80, SIZE_CONST_43X80, STARTEVENT, STOPEVENT, SUCCESS_EXPORT, SUCCESS_HAP_SAVE, SUCCESS_TEMPLATE_SAVE, TIMEOUTEVENT, TRANSFORM_DEFAULT, UNMATCHEDSCREENEVENT, USER_NAME_COOKIE_LIFE, USER_NAME_COOKIE_NAME
 
Constructor Summary
RuntimeFunctions()
           
 
Method Summary
static String acquireExistingTransformationConnection(javax.servlet.http.HttpServletRequest request)
          Allow a middle-in-chain Integration Object access to the transformation connection.
static void releaseExistingTransformationConnection(javax.servlet.http.HttpServletRequest request)
          This static method relinquishes control of the application associated with the transformation connection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RuntimeFunctions

public RuntimeFunctions()
Method Detail

acquireExistingTransformationConnection

public static final String acquireExistingTransformationConnection(javax.servlet.http.HttpServletRequest request)
                                                            throws com.ibm.hats.runtime.HostConnectionException,
                                                                   com.ibm.hats.runtime.ApplicationUnavailableException
Allow a middle-in-chain Integration Object access to the transformation connection.

The purpose of this method is twofold:

The caller uses the returned label to call the setHPubStartChainName() method of the Integration Object. This label will be used by the Integration Object to locate the connection against which to run. If a null label is returned, the the connection is not accessible to the Integration Object.

To prevent the Integration Object form destroying the transformation connection when an error is encountered, call the setHPubSaveConnOnError(true) method prior to invoking doHPTransaction() to run the Integration Object.

Parameters:
request - HttpServletRequest object
Throws:
com.ibm.hats.runtime.connmgr.HostConnectionException - Application instance exists, but there is no transformation connection
ApplicationUnavailableException - No application exists or, if it does, it is currently checked out
com.ibm.hats.runtime.HostConnectionException

releaseExistingTransformationConnection

public static final void releaseExistingTransformationConnection(javax.servlet.http.HttpServletRequest request)
This static method relinquishes control of the application associated with the transformation connection.

The purpose of this method is to check in the application so that it can be used through the HATS entryServlet or by other Integration Object chains.

The caller should invoke this method after all Integration Objects in the Integration Object chain have run. This method call should be used to make the transformation connection available again even if the Integration Object encounters an error while running. This call signifies that the Integration Object chain no longer needs access to the transformation connection.

Parameters:
request - HttpServletRequest object

HATS 7.5.1 (201005110649)