oracle.adf.view.rich.context

Class WindowManagerContext

java.lang.Object

oracle.adf.view.rich.context.WindowManagerContext

public class WindowManagerContext
extends Object

Utility for programmatically manage the rich window manager's configuration values.

For example:

   ExternalContext extContext = FacesContext.getCurrentInstance().getExternalContext();
   RequestContext rc = RequestContext.getCurrentInstance();
   WindowManagerContext wmContext = new WindowManagerContext(rc.getWindowManager());
   wmContext.setMaxWindowCacheSize(extContext, 100);
 

Constructor Summary

Constructors

Constructor and Description
WindowManagerContext(org.apache.myfaces.trinidad.context.WindowManager wm)

Method Summary

Modifier and Type	Method and Description
int	getLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext extContext) Returns the session timeout in seconds applied when the last window moves to an unloaded state.
int	getMaxWindowCacheSize(javax.faces.context.ExternalContext extContext) Returns the maximum number of windows can be in session cache.
int	getUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext extContext) Returns the number of seconds before an unloaded window will implicitly transition to a closed state.
void	setLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext extContext, int timeout) Sets the session timeout in seconds applied when the last window moves to an unloaded state.
void	setMaxWindowCacheSize(javax.faces.context.ExternalContext extContext, int maxSize) Sets the maximum number of windows can be in session cache.
void	setUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext extContext, int timeout) Sets the number of seconds before an unloaded window will implicitly transition to a closed state.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowManagerContext

public WindowManagerContext(org.apache.myfaces.trinidad.context.WindowManager wm)

Method Detail

getLastWindowSessionTimeoutInterval

public int getLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext extContext)

Returns the session timeout in seconds applied when the last window moves to an unloaded state. Unloaded windows represent closed browser windows or browser windows that have navigated away from the application. The value will be applied to the setMaxInactiveInterval of the active session. The default value is -1, indicating the feature is disabled.

This interval can also be configured using a web deployment descriptor context-param. The value can be set via the LAST_WINDOW_SESSION_TIMEOUT context-param in the web.xml of the web application.

Parameters:

extContext - ExternalContext

Returns:

interval overridding the session's maxInactiveInterval after the last window moves to an unloaded state

See Also:

setLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext, int)

setLastWindowSessionTimeoutInterval

public void setLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext extContext,
                                                int timeout)

Sets the session timeout in seconds applied when the last window moves to an unloaded state. Unloaded windows represent closed browser windows or browser windows that have navigated away from the application. The value will be applied to the setMaxInactiveInterval of the active session. The default value is -1, indicating the feature is disabled. The default can also be configured using a web deployment descriptor context-param. The value can be set via the LAST_WINDOW_SESSION_TIMEOUT context-param in the web.xml of the web application. The value set from this API will override any value specified using a context-paramenter.

Parameters:

extContext - ExternalContext

timeout - interval in seconds

See Also:

getLastWindowSessionTimeoutInterval(javax.faces.context.ExternalContext)

getUnloadedWindowCloseTimeoutInterval

public int getUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext extContext)

Returns the number of seconds before an unloaded window will implicitly transition to a closed state. Unloaded windows represent closed browser windows or browser windows that have navigated to another application. Moving the window to the closed state releases associated resources cached in session state. The default is 300 seconds (5 minutes).

This interval can also be configured via the UNLOADED_WINDOW_CLOSE_TIMEOUTweb deployment descriptor context-param.

Parameters:

extContext - ExternalContext

Returns:

interval in seconds a unloaded window will transition to a closed state.

See Also:

setUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext, int)

setUnloadedWindowCloseTimeoutInterval

public void setUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext extContext,
                                                  int timeout)

Sets the number of seconds before an unloaded window will implicitly transition to a closed state. Unloaded windows represent closed browser windows or browser windows that have navigated to another application. Moving the window to the closed state releases associated resources cached in session state. The default is 300 seconds (5 minutes).

The default can also be configured via the UNLOADED_WINDOW_CLOSE_TIMEOUTweb deployment descriptor context-param. Setting the value from this API will override any value configured via a context-param

Parameters:

extContext - ExternalContext

timeout - interval in seconds

See Also:

getUnloadedWindowCloseTimeoutInterval(javax.faces.context.ExternalContext)

getMaxWindowCacheSize

public int getMaxWindowCacheSize(javax.faces.context.ExternalContext extContext)

Returns the maximum number of windows can be in session cache. Once the threshold has been reached, the most infrequently used window will implicitly move to a closed state for the most recent window open request. The default will be 1000. The default can also be configured via the MAX_WINDOW_CACHE_SIZE context-param in the web deployment descriptor.

Parameters:

extContext - ExternalContext

Returns:

maximum number of windows allowed in session cache

See Also:

setMaxWindowCacheSize(javax.faces.context.ExternalContext, int)

setMaxWindowCacheSize

public void setMaxWindowCacheSize(javax.faces.context.ExternalContext extContext,
                                  int maxSize)

Sets the maximum number of windows can be in session cache. Once the threshold has been reached, the most infrequently used window will implicitly move to a closed state for the most recent window open request. The default will be 1000. The default can also be configured via the MAX_WINDOW_CACHE_SIZE context-param in the web deployment descriptor.

Parameters:

extContext - ExternalContext

maxSize - of the window session cache

See Also:

getMaxWindowCacheSize(javax.faces.context.ExternalContext)