public abstract class SessionsSecurityManager extends AuthorizingSecurityManager
SecurityManager
class hierarchy that delegates all
session
operations to a wrapped
SessionManager
instance. That is, this class implements the
methods in the SessionManager
interface, but in reality, those methods are merely
passthrough calls to the underlying 'real' SessionManager
instance.
The remaining SecurityManager
methods not implemented by this class or its parents are left to be
implemented by subclasses.
In keeping with the other classes in this hierarchy and Shiro's desire to minimize configuration whenever
possible, suitable default instances for all dependencies will be created upon instantiation.Constructor and Description |
---|
SessionsSecurityManager()
Default no-arg constructor, internally creates a suitable default
SessionManager delegate
instance. |
Modifier and Type | Method and Description |
---|---|
protected void |
afterCacheManagerSet()
Calls
super.afterCacheManagerSet() and then immediately calls
applyCacheManagerToSessionManager() to ensure the
CacheManager is applied to the SessionManager as necessary. |
protected void |
afterEventBusSet()
Sets any configured EventBus on the SessionManager if necessary.
|
protected void |
afterSessionManagerSet() |
protected void |
applyCacheManagerToSessionManager()
Ensures the internal delegate
SessionManager is injected with the newly set
CacheManager so it may use it for its internal caching needs. |
protected void |
applyEventBusToSessionManager()
Ensures the internal delegate
SessionManager is injected with the newly set
EventBus so it may use it for its internal event needs. |
void |
destroy()
Destroys the
cacheManager via LifecycleUtils.destroy . |
Session |
getSession(SessionKey key)
Retrieves the session corresponding to the specified contextual data (such as a session ID if applicable), or
null if no Session could be found. |
SessionManager |
getSessionManager()
Returns this security manager's internal delegate
SessionManager . |
void |
setSessionManager(SessionManager sessionManager)
Sets the underlying delegate
SessionManager instance that will be used to support this implementation's
SessionManager method calls. |
Session |
start(SessionContext context)
Starts a new session based on the specified contextual initialization data, which can be used by the underlying
implementation to determine how exactly to create the internal Session instance.
|
afterRealmsSet, checkPermission, checkPermission, checkPermissions, checkPermissions, checkRole, checkRoles, checkRoles, getAuthorizer, hasAllRoles, hasRole, hasRoles, isPermitted, isPermitted, isPermitted, isPermitted, isPermittedAll, isPermittedAll, setAuthorizer
authenticate, getAuthenticator, setAuthenticator
applyCacheManagerToRealms, applyEventBusToRealms, getRealms, setRealm, setRealms
applyEventBusToCacheManager, getCacheManager, getEventBus, setCacheManager, setEventBus
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createSubject, login, logout
public SessionsSecurityManager()
SessionManager
delegate
instance.public void setSessionManager(SessionManager sessionManager)
SessionManager
instance that will be used to support this implementation's
SessionManager method calls.
This SecurityManager implementation does not provide logic to support the inherited
SessionManager interface, but instead delegates these calls to an internal
SessionManager instance.
If a SessionManager instance is not set, a default one will be automatically created and
initialized appropriately for the the existing runtime environment.sessionManager
- delegate instance to use to support this manager's SessionManager method calls.protected void afterSessionManagerSet()
public SessionManager getSessionManager()
SessionManager
.SessionManager
.setSessionManager
protected void afterCacheManagerSet()
super.afterCacheManagerSet()
and then immediately calls
applyCacheManagerToSessionManager()
to ensure the
CacheManager
is applied to the SessionManager as necessary.afterCacheManagerSet
in class RealmSecurityManager
protected void afterEventBusSet()
afterEventBusSet
in class RealmSecurityManager
protected void applyCacheManagerToSessionManager()
SessionManager
is injected with the newly set
CacheManager
so it may use it for its internal caching needs.
Note: This implementation only injects the CacheManager into the SessionManager if the SessionManager
instance implements the CacheManagerAware
interface.protected void applyEventBusToSessionManager()
SessionManager
is injected with the newly set
EventBus
so it may use it for its internal event needs.
Note: This implementation only injects the EventBus into the SessionManager if the SessionManager
instance implements the EventBusAware
interface.public Session start(SessionContext context) throws AuthorizationException
SessionManager
SessionFactory
which could use the context to construct the internal Session
instance in a specific manner. This allows pluggable Session
creation
logic by simply injecting a SessionFactory
into the SessionManager
instance.context
- the contextual initialization data that can be used by the implementation or underlying
SessionFactory
when instantiating the internal Session
instance.AuthorizationException
SessionFactory.createSession(SessionContext)
public Session getSession(SessionKey key) throws SessionException
SessionManager
null
if no Session could be found. If a session is found but invalid (stopped or expired), a
SessionException
will be thrown.key
- the Session key to use to look-up the SessionSession
instance corresponding to the given lookup key or null
if no session
could be acquired.SessionException
- if a session was found but it was invalid (stopped/expired).public void destroy()
CachingSecurityManager
cacheManager
via LifecycleUtils.destroy
.destroy
in interface Destroyable
destroy
in class AuthorizingSecurityManager
Copyright © 2004–2016 The Apache Software Foundation. All rights reserved.