com.ibm.hats.common.AppletSettings

For the com.ibm.hats.common.AppletSettings class, name specifies a customizable setting for the HATS application automatic disconnect and refresh implementation methods, Client pull (AJAX) and Server push (applet). The following settings can be used to configure the Client pull (AJAX) method, including the auto-disconnect and auto-refresh functions. These settings are supported for HATS Web applications, including JSR 286 portlets.

browserDisconnectDelay

Effective when the enable setting is ajax and the browserDisconnectEnabled setting is true. The time in milliseconds to wait before performing the auto-disconnect function. The minimum value is 2000 milliseconds (2 seconds). The default is 15000 milliseconds (15 seconds).

browserDisconnectEnabled

If the enable setting is ajax, and if this setting is true, enables the auto-disconnect function. If enabled, the HATS application initiates a disconnect action if the client has not polled the HATS application within the time specified by the browserDisconnectDelay setting.

browserPollInterval

Effective when the enable setting is ajax. The interval in milliseconds at which the browser will poll the HATS application to restart the browserDisconnectDelay timer, if enabled, and check for host screen updates. The minimum value is 1000 milliseconds (1 second). If browserDisconnectEnabled is true, then the poll interval value must be less than the value in the browserDisconnectDelay setting by at least 1000 milliseconds (1 second). The default is 5000 milliseconds (5 seconds).

Note:

If an HTTP session idle timeout is configured, browser polling of the HATS application effectively disables the HTTP session idle timeout functionality. Because of this, the HATS runtime takes responsibility for monitoring the HTTP session idle timeout period and initiates a disconnect of the HATS session when no user activity is seen before the idle time is exceeded.

browserRefreshEnabled

If the enable setting is ajax, and if this setting is true, enables the auto-refresh function. If enabled, the browser initiates a refresh of the screen if there has been no user input and the poll response indicates that the host screen has changed.

enable

Use this setting to configure which automatic disconnect and refresh method to use. Specify ajax to configure the Client pull (AJAX) methods, auto-disconnect and auto-refresh. Specify true to configure the Server push (applet) method, also known as the asynchronous applet update method. Specify false to disable both of the methods. The default is false.

Refer to the section, Using the server push (applet) method for a description of the settings for the Server push (applet) method.