de.innovationgate.wgpublisher.so

Class ScopeObjectRegistry

java.lang.Object

de.innovationgate.wgpublisher.so.ScopeObjectRegistry

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, javax.servlet.http.HttpSessionActivationListener

public class ScopeObjectRegistry
extends java.lang.Object
implements java.io.Serializable, javax.servlet.http.HttpSessionActivationListener

Generic registry for objects stored on scopes. The objects themselves are stored as ScopeObjectRegistry.ScopeObjectData and can be cached on a ProcessContext (like done for portlet scope). They are transient on this object so they are not serialized. The serializable state of objects is stored and serialized with the ScopeObjectRegistry. To the outside a ScopeObjectRegistry.ScopeObject is returned which contains the ScopeObjectData plus a reference to the registry, so it can extract/inject state on itself.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScopeObjectRegistry.ScopeObject Object to hand out a scope object to the outside
static class	ScopeObjectRegistry.ScopeObjectData Objects to store instantiated objects with their local status on the server, normally in process contexts
static class	ScopeObjectRegistry.ScopeState Serializable wrapper for the scope state JSON object, ridiculously being not Java serializable

Constructor Summary

Constructors

Constructor and Description
ScopeObjectRegistry(ObjectScope scope, java.lang.String name, ScopeObjectContextCreator context)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName()
ScopeObjectRegistry.ScopeObject	getOrCreateScopeObject(WGA wga, DesignResourceReference ref, boolean isController, boolean create)
ScopeObjectRegistry.ScopeObject	getOrCreateScopeObject(WGA wga, java.lang.String name, DesignResourceReference ref, boolean isController, boolean create)
com.google.gson.JsonObject	getOrCreateScopeObjectState(DesignResourceReference ref)
ScopeObjectContextCreator	getScopeObjectContextCreator()
java.util.Map<java.lang.String,ScopeObjectRegistry.ScopeObjectData>	getScopeObjects()
com.google.gson.JsonObject	getScopeObjectState(DesignResourceReference ref)
java.util.Map<DesignResourceReference,ScopeObjectRegistry.ScopeState>	getScopeStates()
boolean	isInjectableControllerState(com.google.gson.JsonObject state)
boolean	isScopeObjectExisting(DesignResourceReference ref)
com.google.gson.JsonObject	removeScopeObjectState(DesignResourceReference ref)
void	sessionDidActivate(javax.servlet.http.HttpSessionEvent arg0)
void	sessionWillPassivate(javax.servlet.http.HttpSessionEvent arg0)
void	setName(java.lang.String name)
void	setScopeObjectContextCreator(ScopeObjectContextCreator scopeObjectContextCreator)
void	setScopeObjects(java.util.Map<java.lang.String,ScopeObjectRegistry.ScopeObjectData> scopeObjects)
void	setScopeObjectState(DesignResourceReference ref, com.google.gson.JsonObject state)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeObjectRegistry

public ScopeObjectRegistry(ObjectScope scope,
                   java.lang.String name,
                   ScopeObjectContextCreator context)

Method Detail

getName

public java.lang.String getName()

isScopeObjectExisting

public boolean isScopeObjectExisting(DesignResourceReference ref)

getOrCreateScopeObject

public ScopeObjectRegistry.ScopeObject getOrCreateScopeObject(WGA wga,
                                                     DesignResourceReference ref,
                                                     boolean isController,
                                                     boolean create)
                                                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getOrCreateScopeObject

public ScopeObjectRegistry.ScopeObject getOrCreateScopeObject(WGA wga,
                                                     java.lang.String name,
                                                     DesignResourceReference ref,
                                                     boolean isController,
                                                     boolean create)
                                                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getScopeObjectState

public com.google.gson.JsonObject getScopeObjectState(DesignResourceReference ref)

removeScopeObjectState

public com.google.gson.JsonObject removeScopeObjectState(DesignResourceReference ref)

setScopeObjectState

public void setScopeObjectState(DesignResourceReference ref,
                       com.google.gson.JsonObject state)

sessionDidActivate

public void sessionDidActivate(javax.servlet.http.HttpSessionEvent arg0)

Specified by:

sessionDidActivate in interface javax.servlet.http.HttpSessionActivationListener

sessionWillPassivate

public void sessionWillPassivate(javax.servlet.http.HttpSessionEvent arg0)

Specified by:

sessionWillPassivate in interface javax.servlet.http.HttpSessionActivationListener

isInjectableControllerState

public boolean isInjectableControllerState(com.google.gson.JsonObject state)

getScopeStates

public java.util.Map<DesignResourceReference,ScopeObjectRegistry.ScopeState> getScopeStates()

getScopeObjects

public java.util.Map<java.lang.String,ScopeObjectRegistry.ScopeObjectData> getScopeObjects()

setScopeObjects

public void setScopeObjects(java.util.Map<java.lang.String,ScopeObjectRegistry.ScopeObjectData> scopeObjects)

getOrCreateScopeObjectState

public com.google.gson.JsonObject getOrCreateScopeObjectState(DesignResourceReference ref)

setName

public void setName(java.lang.String name)

getScopeObjectContextCreator

public ScopeObjectContextCreator getScopeObjectContextCreator()

setScopeObjectContextCreator

public void setScopeObjectContextCreator(ScopeObjectContextCreator scopeObjectContextCreator)