to.etc.domui.state

Class UIContext

java.lang.Object

to.etc.domui.state.UIContext

public class UIContext
extends Object

A class which allows access to the page's context and related information. This is experimental. The PageContext is the root for all navigational information, and interfaces the pages and the server. This would usually be the task of the RequestContext, but that's an interface and I want the primary accessor to be in the same class.

Author:

Frits Jalvingh Created on Jun 22, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGIN_KEY

Constructor Summary

Constructors

Constructor and Description
UIContext()

Method Summary

Modifier and Type	Method and Description
static javax.servlet.http.Cookie	createLoginCookie(long l)
static boolean	deleteLoginCookie(IRequestContext rci)
static javax.servlet.http.Cookie	findCookie(String name) Find a cookie if it exists, return null otherwise.
static String	findCookieValue(String name)
static ConversationContext	getCurrentConversation()
static Page	getCurrentPage()
static IUser	getCurrentUser() Return the currently-known logged in user, or null if unknown/not logged in.
static IUser	getLoggedInUser() This returns the currently logged in user.
static IRequestContext	getRequestContext()
static <T> T	getSessionAttribute(Class<T> clz, String attrName) Returns session value of expected type.
static <T> T	getSessionAttribute(Class<T> clz, String attrName, T defaultValue) Returns session value of expected type.
static void	internalClear() This CLEARS all "current state" threadlocals.
static IRequestContext	internalGetContext()
static IUser	internalGetLoggedInUser(IRequestContext rx) UNSTABLE INTERFACE.
static Page	internalGetPage()
static void	internalSet(IRequestContext rc) Called when a new request is to be made current, or when the request has ended.
static void	internalSet(Page pg)
static boolean	login(String userid, String password) Logs in a user.
static void	logout() Logs out a user.
static void	registerTempFile(File tmpf) Register a file as a file/directory to be deleted when the conversation terminates.
static void	setCookie(String name, String value, int maxage) Set a new or overwrite an existing cookie.
static void	setSessionAttribute(String attrName, Object value) Sets session attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

LOGIN_KEY

public static final String LOGIN_KEY

Constructor Detail

UIContext

public UIContext()

Method Detail

getRequestContext

@Nonnull
public static IRequestContext getRequestContext()

internalSet

public static void internalSet(@Nonnull
                               IRequestContext rc)
                        throws Exception

Called when a new request is to be made current, or when the request has ended.

Parameters:

rc -

Throws:

Exception

internalClear

public static void internalClear()

This CLEARS all "current state" threadlocals.

internalSet

public static void internalSet(Page pg)

getCurrentPage

@Nonnull
public static Page getCurrentPage()

internalGetPage

@Nullable
public static Page internalGetPage()

internalGetContext

@Nullable
public static IRequestContext internalGetContext()

getCurrentConversation

@Nonnull
public static ConversationContext getCurrentConversation()

getCurrentUser

@Nullable
public static IUser getCurrentUser()

Return the currently-known logged in user, or null if unknown/not logged in. FIXME Should be named findCurrentUser().

Returns:

getLoggedInUser

@Nonnull
public static IUser getLoggedInUser()

This returns the currently logged in user. If the user is not logged in this throws a login exception which should cause the user to log in.

Returns:

registerTempFile

public static void registerTempFile(@Nonnull
                                    File tmpf)

Register a file as a file/directory to be deleted when the conversation terminates.

Parameters:

tmpf -

internalGetLoggedInUser

public static IUser internalGetLoggedInUser(IRequestContext rx)
                                     throws Exception

UNSTABLE INTERFACE. This tries to retrieve an IUser context for the user. It tries to retrieve a copy from the HttpSession. The AppSession is not used; this allows a login to persist when running in DEBUG mode, where AppSessions are destroyed when a class is changed.

Parameters:

rci -

Returns:

Throws:

Exception

login

public static boolean login(String userid,
                            String password)
                     throws Exception

Logs in a user. If he was logged in before he is logged out.

Parameters:

userid -

password -

Returns:

Throws:

Exception

logout

public static void logout()
                   throws Exception

Logs out a user.

Throws:

Exception

createLoginCookie

public static javax.servlet.http.Cookie createLoginCookie(long l)
                                                   throws Exception

Throws:

Exception

deleteLoginCookie

public static boolean deleteLoginCookie(IRequestContext rci)
                                 throws Exception

Throws:

Exception

findCookie

@Nullable
public static javax.servlet.http.Cookie findCookie(@Nonnull
                                                             String name)

Find a cookie if it exists, return null otherwise.

Parameters:

name -

Returns:

findCookieValue

@Nullable
public static String findCookieValue(@Nonnull
                                               String name)

setCookie

public static void setCookie(@Nonnull
                             String name,
                             String value,
                             int maxage)

Set a new or overwrite an existing cookie.

Parameters:

name -

value -

maxage - Max age, in seconds.

getSessionAttribute

public static <T> T getSessionAttribute(Class<T> clz,
                                        String attrName,
                                        T defaultValue)

Returns session value of expected type. Must be used within existing UIContext. In case that attribute is not stored in session, it would store defaultValue and return it. See {@link UIContext#getSessionAttribute(Class, String) See {@link UIContext#setSessionAttribute(String, Object)

Parameters:

clz -

attrName -

defaultValue -

Returns:

getSessionAttribute

public static <T> T getSessionAttribute(Class<T> clz,
                                        String attrName)

Returns session value of expected type. Must be used within existing UIContext.

Parameters:

clz -

attrName -

Returns:

In case that value is not stored returns null. In case of expected type mismatch throws IllegalStateException.

setSessionAttribute

public static void setSessionAttribute(String attrName,
                                       Object value)

Sets session attribute value.

Parameters:

attrName -

value -