Package com.aquima.interactions.portal.model.session

Class ActionHandlerContext

java.lang.Object

com.aquima.interactions.portal.model.session.PortalContextDelegate

com.aquima.interactions.portal.model.session.ActionHandlerContext

All Implemented Interfaces:

IActionContext, IPortalContext, IInternalPortalContext, Serializable

public final class ActionHandlerContext
extends PortalContextDelegate
implements IActionContext

Portal context implementation for action handlers.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionHandlerContext(PortalContext context, ReadWriteLock sessionLock, String name, Map<String,? extends Object> requestParameters, boolean isReadOnly)

Method Summary

Modifier and Type	Method	Description
String	getActionName()	This method returns the name of the action that is being executed.
IEntityInstance	getActiveInstance(String entityName)	Returns the active instance connected to the specified entity name.
IContentManagerFactory	getContentManagerFactory(PersistenceLevel persistence)	Returns a content manager factory for the current context and the given persistence level.
IDocumentEngine	getDocumentEngine()	This method returns a document engine for the current context.
IElementComposer	getElementComposer()	This method returns an element factory that may be used to expand pre-defined elements from the composer using the current container context.
IFlowScope	getFlowScope()	Retrieves the flow scope form the context.
IMappingComposer	getMappingComposer()	This method returns an element factory that may be used to expand pre-defined elements from the composer using the mapping context.
IPageScope	getPageScope()	Retrieves the page scope form the context.
InferenceContext	getProfile()	This method will return the current profile interface.
IRequestScope	getRequestScope()	Retrieves the request scope form the context.
ISessionScope	getSessionScope()	This object contains parameters and information the entire session.
void	pushActiveInstance(IEntityInstance instance)	This method will activate the instance in the current context.

Methods inherited from class com.aquima.interactions.portal.model.session.PortalContextDelegate

forModule, forModule, getApplication, getApplicationMode, getApplicationModel, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getComposer, getConfiguration, getConnectionManager, getContentManagerFactory, getContext, getCurrentFlow, getCurrentLanguage, getDebugger, getExpressionParser, getFactoryManager, getFlowEngine, getFunctionCallDefinitionManager, getId, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getProcessScope, getProject, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, restore

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.portal.IPortalContext

forModule, forModule, getApplicationMode, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getConnectionManager, getContentManagerFactory, getCurrentFlow, getCurrentLanguage, getDebugger, getExpressionParser, getFlowEngine, getFunctionCallDefinitionManager, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getProcessScope, getProject, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, restore

Constructor Details

ActionHandlerContext

protected ActionHandlerContext(PortalContext context,
 ReadWriteLock sessionLock,
 String name,
 Map<String,? extends Object> requestParameters,
 boolean isReadOnly)

Method Details

getElementComposer

public IElementComposer getElementComposer()

Description copied from interface: IPortalContext

This method returns an element factory that may be used to expand pre-defined elements from the composer using the current container context.

Specified by:

getElementComposer in interface IPortalContext

Overrides:

getElementComposer in class PortalContextDelegate

Returns:

An element factory that can be used to expand elements from the composer.

getMappingComposer

public IMappingComposer getMappingComposer()

Description copied from interface: IPortalContext

This method returns an element factory that may be used to expand pre-defined elements from the composer using the mapping context.

Specified by:

getMappingComposer in interface IPortalContext

Overrides:

getMappingComposer in class PortalContextDelegate

Returns:

An element factory that can be used to expand elements from the composer.

getContentManagerFactory

public IContentManagerFactory getContentManagerFactory(PersistenceLevel persistence)

Description copied from interface: IPortalContext

Returns a content manager factory for the current context and the given persistence level.

When the persistence level is temporary, the content created with the returned content manager factory and content manager will be deleted when a certain event occurs (eg. portal scope ends, a certain amount of time passes, etc.) The strategy used to delete the temporary content is determined by the underlying ITemporaryPersistenceStrategy in use.

When the persistence level is permanent, the content must explicitly be deleted from the connection when it is no longer needed.

Specified by:

getContentManagerFactory in interface IPortalContext

Overrides:

getContentManagerFactory in class PortalContextDelegate

Parameters:

persistence - the desired persistence level

Returns:

the content manager factory, never null

getDocumentEngine

public IDocumentEngine getDocumentEngine()

Description copied from interface: IPortalContext

This method returns a document engine for the current context.

Specified by:

getDocumentEngine in interface IPortalContext

Overrides:

getDocumentEngine in class PortalContextDelegate

Returns:

Document engine for the current session.

getRequestScope

public IRequestScope getRequestScope()

Description copied from interface: IPortalContext

Retrieves the request scope form the context. This object contains parameters and information about the request.

Specified by:

getRequestScope in interface IPortalContext

Overrides:

getRequestScope in class PortalContextDelegate

Returns:

A request scope corresponding to this request. Never null

See Also:

• IRequestScope

getActionName

public String getActionName()

Description copied from interface: IActionContext

This method returns the name of the action that is being executed.

Specified by:

getActionName in interface IActionContext

Returns:

the name of the action that is being executed.

pushActiveInstance

public void pushActiveInstance(IEntityInstance instance)

Description copied from interface: IPortalContext

This method will activate the instance in the current context. Once an instance has been activated in a portal context, the instance will stay active until the page flow the activation occurred in has been completed.

Specified by:

pushActiveInstance in interface IPortalContext

Overrides:

pushActiveInstance in class PortalContextDelegate

Parameters:

instance - The instance that should be activated.

getProfile

public InferenceContext getProfile()

Description copied from interface: IPortalContext

This method will return the current profile interface. In addition to the standard profile behavior, the implementation returned here will also automatically inference unknown values, and is aware of the instances that might have been activated during the page flow.

See also getUserProfile()

Specified by:

getProfile in interface IPortalContext

Overrides:

getProfile in class PortalContextDelegate

Returns:

Profile interface.

getPageScope

public IPageScope getPageScope()

Description copied from interface: IPortalContext

Retrieves the page scope form the context. This object contains parameters and information as long as the portal-engine is on the same page. After the page is left the scope is changed and is cleared to hold new properties bound to that page.

Specified by:

getPageScope in interface IPortalContext

Overrides:

getPageScope in class PortalContextDelegate

Returns:

The page-bound scope which is never null.

See Also:

• IPageScope

getSessionScope

public ISessionScope getSessionScope()

Description copied from interface: IPortalContext

This object contains parameters and information the entire session. This means from the portalsession is created until it has been destroyed. One could say the session scope lives at least as long as one is working with a specific application and profile.

Specified by:

getSessionScope in interface IPortalContext

Overrides:

getSessionScope in class PortalContextDelegate

Returns:

The session-bound scope which is never null.

See Also:

• ISessionScope

getFlowScope

public IFlowScope getFlowScope()

Description copied from interface: IPortalContext

Retrieves the flow scope form the context. This object contains parameters and information for the current flow. After the flow is left the scope is changed and is cleared to hold new properties bound to that flow.

Specified by:

getFlowScope in interface IPortalContext

Overrides:

getFlowScope in class PortalContextDelegate

Returns:

The flow-bound scope which is never null.

See Also:

• IFlowScope

getActiveInstance

public IEntityInstance getActiveInstance(String entityName)

Description copied from interface: IPortalContext

Returns the active instance connected to the specified entity name. An instance might have been activated in the following ways:

• The instance is a singleton, and therefore always active.
• The instance is activated through a container (only during page evaluation).
• The instance is activated by using the pushActiveInstance within the same flow.

Specified by:

getActiveInstance in interface IPortalContext

Overrides:

getActiveInstance in class PortalContextDelegate

Parameters:

entityName - The entity name for which the active instance is requested.

Returns:

The instance that is active for the specified entity type.