er.ajax

Class AjaxSessionPing

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WODynamicElement

com.webobjects.appserver._private.WODynamicGroup

er.extensions.components.ERXDynamicElement

er.ajax.AjaxDynamicElement

er.ajax.AjaxSessionPing

All Implemented Interfaces:

IAjaxElement

public class AjaxSessionPing
extends AjaxDynamicElement

Simple component to ping the session in the background. It can do two things. The first is to execute JavaScript if the session is no longer valid. The default action is to close the window that the ping came from. The second thing it can do is to keep the session alive. This can be useful if you want the session to not time out on particular pages. It should be used with caution as it can prevent scheduled restarts if the user leaves the browser window open.

Author:

chill

Bindings

Name	Description
frequency	the period between pings of the application (optional, default 60 seconds)
keepSessionAlive	true if session should be checked out to reset timeout when the application is pinged (optional, default false)
parameters	optional URL parameter string appended when application is pinged (optional, no default)
onFailure	function to execute if the session has expired or other HTTP error code returned from ping (optional, default "function(response) { window.close();}")
asynchronous	true if the ping should be made asynchronously (optional, default true)
evalScripts	true if the ping results may contain JavaScript that should be evaluated (optional, default false)
method	the HTTP request method to use for the ping (optional, default "get")

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AjaxSessionPing.Action Internal WODirectAction subclass to handle the request from AjaxSessionPing.

Nested classes/interfaces inherited from class er.extensions.components.ERXDynamicElement

ERXDynamicElement.ContextData<T>

Field Summary

Fields inherited from class er.extensions.components.ERXDynamicElement

log

Fields inherited from class com.webobjects.appserver._private.WODynamicGroup

_children

Fields inherited from class com.webobjects.appserver.WODynamicElement

_ConstructorParameters

Constructor Summary

Constructors

Constructor and Description
AjaxSessionPing(String name, NSDictionary<String,com.webobjects.appserver.WOAssociation> associations, com.webobjects.appserver.WOElement children)

Method Summary

Modifier and Type	Method and Description
protected void	addRequiredWebResources(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Uses Prototype and Wonder
void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context) Appends script to start Ajax.ActivePeriodicalUpdater to the response.
NSDictionary	createAjaxOptions(com.webobjects.appserver.WOComponent component) Gathers the bindings into an AjaxOptions dictionary.
com.webobjects.appserver.WOActionResults	handleRequest(com.webobjects.appserver.WORequest request, com.webobjects.appserver.WOContext context) Unused.

Methods inherited from class er.ajax.AjaxDynamicElement

_containerID, addScriptResourceInHead, addScriptResourceInHead, addStylesheetResourceInHead, addStylesheetResourceInHead, invokeAction, shouldHandleRequest

Methods inherited from class er.extensions.components.ERXDynamicElement

afterProcessing, appendTagAttributeToResponse, arrayValueForBinding, arrayValueForBinding, associations, beforeProcessing, bindingIsSettable, bindingNamed, booleanValueForBinding, booleanValueForBinding, hasBinding, id, integerValueForBinding, nameInContext, secureInContext, setValueForBinding, stringValueForBinding, stringValueForBinding, valueForBinding, valueForBinding

Methods inherited from class com.webobjects.appserver._private.WODynamicGroup

addChildElement, appendChildrenToResponse, childrenElements, EmptyGroup, hasChildrenElements, invokeChildrenAction, takeChildrenValuesFromRequest, takeValuesFromRequest, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.ajax.IAjaxElement

valueForBinding, valueForBinding

Constructor Detail

AjaxSessionPing

public AjaxSessionPing(String name,
                       NSDictionary<String,com.webobjects.appserver.WOAssociation> associations,
                       com.webobjects.appserver.WOElement children)

Method Detail

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Appends script to start Ajax.ActivePeriodicalUpdater to the response.

Overrides:

appendToResponse in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction

createAjaxOptions

public NSDictionary createAjaxOptions(com.webobjects.appserver.WOComponent component)

Gathers the bindings into an AjaxOptions dictionary.

Parameters:

component - the component to evaluate the bindings in

Returns:

the bindings in the form of an AjaxOptions dictionary

handleRequest

public com.webobjects.appserver.WOActionResults handleRequest(com.webobjects.appserver.WORequest request,
                                                              com.webobjects.appserver.WOContext context)

Unused.

Specified by:

handleRequest in interface IAjaxElement

Specified by:

handleRequest in class AjaxDynamicElement

Parameters:

request - the current request

context - context of the transaction

Returns:

the action results

addRequiredWebResources

protected void addRequiredWebResources(com.webobjects.appserver.WOResponse response,
                                       com.webobjects.appserver.WOContext context)

Uses Prototype and Wonder

Specified by:

addRequiredWebResources in class AjaxDynamicElement

Parameters:

response - the current response

context - context of the transaction