Maximo 7.6.1.2 API - WebClientSession

java.lang.Object
- psdi.webclient.system.session.WebClientSession

All Implemented Interfaces:: java.util.EventListener, javax.servlet.http.HttpSessionBindingListener

public class WebClientSession
extends java.lang.Object
implements javax.servlet.http.HttpSessionBindingListener

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class WebClientSession.Alignment

static class WebClientSession.RequestType

Nested Classes
Modifier and Type	Class and Description
`class`	`WebClientSession.Alignment`
`static class`	`WebClientSession.RequestType`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AGENT_CHROME`
`static int`	`AGENT_FIREFOX`
`static int`	`AGENT_IE`
`static int`	`AGENT_OPERA`
`static int`	`AGENT_SAFARI`
`static java.lang.String`	`DISPLAYMETHOD_MSGBOX`
`static java.lang.String`	`DISPLAYMETHOD_STATUS`
`static int`	`LEFTNAV_CLOSE`
`static int`	`LEFTNAV_INHERIT`
`static int`	`LEFTNAV_OPEN`
`static int`	`MSG_BTNCANCEL`
`static int`	`MSG_BTNCLOSE`
`static int`	`MSG_BTNNO`
`static int`	`MSG_BTNOK`
`static int`	`MSG_BTNYES`
`static java.lang.String`	`REQUESTTYPE`
`static java.lang.String`	`SAVEMODE_ONLOAD`
`static java.lang.String`	`SAVEMODE_ONLOADUNLOAD`
`static java.lang.String`	`SAVEMODE_ONUNLOAD`
`SessionServiceability`	`serviceability`
`static java.lang.String`	`TEMP_TOKEN_PARAM`

Constructor Summary

Constructors
Constructor and Description
`WebClientSession(javax.servlet.http.HttpSession httpSession)` Deprecated. WebClientSessions should be created via the WebClientSessionFactory createSession method.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`org.w3c.dom.Element`	`addMoreinfoButton(org.w3c.dom.Element dialogElement, java.lang.String value)` Add field help more information button
`boolean`	`addMXWarnings(MXException[] warnings)` Adds warnings to the app-persisted warnings stack.
`void`	`addWarning(MXException e)`
`void`	`addWarnings(java.util.List<MXException> warningList)` Adds warnings to the app-persisted warnings stack.
`void`	`applySkin()`
`java.lang.String`	`attachUOM(java.lang.String size)`
`boolean`	`canPerformApplink()` Can applink happen? Used to avoid loading a new app instance on browser refresh (F5).
`boolean`	`canUseStaticIds()` Returns true if UI should use static mxids rather than sequence based sceheme
`boolean`	`checkForDialogAccess(java.lang.String dialogId, org.w3c.dom.Element dialog)`
`static void`	`checkResults(DataBean results, WebClientSession clientSession, AppInstance app)` Check to see if we got back a single result, or not if no result, popup a message "norecord" if single result, go to main tab if multiple results, go to list tab
`void`	`cleanup()`
`void`	`clearAllTracking()` Clearing all the performance data
`void`	`clearModuleMap()` Forces moduleMap to be retrieved with new entries
`void`	`clearPerformanceDataHASH(java.lang.String appname)` Clearing performance data for selected application
`void`	`clearPortletCacheOnKPIChange(java.lang.String kpiName)` Clears cache for a portlet where the key of the cache matches.
`void`	`clearPortletCacheOnReportChange(java.lang.String reportId)` Clears cache for a report portlet which has the report
`void`	`clearPortletCacheSelectively(java.lang.String prefix)` Clears cache for a portlet where the key of the cache matches.
`void`	`clearStack()` Removes all apps form the app stack.
`void`	`clearStartCenterCache(java.lang.String key)` Clears cahce for he given key
`void`	`clearUserInput()`
`MXSession`	`createMXSession()`
`ControlInstance`	`findControl(java.lang.String controlId)` Looks for a control instance: checks one by one if the id is that of: the application instance of the current page of any control on the current page in the library NOT IMPLEMENTED - in a menu (is this necessary any longer) NOT IMPLEMENTED - in the report library
`PageInstance`	`findDialog(java.lang.String dialogId)` Returns the dialog control instance with the supplied id if it exists.
`ControlInstance`	`findDialogInDesignerApps(java.lang.String dialogId)` Returns the dialog control instance with the supplied id if it exists for App Designer.
`void`	`finishLongOpEvent()`
`java.lang.String`	`fixRowForTableDetails(java.lang.String compId)` When updating tabledetails and changing row during setvalue, the value could get applied to the wrong row.
`void`	`forceMessagesToMainPage(boolean forceMain)`
`void`	`generateMessageBoxForTable(java.util.Hashtable<java.lang.String,java.lang.String> messageInfo)`
`java.lang.String`	`generateOneTimeCSRFTokenParameter()` This method generates and returns a one use only CSRF token as a request parameter.
`java.lang.String`	`generateRetryCSRFTokenParameter()` This method generates and returns a temporary CSRF token as a request parameter.
`boolean`	`getAccessibilityMode()`
`SessionContext`	`getAdaptorInstance()` Deprecated. FIREFOX
`WebClientSession.Alignment`	`getAlignment()`
`java.lang.String`	`getAppDesc(java.lang.String appId)` Returns the description of an application from the database
`java.lang.String`	`getAppMainTable(java.lang.String currentApp)` Returns the name of the main table for the passed app
`java.util.Stack<AppInstance>`	`getAppStack()` Returns a the app stack of the SessionContext.
`AsyncRequestManager`	`getAsyncRequestManager()` Returns the AsyncRequestManager for this WebClientSesssion.
`java.lang.Object`	`getAttribute(java.lang.String attributeName)`
`java.lang.String`	`getClientSideMessage(java.lang.String group, java.lang.String key)` Returns message with key in parenthesis at the end
`java.util.Set<java.lang.String>`	`getClonedApps(java.lang.String originalApp)`
`ConditionalUIHelper`	`getConditionalUIHelper()` Returns the ConditionalUIHelper assocaited with the WebClientSession.
`com.ibm.json.java.JSONObject`	`getContainerErrorIconJSON()` Builds and stores off the JSON Object definition to use for all containerIconExceptions
`boolean`	`getContextChanged()` Gets the message used by TIP to be sent to other portlets
`java.lang.String`	`getContextPath()` Returns the current servlet base URL, e.g.
`ControlInstance`	`getControlInstance(java.lang.String id)` Helper method to get a control instance from the app.page.controlInstanceIndex.
`ControlInstance`	`getControlInstance(java.lang.String id, boolean tableDownload)`
`java.lang.String`	`getCSRFToken()`
`java.lang.String`	`getCSRFTokenParameter()`
`java.lang.String`	`getCssPath()`
`java.lang.String`	`getCssURL()`
`AppInstance`	`getCurrentApp()`
`java.lang.String`	`getCurrentAppId()`
`WebClientEvent`	`getCurrentEvent()`
`ControlInstance`	`getCurrentEventHandler()` returns a reference to the current control instance that's prcessing an event
`PageInstance`	`getCurrentPage()` Returns the current app's current page instance.
`java.lang.String`	`getCurrentPageId()` Returns the current app's current page id.
`DataBean`	`getDataBean(java.lang.String beanId)`
`boolean`	`getDebug()`
`int`	`getDebugDockLeft()` Get the left location for the hiddenframe dialog in debug mode h
`int`	`getDebugDockTop()` Get the top location for the hiddenframe dialog in debug mode
`int`	`getDebugLevel()`
`java.lang.String`	`getDefaultStartApp()`
`java.lang.String`	`getDefautlFormat()`
`AsyncRequestManager`	`getDesignerAsyncRequestManager()`
`boolean`	`getDesignmode()`
`WebClientSession`	`getDesignModeWebClientSession()`
`java.lang.String`	`getDialogIcon(java.lang.String suffix)` Get the icon used in Messagebox dialog and async tooltip dialogs based on the messageId suffix
`java.lang.String`	`getEvalDaysRemaining()` Return number of days remaining on evaluation
`java.lang.String`	`getEventLog()`
`EventQueue`	`getEventQueue()` Return a reference to the EventQueue
`int`	`getEventState()`
`ContainerErrorInfo`	`getExceptionInfo()` Returns the error image information to be used by containers
`java.lang.String`	`getFactoryId()` Returns the factory id of the WCS.
`java.lang.String`	`getFeaturePack()` Return featurepack version if set in system.properties "mxe.webclient.featurePack" Should be set to simpl string such as: 7504
`WebClientEvent`	`getFirstHandledEvent()`
`boolean`	`getForceMessagesToMainPage()`
`java.lang.String`	`getHelpLangCode()` Get the language code for help url
`javax.servlet.http.HttpSession`	`getHttpSession()`
`double`	`getIEVersion()` Returns IE version
`java.lang.String`	`getImagePath()`
`java.lang.String`	`getImageSourcePath()` Get the Maximo images folder base on skin
`java.lang.String`	`getImageURL()`
`java.lang.String`	`getLeftNavWidth(PageInstance page)`
`boolean`	`getLightningPortalMode()`
`java.util.Locale`	`getLocale()`
`WebClientEvent`	`getLoginEvent()`
`ComponentInstance`	`getLongOpComponent()`
`WebClientEvent`	`getLongOpEvent()` The long operation event is the event that initiated the current long operation.
`java.lang.String`	`getLongOpMethod()` The long operation event is the event that initiated the current long operation.
`int`	`getLongOpStatus()`
`java.lang.String`	`getMaximoBaseURL()` Reconstructs the BASE URL the client used to make the request.
`java.lang.String`	`getMaximoRequestContextURL()` Reconstructs the Maximo Request Context Path.
`java.lang.String`	`getMaximoRequestURI()` Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
`java.lang.String`	`getMaximoRequestURL()` Reconstructs the URL the client used to make the request.
`MaxMessage`	`getMaxMessage(MXException mxe)` Convenience shortcut to get the message for a MXException
`MaxMessage`	`getMaxMessage(java.rmi.RemoteException e)` Get the MaxMessage Object to be displayed for the specified remote exception
`MaxMessage`	`getMaxMessage(java.lang.String group, java.lang.String key)` Get a MaxMessage Object for the specified error group and key.
`MboSetRemote`	`getMaxMessageMboSetRemote()` Get the cached MaxMessageMboSetRemote
`boolean`	`getMenusCached()`
`java.lang.String`	`getMessage(MXException mxe)` Get a message string for the specified error group and key
`java.lang.String`	`getMessage(java.lang.String group, java.lang.String key)` Get a message string for the specified error group and key
`java.lang.String`	`getMessage(java.lang.String group, java.lang.String key, java.lang.String[] params)`
`java.util.Queue<java.util.Map<java.lang.String,java.lang.String>>`	`getMessageBoxQueue()`
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getMessageInfoForTable(MaxMessage message, MXException mxe)`
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getMessageInfoForTable(MaxMessage message, java.lang.Object[] params)`
`java.lang.String[]`	`getMessages(java.lang.String group, java.lang.String[] key)` Find all messages in one convenient array.
`boolean`	`getMobile()`
`java.util.Map<java.lang.Integer,java.util.Hashtable<java.lang.String,java.lang.String>>`	`getModuleMap()` Returns module/app menus
`MXSession`	`getMXSession()` Returns the MXSession for the user.
`boolean`	`getMxSessionConnected()`
`java.lang.String`	`getOriginalApp(java.lang.String currentApp)` Returns the name of the original app, given the name of a duplicated app
`java.util.Set<java.lang.String>`	`getOriginalApps(java.lang.String currentApp)` Returns a set of original app names, given the name of a cloned app
`WebClientEvent`	`getOriginalEvent()`
`WebClientSession`	`getOriginalSession()`
`boolean`	`getPerfStat()` Return performance statistics flag (true / false ), first time it is set from webclient.properties files
`boolean`	`getPortalMode()`
`java.lang.String`	`getPortalMsg()` Gets the message used by TIP to be sent to other portlets
`AppInstance`	`getPreviousApp()`
`java.lang.String`	`getProxyBaseURL()` Reconstructs the BASE URL the client used to make the request.
`java.lang.String`	`getProxyRequestContextURL()` Reconstructs the ProxyServlet Request Context Path.
`ContainerErrorInfo`	`getQuestionInfo()` Returns the question image information to be used by containers
`java.lang.String`	`getRegexPattern(int dataType)` Returns pattern string for use in client-side validation.
`java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.String>>`	`getReportsMap()`
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the current request being handled by the WebClientSession.
`java.lang.String`	`getRequestParameter(java.lang.String key)`
`WebClientSession.RequestType`	`getRequestType()` Returns the current request type
`static WebClientSession.RequestType`	`getRequestType(javax.servlet.http.HttpServletRequest request)` Returns the request type from the ServletRequest
`javax.servlet.http.HttpServletResponse`	`getResponse()`
`java.lang.String`	`getSettingsProperty(java.lang.String prop)` Retrieves a property from the locale properties file (setting.properties).
`java.lang.String`	`getSettingsProperty(java.lang.String prop, java.lang.String[] params)` Retrieves a property from the locale properties file (setting.properties).
`boolean`	`getShowWebReplay()`
`java.lang.String`	`getSkin()`
`java.lang.String`	`getSkinName()`
`ContainerErrorInfo`	`getSmartFillExceptionInfo()` Returns the error image information to be used by containers
`SpellingSessionAdapter`	`getSpellSessionAdapter()` Returns the SpellingSessionAdapter object in use during this Spelling Session
`java.lang.Object`	`getStartCenterCache(java.lang.String key)` Returns a portion of current start center
`EventHandlerInterface`	`getSystemEventHandler()`
`java.util.Map<java.lang.Integer,java.util.Map<java.lang.String,java.lang.String>>`	`getSystemOptionMap()` MM returns System options menu
`java.lang.String[]`	`getSystemProperty(java.lang.String propertyName)` Return array of strings for given property name.
`java.util.TimeZone`	`getTimeZone()`
`boolean`	`getTipPortalMode()`
`java.lang.String`	`getUISessionID()`
`java.lang.String`	`getUISessionUrlParameter()`
`java.lang.String`	`getUniqueId()` Generate a unique id for a newly inserted (or pasted) control.
`int`	`getUserAgent()`
`java.lang.String`	`getUserAgentName()` Returns the current Agent (browser) string Identifier
`java.lang.String`	`getUserAgentReplacement()` Returns string to use in replacing the #{browser} keyword.
`java.util.Set<java.lang.String>`	`getUserApps()`
`UserInfo`	`getUserInfo()`
`java.lang.String`	`getUserLanguageCode()`
`ContainerErrorInfo`	`getWarningInfo()` Returns the warning image information to be used by containers
`java.util.ArrayList<MXException>`	`getWarnings()`
`java.lang.String`	`getWebClientURL()`
`WorkflowDirector`	`getWorkflowDirector()` Returns the WorkflowDirector for the client session
`void`	`gotoApplink(java.lang.String url)` Redirects the browser to the URL in the parameter
`boolean`	`handleDialogOK(boolean advancedLongOp)` Calls the action in the current event on the bean associated with the dialog.
`boolean`	`handleDialogOK(boolean advancedLongOp, java.lang.String longOpMessage)`
`int`	`handleEvent(WebClientEvent event)`
`boolean`	`handleMXWarnings()` Kicks off the event to show warnings that are saved in the warnings list in the sessionContext Some events can have problems if warnings are displayed along with them, set the request attribute "waitwarnings" to have the warnings display delayed.
`boolean`	`handleMXWarnings(boolean showMultipleWarningsSeparately)`
`void`	`handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`boolean`	`hasDesignModeWebClientSession()`
`boolean`	`hasLongOpCompleted()`
`boolean`	`hasLongOpStarted()`
`boolean`	`hasPausedEvents()` Returns true if there are events in the paused event queue.
`boolean`	`hasQueryLongOpCompleted()`
`boolean`	`hasStartCenterCache(java.lang.String key)` Returns true if a cache already exists.
`boolean`	`hasTimedOut()` Returns true is the WebClientSession has timed out or false if it hasn't The timeout interval is defaulted to the HttpSession timeout interval but can be overriden by the webclient.properties property webclient.webclientsessiontimeout.
`boolean`	`hasWarnings()`
`boolean`	`hasWorkflowInfo()`
`void`	`hideWebReplay(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`void`	`invalidate()`
`boolean`	`isAsyncEnabled()` Checks, stores and returns global system property for whether async is enabled "mxe.webclient.async"
`boolean`	`isAutomationOn()`
`boolean`	`isCombinedSetValue()`
`boolean`	`isConnected()`
`boolean`	`isInFrameset()` Gets whether or not we are currently running in a frameset.
`boolean`	`isMaximoOrTivoliBrand()` Returns if the current product is maximo brand or not
`boolean`	`isMobileUserAgent()`
`boolean`	`isPermanentLicense()` Return set if license is permanent
`boolean`	`isPostTivoli09Skin()`
`boolean`	`isQueuePaused()` Returns whether or not the queue has been paused and stores off the remaining queued events to be done after the user closes the messagebox.
`boolean`	`isSessionFound()`
`boolean`	`isTempTokenValid(java.lang.String oneTimeToken)` Returns true if the token passed is a valid temporary Cross Site Request Forgery token that was generated via generateOneTimeCSRFTokenParameter and then invalidates the token.
`boolean`	`isValid()` Returns boolean true if the WebClientSession is still valid or false if it is not.
`boolean`	`isWebReplayEnabled()`
`void`	`killPopup(boolean killIt)` Forces current popup page off the page stack and removes it from UI
`void`	`killPopup(WebClientEvent event)` Uses event to determine whether popup should be killed if a popup is open and an event is sent to another page, the popup must be closed
`java.util.Date`	`lastAccessed()`
`int`	`loadDialog(java.lang.String dialogId)`
`int`	`loadDialog(java.lang.String dialogId, boolean showmessages, java.lang.String longOpMessage)`
`int`	`loadDialogInDesignerApps(java.lang.String dialogId)`
`boolean`	`lockMboOnEntry()`
`void`	`longOpCleanup()` Cleanup code called after the long operation has been completed.
`void`	`longOpQueryCleanup()`
`void`	`pauseQueue()` Pauses processing the queue.
`void`	`performApplink(boolean canApplink)` Sets whether or not an applink can happen.
`AppInstance`	`popApp()` Removes the top application instance from the stack.
`void`	`printDebugMessage(int level, java.lang.String message)`
`int`	`processProfiles(java.lang.String profileName)`
`void`	`processRender()` This method will send the render event to the current app if the call to handleRequest flags the WebClientSession to process the render.
`void`	`pushApp(AppInstance ai)` Push the app on the app stack
`void`	`queueEvent(WebClientEvent event)` Adds an event to the EventQueue.
`java.lang.String`	`removeUOM(java.lang.String size)`
`java.util.List<MXException>`	`removeWarnings()` Clears (removes) all warnings from the warning list and returns them.
`org.w3c.dom.Element`	`replaceQbeclearButton(org.w3c.dom.Element dialogElement)`
`void`	`resetPortletCaches()` Resets PortletlLayoutCache cache and individual portlet caches.
`void`	`resetStartCenterCache()` Resets StartCenterListCache and PortletlLayoutCache cache
`boolean`	`runLongOp(DataBean dataSrc, java.lang.String method)` Initiates a long op method on the passed in datasrc.
`boolean`	`runLongOp(DataBean dataSrc, java.lang.String method, boolean showMessages, java.lang.String longOpMessage)`
`boolean`	`runLongOp(DataBean dataSrc, WebClientEvent event)` Initiates a long op method on the passed in datasrc.
`boolean`	`runLongOp(DataBean dataSrc, WebClientEvent event, boolean showMessages, java.lang.String longOpMessage)`
`boolean`	`runLongOpQuery(DataBean dataSrc, java.lang.String method, boolean showMessages, java.lang.String longOpMessage)`
`void`	`setAccessibilityMode(boolean mode)`
`void`	`setAdvancedLongOp(boolean advanced)`
`void`	`setAttribute(java.lang.String attributeName, java.lang.Object value)`
`void`	`setContextChanged(boolean aBool)` Sets the message used by TIP to be sent to other portlets
`void`	`setCssPath(java.lang.String path)`
`void`	`setCurrentEvent(WebClientEvent event)`
`void`	`setCurrentEventHandler(ControlInstance eventHandler)`
`void`	`setDebugDock(java.lang.String left, java.lang.String top)`
`void`	`setDefautlFormat(java.lang.String defaultFormat)`
`void`	`setDesignmode(boolean flag)`
`void`	`setDesignModeWebClientSession(WebClientSession wcs)`
`void`	`setErrorFieldFocus(java.lang.String currentFocusId, boolean forceRow)`
`void`	`setEventState(int state)`
`void`	`setHttpSession(javax.servlet.http.HttpSession https)`
`void`	`setImagePath(java.lang.String path)`
`void`	`setImagesPreLoaded(boolean pre)` Sets whether or not we need to preload images for this skin and session
`void`	`setInFrameset(boolean isInFrameset)` Sets whether or not we are currently running in a frameset.
`void`	`setLeftNavWidth(java.lang.String width)`
`void`	`setLightningPortalMode(boolean portalmode)`
`void`	`setLockMboOnEntry(boolean checkrecordlock)`
`void`	`setLongOpChecked(boolean longopChecked)` In order to get around a threading issue that happens when the longop processing is very fast added the longOpChecked flag the will prevent hasLongOpCompleted from returning true until the longop dialog had a chance to ask.
`void`	`setLongOpComponent(ComponentInstance longOp)`
`void`	`setMaxMessageMboSetRemote(MboSetRemote setmboSet)` Set cache for the MaxMessageMboSetRemote object.
`void`	`setMenusCached(boolean cached)`
`void`	`setMobile(boolean setValue)`
`void`	`setMxSessionConnected(boolean flag)`
`void`	`setOriginalSession(WebClientSession wcs)`
`void`	`setPerformanceDataHASH(java.lang.String keyName, long sInputValue)` Tracking performance data in memory
`void`	`setPerformanceDataHASH(java.lang.String keyName, java.lang.String value)` Deprecated. use the other version that takes a long value
`void`	`setPerfStat(java.lang.String flag)` set performance statistics flag (true / false ), first time it is set from webclient.properties files
`void`	`setPortalMode(boolean portalmode)`
`void`	`setPortalMsg(java.lang.String aMsg)` Sets the message used by TIP to be sent to other portlets
`void`	`setRequest(javax.servlet.http.HttpServletRequest request)` Sets the current HttpServletRequest that the WebClientSession is handling, and sets its request type
`void`	`setResponse(javax.servlet.http.HttpServletResponse response)`
`void`	`setSessionFound(boolean flag)`
`void`	`setShowWebReplay(boolean show)`
`void`	`setSpellSessionAdapter(SpellingSessionAdapter spellSessionAdapter)` Sets the SpellingSessionAdapter object to be used during this Spelling Session
`void`	`setStartCenterCache(java.lang.String key, java.lang.Object obj)` Sets cache object in the cache
`void`	`setTimeZone(java.lang.String strTimeZone)`
`void`	`setTipPortalMode(boolean tipportalmode)`
`void`	`setUISessionID(java.lang.String uiSessionID)`
`void`	`setUserInput(MXException mxe, int msgReturn)` Set MXException in the userinput for the object to use
`void`	`showEsigLoginDialog(ESigLoginException srcExcept)` Open the eSignature login dialog
`void`	`showLongopDialog(java.lang.String datasrc)`
`void`	`showMessageBox(MXException mxe)`
`void`	`showMessageBox(java.lang.String messageFile, java.lang.String key, java.lang.String[] params)`
`void`	`showMessageBox(WebClientEvent srcEvent, MXException mxe)`
`void`	`showMessageBox(WebClientEvent srcEvent, java.rmi.RemoteException re)`
`void`	`showMessageBox(WebClientEvent srcEvent, java.lang.String title, java.lang.String warnings, int flags)`
`void`	`showMessageBox(WebClientEvent srcEvent, java.lang.String messageFile, java.lang.String key, java.lang.Object[] params)`
`void`	`showMessageBox(WebClientEvent srcEvent, java.lang.String messageFile, java.lang.String key, java.lang.String[] params)` Deprecated. use `showMessageBox(WebClientEvent, String, String, Object[])`
`boolean`	`showSystemNavBar(PageInstance page)` Checks system property and app override to determine whether we should show the system navbar
`boolean`	`showWebReplay(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`int`	`showwfinfo()`
`void`	`stamp()`
`void`	`stopLongOpQuery()`
`boolean`	`subFrameAllowed()`
`boolean`	`supportsLocalStorage()`
`java.lang.String`	`toString()`
`void`	`turnAutomationOn()`
`void`	`unPauseQueue()` Adds the saved queued events to the event queue so they can be processed.
`void`	`useLeftContextInterval(boolean use)` Tells session to use the left Context interval to timeout
`boolean`	`useVerticalLabels()`
`boolean`	`usingContextInterval()` Tells session to use the left Context interval to timeout
`void`	`valueBound(javax.servlet.http.HttpSessionBindingEvent arg0)`
`void`	`valueUnbound(javax.servlet.http.HttpSessionBindingEvent arg0)`
`boolean`	`wasPopupKilled()`
`boolean`	`wereImagesPreLoaded()` Used to determine if we have preloaded images for this skin and session

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serviceability
```
public final SessionServiceability serviceability
```
  - MSG_BTNCLOSE
```
public static final int MSG_BTNCLOSE
```
    See Also:
    
    Constant Field Values
  - MSG_BTNOK
```
public static final int MSG_BTNOK
```
    See Also:
    
    Constant Field Values
  - MSG_BTNCANCEL
```
public static final int MSG_BTNCANCEL
```
    See Also:
    
    Constant Field Values
  - MSG_BTNYES
```
public static final int MSG_BTNYES
```
    See Also:
    
    Constant Field Values
  - MSG_BTNNO
```
public static final int MSG_BTNNO
```
    See Also:
    
    Constant Field Values
  - AGENT_IE
```
public static final int AGENT_IE
```
    See Also:
    
    Constant Field Values
  - AGENT_FIREFOX
```
public static final int AGENT_FIREFOX
```
    See Also:
    
    Constant Field Values
  - AGENT_CHROME
```
public static final int AGENT_CHROME
```
    See Also:
    
    Constant Field Values
  - AGENT_SAFARI
```
public static final int AGENT_SAFARI
```
    See Also:
    
    Constant Field Values
  - AGENT_OPERA
```
public static final int AGENT_OPERA
```
    See Also:
    
    Constant Field Values
  - LEFTNAV_INHERIT
```
public static final int LEFTNAV_INHERIT
```
    See Also:
    
    Constant Field Values
  - LEFTNAV_OPEN
```
public static final int LEFTNAV_OPEN
```
    See Also:
    
    Constant Field Values
  - LEFTNAV_CLOSE
```
public static final int LEFTNAV_CLOSE
```
    See Also:
    
    Constant Field Values
  - DISPLAYMETHOD_STATUS
```
public static final java.lang.String DISPLAYMETHOD_STATUS
```
    See Also:
    
    Constant Field Values
  - DISPLAYMETHOD_MSGBOX
```
public static final java.lang.String DISPLAYMETHOD_MSGBOX
```
    See Also:
    
    Constant Field Values
  - SAVEMODE_ONLOAD
```
public static final java.lang.String SAVEMODE_ONLOAD
```
    See Also:
    
    Constant Field Values
  - SAVEMODE_ONUNLOAD
```
public static final java.lang.String SAVEMODE_ONUNLOAD
```
    See Also:
    
    Constant Field Values
  - SAVEMODE_ONLOADUNLOAD
```
public static final java.lang.String SAVEMODE_ONLOADUNLOAD
```
    See Also:
    
    Constant Field Values
  - REQUESTTYPE
```
public static final java.lang.String REQUESTTYPE
```
    See Also:
    
    Constant Field Values
  - TEMP_TOKEN_PARAM
```
public static final java.lang.String TEMP_TOKEN_PARAM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WebClientSession
```
@TracePrimary
public WebClientSession(javax.servlet.http.HttpSession httpSession)
```
    Deprecated. WebClientSessions should be created via the WebClientSessionFactory createSession method.
    
    Default constructor
    
    See Also:
    
    WebClientSessionFactory.createSession(HttpServletRequest, HttpServletResponse)
- Method Detail
  - isPostTivoli09Skin
```
public boolean isPostTivoli09Skin()
```
  - getSkin
```
public java.lang.String getSkin()
```
  - getSkinName
```
public java.lang.String getSkinName()
```
  - getAdaptorInstance
```
public SessionContext getAdaptorInstance()
```
    Deprecated. FIREFOX
    
    Returns:
    
    the adaptor instance associated with this master object
  - getMxSessionConnected
```
public boolean getMxSessionConnected()
```
  - setMxSessionConnected
```
public void setMxSessionConnected(boolean flag)
```
  - isConnected
```
public boolean isConnected()
```
  - applySkin
```
public void applySkin()
```
  - isMobileUserAgent
```
public boolean isMobileUserAgent()
```
  - getUserAgentName
```
public java.lang.String getUserAgentName()
```
    Returns the current Agent (browser) string Identifier
  - getUserAgentReplacement
```
public java.lang.String getUserAgentReplacement()
```
    Returns string to use in replacing the #{browser} keyword. This currently only does IE or FF if not IE
  - getUserAgent
```
public int getUserAgent()
```
  - handleRequest
```
@TracePrimary
public void handleRequest(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException
```
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - fixRowForTableDetails
```
public java.lang.String fixRowForTableDetails(java.lang.String compId)
```
    When updating tabledetails and changing row during setvalue, the value could get applied to the wrong row. On tbalerows, the rownum is part of the componentId and this allows us to use the row when doing the setvalue. On tabledetails it is not feasible to use the rownum as part of the component ids
    
    Parameters:
    
    compId - - id of the component that is getting a setvalue
    
    Returns:
    
    String row
  - getProxyRequestContextURL
```
public java.lang.String getProxyRequestContextURL()
```
    Reconstructs the ProxyServlet Request Context Path. The returned URL contains a protocol, server name, port number and application context.
  - getProxyBaseURL
```
public java.lang.String getProxyBaseURL()
```
    Reconstructs the BASE URL the client used to make the request. The returned URL contains a protocol, server name, port number. .
  - getPortalMsg
```
public java.lang.String getPortalMsg()
```
    Gets the message used by TIP to be sent to other portlets
  - setPortalMsg
```
public void setPortalMsg(java.lang.String aMsg)
```
    Sets the message used by TIP to be sent to other portlets
  - getContextChanged
```
public boolean getContextChanged()
```
    Gets the message used by TIP to be sent to other portlets
  - setContextChanged
```
public void setContextChanged(boolean aBool)
```
    Sets the message used by TIP to be sent to other portlets
  - showwfinfo
```
public int showwfinfo()
```
  - setErrorFieldFocus
```
public void setErrorFieldFocus(java.lang.String currentFocusId,
                               boolean forceRow)
```
  - printDebugMessage
```
public void printDebugMessage(int level,
                              java.lang.String message)
```
  - handleEvent
```
@TracePrimary
public int handleEvent(WebClientEvent event)
```
    Parameters:
    
    event - the event to process
    
    Returns:
    
    the status returned by the event processing handler, or PROCESS_NEXT_EVENT in case of any failure to process
  - hasWorkflowInfo
```
public boolean hasWorkflowInfo()
```
  - getEventQueue
```
public EventQueue getEventQueue()
```
    Return a reference to the EventQueue
  - queueEvent
```
public void queueEvent(WebClientEvent event)
```
    Adds an event to the EventQueue.
  - getCurrentPageId
```
public java.lang.String getCurrentPageId()
```
    Returns the current app's current page id.
  - getCurrentPage
```
public PageInstance getCurrentPage()
```
    Returns the current app's current page instance.
  - getDataBean
```
public DataBean getDataBean(java.lang.String beanId)
```
  - checkForDialogAccess
```
public boolean checkForDialogAccess(java.lang.String dialogId,
                                    org.w3c.dom.Element dialog)
```
  - findDialog
```
public PageInstance findDialog(java.lang.String dialogId)
```
    Returns the dialog control instance with the supplied id if it exists. If the dialog exists in the library the control is cloned and added as a child to the current application. This is done so the dialog can inherit the datasrc and any other global properties from the application. If the dialog is not found null is returned.
    
    Parameters:
    
    dialogId - the id of the dialog
    
    Returns:
    
    the dialog page
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Generate a unique id for a newly inserted (or pasted) control. Used by designer
  - findDialogInDesignerApps
```
public ControlInstance findDialogInDesignerApps(java.lang.String dialogId)
```
    Returns the dialog control instance with the supplied id if it exists for App Designer. If the dialog exists in the library the control is cloned and added as a child to the current application. This is done so the dialog can inherit the datasrc and any other global properties from the application. If the dialog is not found null is returned.
    
    Parameters:
    
    dialogId - the id of the dialog
    
    Returns:
    
    the dialog page
  - setLongOpComponent
```
public void setLongOpComponent(ComponentInstance longOp)
```
  - getLongOpComponent
```
public ComponentInstance getLongOpComponent()
```
  - loadDialog
```
public int loadDialog(java.lang.String dialogId)
```
  - loadDialog
```
public int loadDialog(java.lang.String dialogId,
                      boolean showmessages,
                      java.lang.String longOpMessage)
```
  - loadDialogInDesignerApps
```
public int loadDialogInDesignerApps(java.lang.String dialogId)
```
  - getControlInstance
```
public ControlInstance getControlInstance(java.lang.String id)
```
    Helper method to get a control instance from the app.page.controlInstanceIndex. If the id equals the id of the current application, the application instance is returned
    
    Returns:
    
    the control instance, or null if not found
  - getControlInstance
```
public ControlInstance getControlInstance(java.lang.String id,
                                          boolean tableDownload)
```
  - getCurrentApp
```
public AppInstance getCurrentApp()
```
  - getCurrentAppId
```
public java.lang.String getCurrentAppId()
```
  - getPreviousApp
```
public AppInstance getPreviousApp()
```
    Returns:
    
    the previous app in the app stack. Returns null if there's only the current application. This doesn't pop the app of the stack.
  - getMXSession
```
public MXSession getMXSession()
```
    Returns the MXSession for the user.
  - getHttpSession
```
public javax.servlet.http.HttpSession getHttpSession()
```
  - setHttpSession
```
public void setHttpSession(javax.servlet.http.HttpSession https)
```
  - pushApp
```
public void pushApp(AppInstance ai)
```
    Push the app on the app stack
  - popApp
```
public AppInstance popApp()
```
    Removes the top application instance from the stack. Closes the application which removes all its pages and closes all underlying data beans
    
    Returns:
    
    The closed AppInstance object, see AppInstance.close()
  - clearStack
```
public void clearStack()
```
    Removes all apps form the app stack. Typically this is only called when changing app (not app linking).
  - getAppStack
```
public java.util.Stack<AppInstance> getAppStack()
```
    Returns a the app stack of the SessionContext. This stack should contain all app linked apps.
  - setCurrentEvent
```
public void setCurrentEvent(WebClientEvent event)
```
  - getCurrentEvent
```
public WebClientEvent getCurrentEvent()
```
    Returns:
    
    the event being currently processed by handleEvent.
  - getFirstHandledEvent
```
public WebClientEvent getFirstHandledEvent()
```
    Returns:
    
    the very first event processed by handleEvent.
  - getOriginalEvent
```
public WebClientEvent getOriginalEvent()
```
    Returns:
    
    the original event that came in on the request. this event will of course have the original control and component, accessible by calling getSourceControl() getSourceComponent()
  - setEventState
```
public void setEventState(int state)
```
  - getEventState
```
public int getEventState()
```
  - getCurrentEventHandler
```
public ControlInstance getCurrentEventHandler()
```
    returns a reference to the current control instance that's prcessing an event
  - setCurrentEventHandler
```
public void setCurrentEventHandler(ControlInstance eventHandler)
```
  - setPerfStat
```
public void setPerfStat(java.lang.String flag)
```
    set performance statistics flag (true / false ), first time it is set from webclient.properties files
  - getPerfStat
```
public boolean getPerfStat()
```
    Return performance statistics flag (true / false ), first time it is set from webclient.properties files
  - getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the current request being handled by the WebClientSession.
  - getRequestType
```
public WebClientSession.RequestType getRequestType()
```
    Returns the current request type
  - getRequestType
```
public static WebClientSession.RequestType getRequestType(javax.servlet.http.HttpServletRequest request)
```
    Returns the request type from the ServletRequest
  - setRequest
```
public void setRequest(javax.servlet.http.HttpServletRequest request)
```
    Sets the current HttpServletRequest that the WebClientSession is handling, and sets its request type
    
    Parameters:
    
    request - HttpServletRequest object sent to the Tpae UI framework (via the WebClientServlet) from the client (browser).
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Returns:
    
    Returns the response.
  - setResponse
```
public void setResponse(javax.servlet.http.HttpServletResponse response)
```
    Parameters:
    
    response - The response to set.
  - createMXSession
```
public MXSession createMXSession()
```
  - hasWarnings
```
public boolean hasWarnings()
```
  - getWarnings
```
public java.util.ArrayList<MXException> getWarnings()
```
  - addWarning
```
public void addWarning(MXException e)
```
  - removeWarnings
```
public java.util.List<MXException> removeWarnings()
```
    Clears (removes) all warnings from the warning list and returns them.
  - addWarnings
```
public void addWarnings(java.util.List<MXException> warningList)
```
    Adds warnings to the app-persisted warnings stack. The warningsStack is used to iterate the list of warnings and display them to the user. Warnings are collected after operations such as bean method calls, remote method calls and setvalue calls. The display of warnings is handled by the showwarnings event in the presentation control.
  - getLoginEvent
```
public WebClientEvent getLoginEvent()
                             throws java.io.IOException
```
    Returns:
    
    Returns the event to send/queue after the user logs in.
    
    Throws:
    
    java.io.IOException
  - getLocale
```
public java.util.Locale getLocale()
```
  - getAlignment
```
public WebClientSession.Alignment getAlignment()
```
  - getHelpLangCode
```
public java.lang.String getHelpLangCode()
```
    Get the language code for help url
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
  - setTimeZone
```
public void setTimeZone(java.lang.String strTimeZone)
                 throws java.rmi.RemoteException,
                        MXException
```
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - getUserInfo
```
public UserInfo getUserInfo()
```
  - getUserLanguageCode
```
public java.lang.String getUserLanguageCode()
```
    Returns:
    
    the lower case of the user language code or null if not found
  - getMaxMessageMboSetRemote
```
public MboSetRemote getMaxMessageMboSetRemote()
```
    Get the cached MaxMessageMboSetRemote
  - setMaxMessageMboSetRemote
```
public void setMaxMessageMboSetRemote(MboSetRemote setmboSet)
```
    Set cache for the MaxMessageMboSetRemote object. It is constructed once through WebClientRuntime.getMaxMessage method.
  - getUserApps
```
public java.util.Set<java.lang.String> getUserApps()
```
  - getOriginalApp
```
public java.lang.String getOriginalApp(java.lang.String currentApp)
```
    Returns the name of the original app, given the name of a duplicated app
    
    Parameters:
    
    currentApp - the application name of the duplicated app
    
    Returns:
    
    the original app name
  - getAppDesc
```
public java.lang.String getAppDesc(java.lang.String appId)
```
    Returns the description of an application from the database
    
    Parameters:
    
    appId - the application ID
    
    Returns:
    
    the application description
  - getClonedApps
```
public java.util.Set<java.lang.String> getClonedApps(java.lang.String originalApp)
```
  - getOriginalApps
```
public java.util.Set<java.lang.String> getOriginalApps(java.lang.String currentApp)
```
    Returns a set of original app names, given the name of a cloned app
    
    Parameters:
    
    currentAppName - the application name of the cloned app
    
    Returns:
    
    the a set of parent app names
  - getAppMainTable
```
public java.lang.String getAppMainTable(java.lang.String currentApp)
```
    Returns the name of the main table for the passed app
    
    Parameters:
    
    currentApp - the application name
    
    Returns:
    
    the main table for the app
  - getSpellSessionAdapter
```
public SpellingSessionAdapter getSpellSessionAdapter()
```
    Returns the SpellingSessionAdapter object in use during this Spelling Session
    
    Returns:
    
    Returns the SpellingSessionAdapter object
  - setSpellSessionAdapter
```
public void setSpellSessionAdapter(SpellingSessionAdapter spellSessionAdapter)
```
    Sets the SpellingSessionAdapter object to be used during this Spelling Session
    
    Parameters:
    
    spellAdapter - the SpellingSessionAdapter object
  - pauseQueue
```
public void pauseQueue()
```
    Pauses processing the queue. This is only done for message boxes.
  - isQueuePaused
```
public boolean isQueuePaused()
```
    Returns whether or not the queue has been paused and stores off the remaining queued events to be done after the user closes the messagebox.
  - unPauseQueue
```
public void unPauseQueue()
```
    Adds the saved queued events to the event queue so they can be processed.
  - runLongOp
```
public boolean runLongOp(DataBean dataSrc,
                         WebClientEvent event)
```
    Initiates a long op method on the passed in datasrc. The passed in method is the method called by the new thread.
    The method is called typically three times for a single long operation initialted by the user's action:
  - By the calling thread when the operation is initiated: that creates the asynchronous thread. This is done necessarily from an event handler method
  - By the new thread - if the method returns true then the caller knows that it is running in its own thread and can perform the operation. This is expecially useful when the method is the same handler that was used in the step above - and is typical for how application beans use asynchronous processing
  - By the cleanup code after it closes the long operation dialog and before it disposes of the thread object - to give a chance to the event handler which is the same as the one in the first step to do clean-up. At that point the status is completed - either successfully or with an error, and the call returns false without creating a new thread. The handler uses haslongOpCompleted() to determine the need to perform the cleanup

Returns:: true if the long operation was started

runLongOp

public boolean runLongOp(DataBean dataSrc,
                         WebClientEvent event,
                         boolean showMessages,
                         java.lang.String longOpMessage)

runLongOp
```
public boolean runLongOp(DataBean dataSrc,
                         java.lang.String method)
```
Initiates a long op method on the passed in datasrc. The passed in method is the method called by the new thread.
The method is called typically three times for a single long operation initialted by the user's action:
By the calling thread when the operation is initiated: that creates the asynchronous thread. This is done necessarily from an event handler method
By the new thread - if the method returns true then the caller knows that it is running in its own thread and can perform the operation. This is expecially useful when the method is the same handler that was used in the step above - and is typical for how application beans use asynchronous processing
By the cleanup code after it closes the long operation dialog and before it disposes of the thread object - to give a chance to the event handler which is the same as the one in the first step to do clean-up. At that point the status is completed - either successfully or with an error, and the call returns false without creating a new thread. The handler uses haslongOpCompleted() to determine the need to perform the cleanup

Class WebClientSession

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serviceability

MSG_BTNCLOSE

MSG_BTNOK

MSG_BTNCANCEL

MSG_BTNYES

MSG_BTNNO

AGENT_IE

AGENT_FIREFOX

AGENT_CHROME

AGENT_SAFARI

AGENT_OPERA

LEFTNAV_INHERIT

LEFTNAV_OPEN

LEFTNAV_CLOSE

DISPLAYMETHOD_STATUS

DISPLAYMETHOD_MSGBOX

SAVEMODE_ONLOAD

SAVEMODE_ONUNLOAD

SAVEMODE_ONLOADUNLOAD

REQUESTTYPE

TEMP_TOKEN_PARAM

Constructor Detail

WebClientSession

Method Detail

isPostTivoli09Skin

getSkin

getSkinName

getAdaptorInstance

getMxSessionConnected

setMxSessionConnected

isConnected

applySkin

isMobileUserAgent

getUserAgentName

getUserAgentReplacement

getUserAgent

handleRequest

fixRowForTableDetails

getProxyRequestContextURL

getProxyBaseURL

getPortalMsg

setPortalMsg

getContextChanged

setContextChanged

showwfinfo

setErrorFieldFocus

printDebugMessage

handleEvent

hasWorkflowInfo

getEventQueue

queueEvent

getCurrentPageId

getCurrentPage

getDataBean

checkForDialogAccess

findDialog

getUniqueId

findDialogInDesignerApps

setLongOpComponent

getLongOpComponent

loadDialog

loadDialog

loadDialogInDesignerApps

getControlInstance

getControlInstance

getCurrentApp

getCurrentAppId

getPreviousApp

getMXSession

getHttpSession

setHttpSession

pushApp

popApp