Package org.adempiere.webui.session

Class SessionContextListener

java.lang.Object

org.adempiere.webui.session.SessionContextListener

All Implemented Interfaces:

org.zkoss.zk.ui.event.EventThreadInit, org.zkoss.zk.ui.util.DesktopCleanup, org.zkoss.zk.ui.util.DesktopInit, org.zkoss.zk.ui.util.ExecutionCleanup, org.zkoss.zk.ui.util.ExecutionInit

public class SessionContextListener
extends Object
implements org.zkoss.zk.ui.util.ExecutionInit, org.zkoss.zk.ui.util.ExecutionCleanup, org.zkoss.zk.ui.event.EventThreadInit, org.zkoss.zk.ui.util.DesktopCleanup, org.zkoss.zk.ui.util.DesktopInit

Zk listener to manage environment context for execution and session

Author:

Ashley G Ramdass

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVLET_SESSION_ID
static final String	SESSION_CTX

Constructor Summary

Constructors

Constructor	Description
SessionContextListener()

Method Summary

Modifier and Type	Method	Description
static void	addDesktopId(int AD_Session_ID, String dtid)	Add dtid to session context
void	cleanup(org.zkoss.zk.ui.Desktop desktop)
void	cleanup(org.zkoss.zk.ui.Execution exec, org.zkoss.zk.ui.Execution parent, List<Throwable> errs)
static String	getSessionDesktopListKey(int AD_Session_ID)	Get context attribute key for session desktop list
boolean	init(org.zkoss.zk.ui.Component comp, org.zkoss.zk.ui.event.Event evt)
void	init(org.zkoss.zk.ui.Desktop desktop, Object request)
void	init(org.zkoss.zk.ui.Execution exec, org.zkoss.zk.ui.Execution parent)
static boolean	isContextValid()	Is current context valid
void	prepare(org.zkoss.zk.ui.Component comp, org.zkoss.zk.ui.event.Event evt)	get from servlet thread's ThreadLocal
static void	setupExecutionContextFromSession(org.zkoss.zk.ui.Execution exec)	Get environment context from session cache or create a new one (if no cache context or cache context is invalid)

Methods inherited from class java.lang.Object

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

Field Details

SERVLET_SESSION_ID

public static final String SERVLET_SESSION_ID

See Also:

• Constant Field Values

SESSION_CTX

public static final String SESSION_CTX

See Also:

• Constant Field Values

Constructor Details

SessionContextListener

public SessionContextListener()

Method Details

setupExecutionContextFromSession

public static void setupExecutionContextFromSession(org.zkoss.zk.ui.Execution exec)

Get environment context from session cache or create a new one (if no cache context or cache context is invalid)

Parameters:

exec -

init

public void init(org.zkoss.zk.ui.Execution exec,
 org.zkoss.zk.ui.Execution parent)

Specified by:

init in interface org.zkoss.zk.ui.util.ExecutionInit

Parameters:

exec -

parent -

See Also:

• ExecutionInit.init(Execution, Execution)

cleanup

public void cleanup(org.zkoss.zk.ui.Execution exec,
 org.zkoss.zk.ui.Execution parent,
 List<Throwable> errs)

Specified by:

cleanup in interface org.zkoss.zk.ui.util.ExecutionCleanup

Parameters:

exec -

parent -

errs -

See Also:

• ExecutionCleanup.cleanup(Execution, Execution, List)

prepare

public void prepare(org.zkoss.zk.ui.Component comp,
 org.zkoss.zk.ui.event.Event evt)

get from servlet thread's ThreadLocal

Specified by:

prepare in interface org.zkoss.zk.ui.event.EventThreadInit

Parameters:

comp -

evt -

See Also:

• EventThreadInit.prepare(Component, Event)

init

public boolean init(org.zkoss.zk.ui.Component comp,
 org.zkoss.zk.ui.event.Event evt)

Specified by:

init in interface org.zkoss.zk.ui.event.EventThreadInit

Parameters:

comp -

evt -

See Also:

• EventThreadInit.init(Component, Event)

isContextValid

public static boolean isContextValid()

Is current context valid

Returns:

true if current context is valid

cleanup

public void cleanup(org.zkoss.zk.ui.Desktop desktop)
             throws Exception

Specified by:

cleanup in interface org.zkoss.zk.ui.util.DesktopCleanup

Throws:

Exception

init

public void init(org.zkoss.zk.ui.Desktop desktop,
 Object request)
          throws Exception

Specified by:

init in interface org.zkoss.zk.ui.util.DesktopInit

Throws:

Exception

addDesktopId

public static void addDesktopId(int AD_Session_ID,
 String dtid)

Add dtid to session context

Parameters:

AD_Session_ID -

dtid - desktop id

getSessionDesktopListKey

public static String getSessionDesktopListKey(int AD_Session_ID)

Get context attribute key for session desktop list

Parameters:

AD_Session_ID -

Returns:

desktop list key