jodd.petite.scope

Class SessionScope

java.lang.Object

jodd.petite.scope.ShutdownAwareScope

jodd.petite.scope.SessionScope

All Implemented Interfaces:

Scope

public class SessionScope
extends ShutdownAwareScope

Session scope stores unique object instances per single http session. Upon creation, new session listener is registered (dynamically) that will keep track on active sessions. RequestContextListener is used for accessing the request and the session.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SessionScope.SessionBeans Session beans holder and manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	SESSION_BEANS_NAME

Fields inherited from class jodd.petite.scope.ShutdownAwareScope

destroyableBeans

Constructor Summary

Constructors

Constructor and Description
SessionScope(PetiteContainer pc)

Method Summary

Modifier and Type	Method and Description
boolean	accept(Scope referenceScope) Returns true if a bean of referenced scope can be injected into target bean of this scope.
protected javax.servlet.http.HttpSession	getCurrentHttpSession() Returns request from current thread.
protected java.util.Map<java.lang.String,BeanData>	getSessionMap(javax.servlet.http.HttpSession session) Returns instance map from http session.
java.lang.Object	lookup(java.lang.String name) Lookups for bean name.
void	register(BeanDefinition beanDefinition, java.lang.Object bean) Registers the bean within the current scope.
protected java.util.Map<java.lang.String,BeanData>	registerSessionBeans(javax.servlet.http.HttpSession httpSession) Registers new session destroy callback if not already registered.
void	remove(java.lang.String name) Removes the bean from the scope entirely.
void	shutdown() Shutdowns the Session scope.

Methods inherited from class jodd.petite.scope.ShutdownAwareScope

destroyBean, isBeanDestroyable, registerDestroyableBeans, totalRegisteredDestroyableBeans

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_BEANS_NAME

protected static final java.lang.String SESSION_BEANS_NAME

Constructor Detail

SessionScope

public SessionScope(PetiteContainer pc)

Method Detail

registerSessionBeans

protected java.util.Map<java.lang.String,BeanData> registerSessionBeans(javax.servlet.http.HttpSession httpSession)

Registers new session destroy callback if not already registered.

getSessionMap

protected java.util.Map<java.lang.String,BeanData> getSessionMap(javax.servlet.http.HttpSession session)

Returns instance map from http session.

shutdown

public void shutdown()

Shutdowns the Session scope. Calls destroyable methods on all destroyable beans available in this moment.

Specified by:

shutdown in interface Scope

Overrides:

shutdown in class ShutdownAwareScope

lookup

public java.lang.Object lookup(java.lang.String name)

Description copied from interface: Scope

Lookups for bean name. Returns null if bean is not found or yet registered.

register

public void register(BeanDefinition beanDefinition,
                     java.lang.Object bean)

Description copied from interface: Scope

Registers the bean within the current scope. Usually registers it by its name from BeanDefinition. Also it may register destroy methods of a bean within this scope.

remove

public void remove(java.lang.String name)

Description copied from interface: Scope

Removes the bean from the scope entirely. Destroy methods are not called as it is assumed that bean is destroyed manually.

accept

public boolean accept(Scope referenceScope)

Description copied from interface: Scope

Returns true if a bean of referenced scope can be injected into target bean of this scope. Otherwise, returns false, which may be a sign for scoped proxy to be injected.

In general, injection of 'shorter' reference scopes into the 'longer' target scopes should not be accepted. In other words, if reference scope is 'longer' or equal (same), this method should return true.

Helpful is to ask the following question: "May the reference scope bean be injected into bean of this scope?".

getCurrentHttpSession

protected javax.servlet.http.HttpSession getCurrentHttpSession()

Returns request from current thread.