JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfSessionTimeoutHelper

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfSessionTimeoutHelper

public class AdfSessionTimeoutHelper
extends AdfObject

_timeoutWindowState

private Object _timeoutWindowState

TimeoutWindowStates

protected static Object TimeoutWindowStates

'enum' for different timeout window states

AdfSessionTimeoutHelper

public AdfSessionTimeoutHelper()

Helper class used in managing session timer and display of session timeout dialogs

__alertTimeout

Object __alertTimeout()

Show the final session timeout alert dialog.

Return:

Object

_cancelAndRescheduleSessionTimeoutTimer

private Object _cancelAndRescheduleSessionTimeoutTimer(Object timeout,
                                                       Object warningBeforeTimeout,
                                                       Object newSessionURL)

Parameters:

timeout
warningBeforeTimeout
newSessionURL

Return:

Object

__cancelSessionTimeoutTimer

Object __cancelSessionTimeoutTimer()

Cancel session tiemout warning timer and session timeout timer. This is also called by AdfUserInactivityTimeout._rescheduleOrScheduleTimerIfNeeded() to cancel session timeout warning timer.

Return:

Object

_cleanupLocalStorageSessionKeys

private Object _cleanupLocalStorageSessionKeys()

Cleans the web local storage of all the session keys and expiry time values for those sessions that have expired. For this to work efficiently, users will have to enable web session storage in the browser, otherwise there will be attempt to clean up web local storage 1 minute after every response.

Return:

Object

_extendSessionInServer

private Object _extendSessionInServer()

Extends the life of the session in server by touching it, and does the necessary timer sync up on the client

Return:

Object

_getTimeLeftToSessionTimeout

private Object _getTimeLeftToSessionTimeout()

Gets the time remaining for the session to timeout, based on the value stored in web local storage Returns null if the web local storage was not enabled or if it did not have the timeout value.

Return:

Object

getTimeoutWindowState

public AdfSessionTimeoutHelper.TimeoutWindowStates getTimeoutWindowState()

Accessor for the current "timeout window" state.

Return:

AdfSessionTimeoutHelper.TimeoutWindowStates - one of the values contained within the 'AdfSessionTimeoutHelper.TimeoutWindowStates' enum.

_handleFinalSessionTimeoutAlert

private Object _handleFinalSessionTimeoutAlert(Object adfDialogEvent)

Handler for the ok button press on the final session timed out alert window

Parameters:

adfDialogEvent

Return:

Object

_handleSessionTimeoutWarningDialogOutcome

private Object _handleSessionTimeoutWarningDialogOutcome(Object adfDialogEvent)

Handler for the ok / cancel press on the session timeout warning dialog

Parameters:

adfDialogEvent

Return:

Object

Init

protected Object Init()

Create an instance of an AdfUserInactivityTimeoutHelper

Return:

Object

Overrides:

AdfObject.Init()

__initializeSessionTimeoutTimer

Object __initializeSessionTimeoutTimer(Object timeout,
                                        Object warningBeforeTimeout,
                                        Object newSessionURL)

Initializes the session timeout timers and schedules the session timeout warning dialog to be shown at the computed time to warn.

Parameters:

timeout
warningBeforeTimeout
newSessionURL

Return:

Object

_isUserActiveOnClient

private Object _isUserActiveOnClient(Object duration)

Checks if the user was active on the client back until the supplied duration

Parameters:

duration

Return:

Object

__recordUserActivity

Object __recordUserActivity(Object event)

If the supplied event is a key press or mouse click, records a user activity at current time. This is called from AdfDhtmlPage when handling and redistributing native DOM events.

Parameters:

event

Return:

Object

See also:

AdfDhtmlPage._redistribute(HTMLDomEvent)

_removeSessionTimeoutFromWebLocalStorage

private Object _removeSessionTimeoutFromWebLocalStorage(Object timeout)

Remove earlier stored session expiry value for the current session if any.

Parameters:

timeout

Return:

Object

_setActivityTimeInWebLocalStorage

private Object _setActivityTimeInWebLocalStorage()

Stores in web local storage the current time as the time of last user activity on the client

Return:

Object

_setSessionTimeoutInWebLocalStorage

private Object _setSessionTimeoutInWebLocalStorage(Object timeout)

From the supplied time to timeout value, computes the time in the client when the session in the server would expire.

Parameters:

timeout

Return:

Object

_showFinalSessionTimeoutAlertDialog

private number _showFinalSessionTimeoutAlertDialog()

Show the inline alert dialog when we think session has timed out.

Return:

number - null -1 so that AdfPage.PAGE.scheduleTimer() does not automatically schedule showing another warning dialog

_showSessionTimeoutWarningDialog

private number _showSessionTimeoutWarningDialog()

Show dialog to warn when we think session is going to time out soon

Return:

number - null -1 so that scheduleTimer() does not automatically schedule showing another warning dialog

__startSessionTimeoutTimer

Object __startSessionTimeoutTimer()

Start session timeout timer. This is also called by AdfUserInactivityTimeoutHelper._forceComponentStop to start session timeout timer.

Return:

Object

_startSessionTimeoutTimer

private Object _startSessionTimeoutTimer(Object timeout,
                                         Object warningBeforeTimeout,
                                         Object newSessionURL)

Start session tiemout warning timer. This could result in either the session timeout warning dialog or the final timeout dialog being scheduled, depending on how much more time it is to timeout

Parameters:

timeout
warningBeforeTimeout
newSessionURL

Return:

Object

_touchServerSession

private Object _touchServerSession()

Send a request to server to touch the server session. Note that for this request the response body will be empty.

Return:

Object