com.neurosys.site.model

Class ContextualWebUserShell<U extends User,E>

java.lang.Object

com.neurosys.domain.UserShell<U,E>

com.neurosys.site.model.WebUserShell<U,E>

com.neurosys.site.model.ContextualWebUserShell<U,E>

Type Parameters:

U - as User

E - as ENVIRONEMNT like Session or System related environment

C - as Application/user defined context - Implied Object as generic signature getting too long

All Implemented Interfaces:

Shell<E>, Serializable

Direct Known Subclasses:

EComUserShell

public class ContextualWebUserShell<U extends User,E>
extends WebUserShell<U,E>

Allows the shell to have a User/Application defined context. Unlike UserShell.getEnvironment() which is System/Environment related.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContextualWebUserShell()
ContextualWebUserShell(E environment)
ContextualWebUserShell(E environment, Shell<E> parent)
ContextualWebUserShell(Shell<E> parent)

Method Summary

Modifier and Type	Method and Description
<C> C	getContext() Additional context that maybe provided by the user in the Session. Note: CONTEXTS can be processed further, in the default design this is intended to be the raw CONTEXT set directly by the client Difference between UserShell.setEnvironment(Object) nad setContext(Object) is that context is set by user, while environment is set by the system and should be immutable.
<C> void	setContext(C context) Additional context that maybe provided by the user in the Session. Note: CONTEXTS can be processed further, in the default design this is intended to be the raw CONTEXT set directly by the client Difference between UserShell.setEnvironment(Object) nad setContext(Object) is that context is set by user, while environment is set by the system and should be immutable.
void	setPartialContext(Object context) The context object may have multiple properties.

Methods inherited from class com.neurosys.domain.UserShell

deriveUserId, extend, get, getAuthToken, getEnvironment, getParent, getUser, parent, setAuthToken, setEnvironment, setParent, setUser

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextualWebUserShell

public ContextualWebUserShell()

ContextualWebUserShell

public ContextualWebUserShell(E environment)

ContextualWebUserShell

public ContextualWebUserShell(Shell<E> parent)

ContextualWebUserShell

public ContextualWebUserShell(E environment,
                              Shell<E> parent)

Method Detail

getContext

public <C> C getContext()

Additional context that maybe provided by the user in the Session.
Note: CONTEXTS can be processed further, in the default design this is intended to be the raw CONTEXT set directly by the client

Difference between UserShell.setEnvironment(Object) nad setContext(Object) is that context is set by user, while environment is set by the system and should be immutable.

Example: PersistenceConfiguration.Strategy's use context for more advanced and custom scenarios

setContext

public <C> void setContext(C context)

Additional context that maybe provided by the user in the Session.
Note: CONTEXTS can be processed further, in the default design this is intended to be the raw CONTEXT set directly by the client

Difference between UserShell.setEnvironment(Object) nad setContext(Object) is that context is set by user, while environment is set by the system and should be immutable.

Example: PersistenceConfiguration.Strategy's use context for more advanced and custom scenarios

setPartialContext

public void setPartialContext(Object context)

The context object may have multiple properties. While setContext(Object) overrides all existing data in it this method can be used to allow partial updation of data. In cases where the context is a Collection, Map, JSON etc.

It provides the application an opportunity to safely update an existing context without overriding everything. Difference between UserShell.setEnvironment(Object) nad setContext(Object) is that context is set by user, while environment is set by the system and should be immutable.

The default implementation this is same as setContext(Object)

Parameters:

context - as Object