wt.session
Interface SessionManagerSvr

All Known Implementing Classes:

StandardSessionManager

public interface SessionManagerSvr

Supported API: true

Extendable: false

Method Summary

boolean	isAccessEnforced() Returns true if access control was not reset through a 'setAccessEnforced (false)' call; returns false otherwise.
WTUser	refreshPrincipal() Refreshes principal stored in the SessionContext cache.
boolean	setAccessEnforced(boolean enforce) Suspends or resumes access control enforcement.

Method Detail

setAccessEnforced

public boolean setAccessEnforced(boolean enforce)

Suspends or resumes access control enforcement. If the argument is false then access control enforcement is suspended; otherwise it is resumed. This only happens if wt.access.enforce property is set to true (if it is set to false access control is never enforced). The method returns true if the access control was being enforced or false otherwise.

This method can be used to temporarily suspend access control enforcement using a try/finally block, in which the enforcement is suspended in the try block and restored in the finally block. The return value can be used to restore the value to whatever it was before the enforcement was suspended.

Supported API: true

Parameters:

enforce -

Returns:

boolean

isAccessEnforced

public boolean isAccessEnforced()

Returns true if access control was not reset through a 'setAccessEnforced (false)' call; returns false otherwise. The isAccessEnforced retrieves the state of access enforcement as set or reset by the setAccessEnforced method. It has no visibility to the wt.access.enforce property (in wt.properties).

Supported API: true

Returns:

boolean

refreshPrincipal

public WTUser refreshPrincipal()
                        throws WTException

Refreshes principal stored in the SessionContext cache. Returns refreshed principal if it exists, null otherwise.

Supported API: false

Returns:

WTUser

Throws:

WTException