de.innovationgate.wgpublisher.so

Class SessionScopeResolver

java.lang.Object

de.innovationgate.wgpublisher.so.SessionScopeResolver

All Implemented Interfaces:

ScopeResolver

public class SessionScopeResolver
extends java.lang.Object
implements ScopeResolver

Constructor Summary

Constructors

Constructor and Description
SessionScopeResolver()

Method Summary

Methods

Modifier and Type	Method and Description
static ScopeObjectRegistry	getRegistry(javax.servlet.http.HttpSession session, java.lang.String dbKey, boolean create)
boolean	isApplicationEventReceiver(Event.Scope scope) Returns if this scope receives events of the given event scope
boolean	needsWebsockets() Returns if websockets are required
void	notifyScopeObjectStateChange(ScopeObjectRegistry.ScopeObject scopeObject, WGA wga, DesignResourceReference ref) Should be called when a scope object has changed its state, so the resolver can trigger necessary actions to persist this state
java.util.List<ApplicationEventReceiver>	resolveApplicationEventReceivers(WGA wga, java.lang.String dbKey, Event event) Resolves object registries that receive application events in this scope
ScopeObjectRegistry	resolveObjectRegistry(WGA wga, DesignResourceReference ref) Resolves the object registry for the current scope in the current environment

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionScopeResolver

public SessionScopeResolver()

Method Detail

resolveObjectRegistry

public ScopeObjectRegistry resolveObjectRegistry(WGA wga,
                                        DesignResourceReference ref)
                                          throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeResolver

Resolves the object registry for the current scope in the current environment

Specified by:

resolveObjectRegistry in interface ScopeResolver

Parameters:

wga - The environment

ref - Reference of an object that is to be created. Resolvers may choose their resolving strategy based on this.

Returns:

A registry

Throws:

de.innovationgate.webgate.api.WGException

getRegistry

public static ScopeObjectRegistry getRegistry(javax.servlet.http.HttpSession session,
                              java.lang.String dbKey,
                              boolean create)
                                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

isApplicationEventReceiver

public boolean isApplicationEventReceiver(Event.Scope scope)

Description copied from interface: ScopeResolver

Returns if this scope receives events of the given event scope

Specified by:

isApplicationEventReceiver in interface ScopeResolver

resolveApplicationEventReceivers

public java.util.List<ApplicationEventReceiver> resolveApplicationEventReceivers(WGA wga,
                                                                        java.lang.String dbKey,
                                                                        Event event)
                                                                          throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeResolver

Resolves object registries that receive application events in this scope

Specified by:

resolveApplicationEventReceivers in interface ScopeResolver

Parameters:

wga - The environment

dbKey - Key of the app throwing the event

Returns:

A list of object registries plus eventually additional scope-dependent params for the event processing

Throws:

de.innovationgate.webgate.api.WGException

notifyScopeObjectStateChange

public void notifyScopeObjectStateChange(ScopeObjectRegistry.ScopeObject scopeObject,
                                WGA wga,
                                DesignResourceReference ref)
                                  throws de.innovationgate.webgate.api.WGException

Description copied from interface: ScopeResolver

Should be called when a scope object has changed its state, so the resolver can trigger necessary actions to persist this state

Specified by:

notifyScopeObjectStateChange in interface ScopeResolver

Parameters:

scopeObject - TODO

wga - The environment

ref - Reference of the object with changed state

Throws:

de.innovationgate.webgate.api.WGException

needsWebsockets

public boolean needsWebsockets()

Description copied from interface: ScopeResolver

Returns if websockets are required

Specified by:

needsWebsockets in interface ScopeResolver