com.neurosys.domain

Class UserShell<U extends User,E>

java.lang.Object

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

Type Parameters:

U - as User

E - as Environment type the Shell holds. See getEnvironment()

All Implemented Interfaces:

Shell<E>, Serializable

Direct Known Subclasses:

WebUserShell

public class UserShell<U extends User,E>
extends Object
implements Shell<E>, Serializable

Any environment that needs a user context can use a UserShell

Any instance specific to the shell will not be accessible to a parent or child.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	deriveUserId() Override to derive custom User field for id.
<ES extends Shell<E>> ES	extend(Class<ES> extensionType, E e) Extend current shell, and return a new Shell with the current as its inner-shell (or Shell.parent()
Shell<E>	get(Class e) input type matches env or shell type [if environment type is not available], or is super of first sub-type that matches Fetch a particular inner Shell based on environment type it uses
AuthenticationToken	getAuthToken() Any AuthenticationToken granted;
E	getEnvironment() Returns the system set context, instance or environment for the current Shell
Shell<E>	getParent()
U	getUser()
Shell<E>	parent() Access to a parent (wrapped shell), unless there is no parent (null)
void	setAuthToken(AuthenticationToken authToken)
void	setEnvironment(E environment) Deprecated. See Constructor
void	setParent(Shell<E> parent)
void	setUser(U user)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserShell

public UserShell()

UserShell

public UserShell(E environment)

Parameters:

environment -

See Also:

setEnvironment(Object)

UserShell

public UserShell(Shell<E> parent)

UserShell

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

Parameters:

environment -

parent -

See Also:

setEnvironment(Object)

Method Detail

deriveUserId

public String deriveUserId()

Override to derive custom User field for id. The user object is guaranteed to be not null by #getUserId()

Returns:

String as id

getEnvironment

public E getEnvironment()

Returns the system set context, instance or environment for the current Shell

Example: In the case of Web, the environment can represent Session or a raw Context environment or App defined system context (like default page to load for user or role) not defined by user but the system.

Specified by:

getEnvironment in interface Shell<E>

Returns:

E

parent

public Shell<E> parent()
                throws AuthorizationException

Access to a parent (wrapped shell), unless there is no parent (null)

Specified by:

parent in interface Shell<E>

Returns:

S

Throws:

AuthorizationException

get

public Shell<E> get(Class e)
             throws AuthorizationException

input type matches env or shell type [if environment type is not available], or is super of first sub-type that matches

Fetch a particular inner Shell based on environment type it uses

Specified by:

get in interface Shell<E>

Parameters:

e - as Class of Shell type or Environment looking for. (implementation dependent)

Returns:

Shell

Throws:

AuthorizationException

extend

public <ES extends Shell<E>> ES extend(Class<ES> extensionType,
                                       E e)

Extend current shell, and return a new Shell with the current as its inner-shell (or Shell.parent()

Specified by:

extend in interface Shell<E>

Parameters:

extensionType - as Class of type of shell to return

e - as Environment

Returns:

extended Shell

getAuthToken

public AuthenticationToken getAuthToken()

Any AuthenticationToken granted;

Returns:

setAuthToken

public void setAuthToken(AuthenticationToken authToken)

getUser

public U getUser()

setUser

public void setUser(U user)

getParent

public Shell<E> getParent()

setParent

public void setParent(Shell<E> parent)

setEnvironment

@Deprecated
public void setEnvironment(E environment)

Deprecated. See Constructor

Returns the system set context, instance or environment for the current Shell

Example: In the case of Web, the environment can represent Session or a raw Context environment or App defined system context (like default page to load for user or role) not defined by user but the system.

NOTE: Since environment is system related, set it during construction not later

Specified by:

setEnvironment in interface Shell<E>