Package com.aquima.web

Class AquimaSession

java.lang.Object

com.aquima.web.AquimaSession

All Implemented Interfaces:

com.aquima.interactions.foundation.concurrent.Interruptible, com.blueriq.component.api.IAquimaSession, com.blueriq.component.api.session.IAquimaSessionLifecycle, Serializable

public class AquimaSession
extends Object
implements com.blueriq.component.api.IAquimaSession

Wrapper for an IPortalSession for in web applications.

Since:

8.0

Author:

Danny Roest

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AquimaSession(com.aquima.interactions.portal.IPortalSession portalSession, com.aquima.interactions.portal.IApplication application, com.blueriq.component.api.IAquimaEngineConfiguration config, String name)	Creates an Aquima session with an automatically generated session id.
AquimaSession(String sessionId, com.aquima.interactions.portal.IPortalSession portalSession, com.aquima.interactions.portal.IApplication application, com.blueriq.component.api.IAquimaEngineConfiguration config, String name)	Creates an Aquima session with an externally provided session id.

Method Summary

Modifier and Type	Method	Description
void	activate(com.blueriq.component.api.session.IAquimaSessionActivationContext sessionActivationContext)
boolean	close()
com.aquima.interactions.portal.IActionResult	executeAction(String handlerName, Map<String,?> parameters)
com.aquima.interactions.portal.IActionResult	executeInlineAction(com.aquima.interactions.portal.IActionHandler actionHandler, Map<String,?> parameters)
Date	getAccessTime()
com.blueriq.component.api.ui.IAquimaUi	getAquimaUi()
String	getCsrfToken()
com.aquima.interactions.metamodel.Channel	getCurrentChannel()
com.aquima.interactions.foundation.text.ILanguage	getCurrentLanguage()
com.aquima.interactions.composer.IPage	getCurrentPage()
com.aquima.interactions.project.IUserData	getCurrentUser()
com.aquima.interactions.portal.ISessionMonitor	getMonitor()
String	getName()
com.aquima.interactions.portal.IPortalSession	getPortalSession()
com.blueriq.component.api.IProjectDetails	getProjectDetails()
String	getRequestWard()
String	getSessionId()
Serializable	getSessionScopeAttribute(String key)
Date	getStartTime()
String	getTestPath()
String	getTheme()
com.aquima.interactions.project.IValueFormatDefinition	getValueFormatDefinition(com.aquima.interactions.foundation.DataType type)
void	handleEvent(com.aquima.interactions.portal.PortalEvent portalEvent)
void	interrupt()
boolean	isInterrupted()
void	notifyAccess()
void	passivate()
void	recompose()
final String	renewCsrfToken()
final String	renewRequestWard()
void	setAquimaUi(String name)
void	setLanguage(String languageCode)
Serializable	setSessionScopeAttribute(String key, Serializable value)
void	setTheme(String theme)
void	startFlow(String name)
void	startFlow(String name, boolean allowUnexposedFlows, Map<String,Serializable> parameters)
void	stopFlow(boolean commitPendingChanges)

Methods inherited from class java.lang.Object

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

Constructor Details

AquimaSession

public AquimaSession(com.aquima.interactions.portal.IPortalSession portalSession,
 com.aquima.interactions.portal.IApplication application,
 com.blueriq.component.api.IAquimaEngineConfiguration config,
 String name)

Creates an Aquima session with an automatically generated session id.

Parameters:

portalSession - the aquima portal session

application - the application that is started in this session

config - the configuration

name - the name of the session

AquimaSession

public AquimaSession(String sessionId,
 com.aquima.interactions.portal.IPortalSession portalSession,
 com.aquima.interactions.portal.IApplication application,
 com.blueriq.component.api.IAquimaEngineConfiguration config,
 String name)

Creates an Aquima session with an externally provided session id.

Parameters:

sessionId - the session id, must not be null or empty

portalSession - the aquima portal session

application - the application that is started in this session

config - the configuration

name - the name of the session

Method Details

startFlow

public void startFlow(String name)

Specified by:

startFlow in interface com.blueriq.component.api.IAquimaSession

startFlow

public void startFlow(String name,
 boolean allowUnexposedFlows,
 Map<String,Serializable> parameters)

Specified by:

startFlow in interface com.blueriq.component.api.IAquimaSession

stopFlow

public void stopFlow(boolean commitPendingChanges)

Specified by:

stopFlow in interface com.blueriq.component.api.IAquimaSession

handleEvent

public void handleEvent(com.aquima.interactions.portal.PortalEvent portalEvent)

Specified by:

handleEvent in interface com.blueriq.component.api.IAquimaSession

executeInlineAction

public com.aquima.interactions.portal.IActionResult executeInlineAction(com.aquima.interactions.portal.IActionHandler actionHandler,
 Map<String,?> parameters)

Specified by:

executeInlineAction in interface com.blueriq.component.api.IAquimaSession

executeAction

public com.aquima.interactions.portal.IActionResult executeAction(String handlerName,
 Map<String,?> parameters)

Specified by:

executeAction in interface com.blueriq.component.api.IAquimaSession

setTheme

public void setTheme(String theme)

Specified by:

setTheme in interface com.blueriq.component.api.IAquimaSession

setLanguage

public void setLanguage(String languageCode)

Specified by:

setLanguage in interface com.blueriq.component.api.IAquimaSession

close

public boolean close()

Specified by:

close in interface com.blueriq.component.api.IAquimaSession

getCurrentPage

public com.aquima.interactions.composer.IPage getCurrentPage()

Specified by:

getCurrentPage in interface com.blueriq.component.api.IAquimaSession

getCurrentLanguage

public com.aquima.interactions.foundation.text.ILanguage getCurrentLanguage()

Specified by:

getCurrentLanguage in interface com.blueriq.component.api.IAquimaSession

getAquimaUi

public com.blueriq.component.api.ui.IAquimaUi getAquimaUi()

Specified by:

getAquimaUi in interface com.blueriq.component.api.IAquimaSession

setAquimaUi

public void setAquimaUi(String name)

Specified by:

setAquimaUi in interface com.blueriq.component.api.IAquimaSession

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface com.blueriq.component.api.IAquimaSession

getCsrfToken

public String getCsrfToken()

Specified by:

getCsrfToken in interface com.blueriq.component.api.IAquimaSession

renewCsrfToken

public final String renewCsrfToken()

Specified by:

renewCsrfToken in interface com.blueriq.component.api.IAquimaSession

getRequestWard

public String getRequestWard()

Specified by:

getRequestWard in interface com.blueriq.component.api.IAquimaSession

renewRequestWard

public final String renewRequestWard()

Specified by:

renewRequestWard in interface com.blueriq.component.api.IAquimaSession

getPortalSession

public com.aquima.interactions.portal.IPortalSession getPortalSession()

Specified by:

getPortalSession in interface com.blueriq.component.api.IAquimaSession

getTheme

public String getTheme()

Specified by:

getTheme in interface com.blueriq.component.api.IAquimaSession

getValueFormatDefinition

public com.aquima.interactions.project.IValueFormatDefinition getValueFormatDefinition(com.aquima.interactions.foundation.DataType type)

Specified by:

getValueFormatDefinition in interface com.blueriq.component.api.IAquimaSession

getProjectDetails

public com.blueriq.component.api.IProjectDetails getProjectDetails()

Specified by:

getProjectDetails in interface com.blueriq.component.api.IAquimaSession

getStartTime

public Date getStartTime()

Specified by:

getStartTime in interface com.blueriq.component.api.IAquimaSession

getMonitor

public com.aquima.interactions.portal.ISessionMonitor getMonitor()

Specified by:

getMonitor in interface com.blueriq.component.api.IAquimaSession

getCurrentUser

public com.aquima.interactions.project.IUserData getCurrentUser()

Specified by:

getCurrentUser in interface com.blueriq.component.api.IAquimaSession

getTestPath

public String getTestPath()

Specified by:

getTestPath in interface com.blueriq.component.api.IAquimaSession

getCurrentChannel

public com.aquima.interactions.metamodel.Channel getCurrentChannel()

Specified by:

getCurrentChannel in interface com.blueriq.component.api.IAquimaSession

recompose

public void recompose()

Specified by:

recompose in interface com.blueriq.component.api.IAquimaSession

getSessionScopeAttribute

public Serializable getSessionScopeAttribute(String key)

Specified by:

getSessionScopeAttribute in interface com.blueriq.component.api.IAquimaSession

setSessionScopeAttribute

public Serializable setSessionScopeAttribute(String key,
 Serializable value)

Specified by:

setSessionScopeAttribute in interface com.blueriq.component.api.IAquimaSession

getName

public String getName()

Specified by:

getName in interface com.blueriq.component.api.IAquimaSession

getAccessTime

public Date getAccessTime()

Specified by:

getAccessTime in interface com.blueriq.component.api.IAquimaSession

notifyAccess

public void notifyAccess()

Specified by:

notifyAccess in interface com.blueriq.component.api.IAquimaSession

activate

public void activate(com.blueriq.component.api.session.IAquimaSessionActivationContext sessionActivationContext)

Specified by:

activate in interface com.blueriq.component.api.session.IAquimaSessionLifecycle

passivate

public void passivate()

Specified by:

passivate in interface com.blueriq.component.api.session.IAquimaSessionLifecycle

interrupt

public void interrupt()

Specified by:

interrupt in interface com.aquima.interactions.foundation.concurrent.Interruptible

isInterrupted

public boolean isInterrupted()

Specified by:

isInterrupted in interface com.aquima.interactions.foundation.concurrent.Interruptible