com.mendix.systemwideinterfaces.core

Interface ISession

public interface ISession

Session interface.

Method Summary

Modifier and Type	Method and Description
void	addToClientRoots(IMendixIdentifier id) Not for public use
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.util.Set<IMendixIdentifier>	getClientRoots()
com.mendix.core.component.LocalComponent	getComponent() Deprecated. Access to LocalComponent will not be possible anymore from the next major release onwards.
java.lang.String	getCsrfToken()
java.util.Map<java.lang.String,java.lang.Object>	getData() Deprecated. There are two alternatives, based on the required behavior: 1. Using IContext.getData() for data that requires the life-time of the current request only 2. Using an entity for data that has to live in this session spanning multiple requests (entity does not have to be committed for this to work)
java.util.Set<java.lang.String>	getGrantableRoleNames()
java.util.UUID	getId() Get session id.
java.util.Set<IMendixIdentifier>	getJavaActionRoots()
ILanguage	getLanguage()
java.util.Date	getLastActive()
IMendixObject	getMendixObject()
com.mendix.core.session.SessionDestroyer	getSessionDestroyer()
java.util.TimeZone	getTimeZone()
IUser	getUser() Get user.
java.lang.String	getUserAgent()
java.util.Set<java.lang.String>	getUserRolesNames()
boolean	isInteractive()
boolean	isSystemSession()
void	keepAlive() Refresh last active time.
void	release(IMendixIdentifier id) Deprecated. use an object associated with System.Session instead.
void	removeFromClientRoots(IMendixIdentifier id) Not for public use
void	retain(IMendixObject mxObject) Deprecated. use an object associated with System.Session instead.
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)

getComponent

@Deprecated
com.mendix.core.component.LocalComponent getComponent()

Deprecated. Access to LocalComponent will not be possible anymore from the next major release onwards.

getUser

IUser getUser()

Get user.

Returns:

session user object

getLanguage

ILanguage getLanguage()

Returns:

language object

keepAlive

void keepAlive()
        throws com.mendix.core.CoreException

Refresh last active time.

Throws:

com.mendix.core.CoreException

getUserRolesNames

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

Returns:

user role names

getGrantableRoleNames

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

Returns:

grantable role names

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.

retain

@Deprecated
void retain(IMendixObject mxObject)

Deprecated. use an object associated with System.Session instead.

Retain the given object in the java action roots, such that will not be garbage collected.

Parameters:

mxObject - the object to add to the java action roots.

release

@Deprecated
void release(IMendixIdentifier id)

Deprecated. use an object associated with System.Session instead.

Remove the given id from the java action roots, such that it can be garbage collected.

Parameters:

id - the id to remove from the java action roots.

removeFromClientRoots

void removeFromClientRoots(IMendixIdentifier id)

Not for public use

addToClientRoots

void addToClientRoots(IMendixIdentifier id)

Not for public use

getSessionDestroyer

com.mendix.core.session.SessionDestroyer getSessionDestroyer()

getClientRoots

java.util.Set<IMendixIdentifier> getClientRoots()

getJavaActionRoots

java.util.Set<IMendixIdentifier> getJavaActionRoots()

setUserAgent

void setUserAgent(java.lang.String userAgent)

getData

@Deprecated
java.util.Map<java.lang.String,java.lang.Object> getData()

Deprecated. There are two alternatives, based on the required behavior: 1. Using IContext.getData() for data that requires the life-time of the current request only 2. Using an entity for data that has to live in this session spanning multiple requests (entity does not have to be committed for this to work)

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.