com.mendix.systemwideinterfaces.core

Interface ISession

public interface ISession

Session interface.

Method Summary

Modifier and Type	Method and Description
IContext	createContext() Create new context.
IContext	createContext(IContext.ExecutionType executionType)
void	destroy() Destroy this session, so that the garbage collector can reclaim memory held by this session.
java.lang.String	getCsrfToken()
java.util.Set<java.lang.String>	getGrantableRoleNames()
java.util.UUID	getId() Get session id.
ILanguage	getLanguage() Deprecated. Use method getUser(IContext).getLanguage() instead.
java.util.Date	getLastActive()
IMendixObject	getMendixObject()
java.util.TimeZone	getTimeZone()
IUser	getUser() Deprecated. Use method getUser(IContext) instead. Get user.
IUser	getUser(IContext context) Get user.
java.lang.String	getUserAgent()
IMendixIdentifier	getUserId()
java.lang.String	getUserName()
java.util.Set<java.lang.String>	getUserRolesNames()
boolean	isInteractive()
boolean	isSystemSession()
void	keepAlive() Refresh last active time.
void	setTimeZone(java.lang.Integer timezoneOffset) Overrides the timezone by a simple timezone based on an offset.
void	setUserAgent(java.lang.String userAgent)

Method Detail

getId

java.util.UUID getId()

Get session id.

Returns:

session id

createContext

IContext createContext()

Create new context.

Returns:

context

createContext

IContext createContext(IContext.ExecutionType executionType)

getUser

@Deprecated
IUser getUser()

Deprecated. Use method getUser(IContext) instead.

Get user.

Returns:

session user object

getUser

IUser getUser(IContext context)

Get user.

Parameters:

context -

Returns:

session user object

getUserName

java.lang.String getUserName()

Returns:

session user name

getUserId

IMendixIdentifier getUserId()

Returns:

session user id

getLanguage

@Deprecated
ILanguage getLanguage()

Deprecated. Use method getUser(IContext).getLanguage() instead.

Returns:

language object

keepAlive

void keepAlive()
        throws CoreException

Refresh last active time.

Throws:

CoreException

getUserRolesNames

java.util.Set<java.lang.String> getUserRolesNames()

getGrantableRoleNames

java.util.Set<java.lang.String> getGrantableRoleNames()

isSystemSession

boolean isSystemSession()

Returns:

is systemsession

getTimeZone

java.util.TimeZone getTimeZone()

Returns:

the timezone of the user associated with this session

setTimeZone

void setTimeZone(java.lang.Integer timezoneOffset)

Overrides the timezone by a simple timezone based on an offset. Does not take into account daylight savings time. Used for setting timezone obtained from browser with Javascript.

Parameters:

timezoneOffset - the timezone offset in negative amount of minutes from UTC, like how Javascript supplies it. See http://www.w3schools.com/jsref/jsref_gettimezoneoffset.asp

getUserAgent

java.lang.String getUserAgent()

Returns:

the user agent for this session.

setUserAgent

void setUserAgent(java.lang.String userAgent)

isInteractive

boolean isInteractive()

Returns:

whether the session can be used interactively ('real' user), defaults to true.

destroy

void destroy()

Destroy this session, so that the garbage collector can reclaim memory held by this session. This will: 1. Delete autocommitted objects 2. Delete the state store for this session 3. Delete the action dispatcher for this session.

getMendixObject

IMendixObject getMendixObject()

getLastActive

java.util.Date getLastActive()

Returns:

the last active date and time for this session.

getCsrfToken

java.lang.String getCsrfToken()

Returns:

the CSRF token.