com.neurosys.site.model

Interface IBasicSession<U extends User,S extends Shell>

Type Parameters:

U -

S -

All Known Implementing Classes:

AdminSession, BasicSession, ContextualSession, EComSession

public interface IBasicSession<U extends User,S extends Shell>

Definition of a Basic User Session

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
AuthenticationToken	getAuthToken()
S	getShell() Some sessions may want to discourage access to the shell itself As a best practice avoid working with the shell directly, and create methods that internally call the shell from your session.
U	getUser()
String	getUserId() Get the userId for the Session.
void	setAuthToken(AuthenticationToken authToken)
void	setUser(U user)

Method Detail

getAuthToken

AuthenticationToken getAuthToken()

setAuthToken

void setAuthToken(AuthenticationToken authToken)

getUser

U getUser()

setUser

void setUser(U user)

getUserId

String getUserId()

Get the userId for the Session. A BasicSession type can use any user object or attribute to represent that as the id for the session. This could be the same as HttpSession.getId() or something custom like email, name etc.

Even though getUser() exists and this maybe derived from it, getUser() does not guarantee any convention on which attribute identifies the id we want for a session.

Returns:

String identifying the user of the session

See Also:

#deriveUserId()

Default value:

By default it returns #getUser()#getId() and if not user defined then gets the sessionId TODO: Add unit test case for user null, user not null but id null etc.

getShell

S getShell()
    throws AuthorizationException

Some sessions may want to discourage access to the shell itself
As a best practice avoid working with the shell directly, and create methods that internally call the shell from your session. (Composition)

Returns:

Throws:

AuthorizationException