Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / shiro-core / apidocs / org / apache / shiro / mgt / SessionsSecurityManager.html
blob: 9cd7e17d27b6ad97c21f736ab9c17442ae4180b7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (11.0.8) on Wed Oct 28 15:59:12 CET 2020 -->
<title>SessionsSecurityManager (Apache Shiro :: Core 1.7.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SessionsSecurityManager (Apache Shiro :: Core 1.7.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SessionsSecurityManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.shiro.mgt</a></div>
<h2 title="Class SessionsSecurityManager" class="title">Class SessionsSecurityManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.CachingSecurityManager</a></li>
<li>
<ul class="inheritance">
<li><a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.RealmSecurityManager</a></li>
<li>
<ul class="inheritance">
<li><a href="AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.AuthenticatingSecurityManager</a></li>
<li>
<ul class="inheritance">
<li><a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">org.apache.shiro.mgt.AuthorizingSecurityManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.mgt.SessionsSecurityManager</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../authc/Authenticator.html" title="interface in org.apache.shiro.authc">Authenticator</a></code>, <code><a href="../authz/Authorizer.html" title="interface in org.apache.shiro.authz">Authorizer</a></code>, <code>org.apache.shiro.cache.CacheManagerAware</code>, <code>org.apache.shiro.event.EventBusAware</code>, <code><a href="SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code>, <code><a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></code>, <code>org.apache.shiro.util.Destroyable</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DefaultSecurityManager.html" title="class in org.apache.shiro.mgt">DefaultSecurityManager</a></code></dd>
</dl>
<hr>
<pre>public abstract class <a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.49">SessionsSecurityManager</a>
extends <a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthorizingSecurityManager</a></pre>
<div class="block">Shiro support of a <a href="SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> class hierarchy that delegates all
<a href="../session/Session.html" title="interface in org.apache.shiro.session"><code>session</code></a> operations to a wrapped
<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> instance. That is, this class implements the
methods in the <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> interface, but in reality, those methods are merely
passthrough calls to the underlying 'real' <code>SessionManager</code> instance.
<p/>
The remaining <code>SecurityManager</code> methods not implemented by this class or its parents are left to be
implemented by subclasses.
<p/>
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.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.9</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SessionsSecurityManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Default no-arg constructor, internally creates a suitable default <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> delegate
instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterCacheManagerSet()">afterCacheManagerSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Calls <a href="RealmSecurityManager.html#afterCacheManagerSet()"><code>super.afterCacheManagerSet()</code></a> and then immediately calls
<a href="#applyCacheManagerToSessionManager()"><code>applyCacheManagerToSessionManager()</code></a> to ensure the
<code>CacheManager</code> is applied to the SessionManager as necessary.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterEventBusSet()">afterEventBusSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Sets any configured EventBus on the SessionManager if necessary.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterSessionManagerSet()">afterSessionManagerSet</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyCacheManagerToSessionManager()">applyCacheManagerToSessionManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Ensures the internal delegate <code>SessionManager</code> is injected with the newly set
<a href="CachingSecurityManager.html#setCacheManager(org.apache.shiro.cache.CacheManager)"><code>CacheManager</code></a> so it may use it for its internal caching needs.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyEventBusToSessionManager()">applyEventBusToSessionManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Ensures the internal delegate <code>SessionManager</code> is injected with the newly set
<a href="CachingSecurityManager.html#setEventBus(org.apache.shiro.event.EventBus)"><code>EventBus</code></a> so it may use it for its internal event needs.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#destroy()">destroy</a></span>()</code></th>
<td class="colLast">
<div class="block">Destroys the <a href="CachingSecurityManager.html#getCacheManager()"><code>cacheManager</code></a> via <code>LifecycleUtils.destroy</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a></span>&#8203;(<a href="../session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a>&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Retrieves the session corresponding to the specified contextual data (such as a session ID if applicable), or
<code>null</code> if no Session could be found.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionManager()">getSessionManager</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns this security manager's internal delegate <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionManager(org.apache.shiro.session.mgt.SessionManager)">setSessionManager</a></span>&#8203;(<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&nbsp;sessionManager)</code></th>
<td class="colLast">
<div class="block">Sets the underlying delegate <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> instance that will be used to support this implementation's
<tt>SessionManager</tt> method calls.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start(org.apache.shiro.session.mgt.SessionContext)">start</a></span>&#8203;(<a href="../session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.AuthorizingSecurityManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.mgt.<a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthorizingSecurityManager</a></h3>
<code><a href="AuthorizingSecurityManager.html#afterRealmsSet()">afterRealmsSet</a>, <a href="AuthorizingSecurityManager.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkPermission</a>, <a href="AuthorizingSecurityManager.html#checkPermission(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">checkPermission</a>, <a href="AuthorizingSecurityManager.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkPermissions</a>, <a href="AuthorizingSecurityManager.html#checkPermissions(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkPermissions</a>, <a href="AuthorizingSecurityManager.html#checkRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">checkRole</a>, <a href="AuthorizingSecurityManager.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">checkRoles</a>, <a href="AuthorizingSecurityManager.html#checkRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">checkRoles</a>, <a href="AuthorizingSecurityManager.html#getAuthorizer()">getAuthorizer</a>, <a href="AuthorizingSecurityManager.html#hasAllRoles(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">hasAllRoles</a>, <a href="AuthorizingSecurityManager.html#hasRole(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">hasRole</a>, <a href="AuthorizingSecurityManager.html#hasRoles(org.apache.shiro.subject.PrincipalCollection,java.util.List)">hasRoles</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,java.util.List)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermitted(org.apache.shiro.subject.PrincipalCollection,org.apache.shiro.authz.Permission)">isPermitted</a>, <a href="AuthorizingSecurityManager.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.lang.String...)">isPermittedAll</a>, <a href="AuthorizingSecurityManager.html#isPermittedAll(org.apache.shiro.subject.PrincipalCollection,java.util.Collection)">isPermittedAll</a>, <a href="AuthorizingSecurityManager.html#setAuthorizer(org.apache.shiro.authz.Authorizer)">setAuthorizer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.AuthenticatingSecurityManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.mgt.<a href="AuthenticatingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthenticatingSecurityManager</a></h3>
<code><a href="AuthenticatingSecurityManager.html#authenticate(org.apache.shiro.authc.AuthenticationToken)">authenticate</a>, <a href="AuthenticatingSecurityManager.html#getAuthenticator()">getAuthenticator</a>, <a href="AuthenticatingSecurityManager.html#setAuthenticator(org.apache.shiro.authc.Authenticator)">setAuthenticator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.RealmSecurityManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.mgt.<a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">RealmSecurityManager</a></h3>
<code><a href="RealmSecurityManager.html#applyCacheManagerToRealms()">applyCacheManagerToRealms</a>, <a href="RealmSecurityManager.html#applyEventBusToRealms()">applyEventBusToRealms</a>, <a href="RealmSecurityManager.html#getRealms()">getRealms</a>, <a href="RealmSecurityManager.html#setRealm(org.apache.shiro.realm.Realm)">setRealm</a>, <a href="RealmSecurityManager.html#setRealms(java.util.Collection)">setRealms</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.CachingSecurityManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.mgt.<a href="CachingSecurityManager.html" title="class in org.apache.shiro.mgt">CachingSecurityManager</a></h3>
<code><a href="CachingSecurityManager.html#applyEventBusToCacheManager()">applyEventBusToCacheManager</a>, <a href="CachingSecurityManager.html#getCacheManager()">getCacheManager</a>, <a href="CachingSecurityManager.html#getEventBus()">getEventBus</a>, <a href="CachingSecurityManager.html#setCacheManager(org.apache.shiro.cache.CacheManager)">setCacheManager</a>, <a href="CachingSecurityManager.html#setEventBus(org.apache.shiro.event.EventBus)">setEventBus</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.mgt.SecurityManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.shiro.mgt.<a href="SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></h3>
<code><a href="SecurityManager.html#createSubject(org.apache.shiro.subject.SubjectContext)">createSubject</a>, <a href="SecurityManager.html#login(org.apache.shiro.subject.Subject,org.apache.shiro.authc.AuthenticationToken)">login</a>, <a href="SecurityManager.html#logout(org.apache.shiro.subject.Subject)">logout</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SessionsSecurityManager</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.61">SessionsSecurityManager</a>()</pre>
<div class="block">Default no-arg constructor, internally creates a suitable default <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> delegate
instance.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setSessionManager(org.apache.shiro.session.mgt.SessionManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionManager</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.80">setSessionManager</a>&#8203;(<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&nbsp;sessionManager)</pre>
<div class="block">Sets the underlying delegate <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a> instance that will be used to support this implementation's
<tt>SessionManager</tt> method calls.
<p/>
This <tt>SecurityManager</tt> implementation does not provide logic to support the inherited
<tt>SessionManager</tt> interface, but instead delegates these calls to an internal
<tt>SessionManager</tt> instance.
<p/>
If a <tt>SessionManager</tt> instance is not set, a default one will be automatically created and
initialized appropriately for the the existing runtime environment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionManager</code> - delegate instance to use to support this manager's <tt>SessionManager</tt> method calls.</dd>
</dl>
</li>
</ul>
<a id="afterSessionManagerSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterSessionManagerSet</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.85">afterSessionManagerSet</a>()</pre>
</li>
</ul>
<a id="getSessionManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionManager</h4>
<pre class="methodSignature">public&nbsp;<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.96">getSessionManager</a>()</pre>
<div class="block">Returns this security manager's internal delegate <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this security manager's internal delegate <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#setSessionManager(org.apache.shiro.session.mgt.SessionManager)"><code>setSessionManager</code></a></dd>
</dl>
</li>
</ul>
<a id="afterCacheManagerSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterCacheManagerSet</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.105">afterCacheManagerSet</a>()</pre>
<div class="block">Calls <a href="RealmSecurityManager.html#afterCacheManagerSet()"><code>super.afterCacheManagerSet()</code></a> and then immediately calls
<a href="#applyCacheManagerToSessionManager()"><code>applyCacheManagerToSessionManager()</code></a> to ensure the
<code>CacheManager</code> is applied to the SessionManager as necessary.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RealmSecurityManager.html#afterCacheManagerSet()">afterCacheManagerSet</a></code>&nbsp;in class&nbsp;<code><a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">RealmSecurityManager</a></code></dd>
</dl>
</li>
</ul>
<a id="afterEventBusSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterEventBusSet</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.116">afterEventBusSet</a>()</pre>
<div class="block">Sets any configured EventBus on the SessionManager if necessary.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RealmSecurityManager.html#afterEventBusSet()">afterEventBusSet</a></code>&nbsp;in class&nbsp;<code><a href="RealmSecurityManager.html" title="class in org.apache.shiro.mgt">RealmSecurityManager</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
</dl>
</li>
</ul>
<a id="applyCacheManagerToSessionManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyCacheManagerToSessionManager</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.129">applyCacheManagerToSessionManager</a>()</pre>
<div class="block">Ensures the internal delegate <code>SessionManager</code> is injected with the newly set
<a href="CachingSecurityManager.html#setCacheManager(org.apache.shiro.cache.CacheManager)"><code>CacheManager</code></a> so it may use it for its internal caching needs.
<p/>
Note: This implementation only injects the CacheManager into the SessionManager if the SessionManager
instance implements the <code>CacheManagerAware</code> interface.</div>
</li>
</ul>
<a id="applyEventBusToSessionManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyEventBusToSessionManager</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.144">applyEventBusToSessionManager</a>()</pre>
<div class="block">Ensures the internal delegate <code>SessionManager</code> is injected with the newly set
<a href="CachingSecurityManager.html#setEventBus(org.apache.shiro.event.EventBus)"><code>EventBus</code></a> so it may use it for its internal event needs.
<p/>
Note: This implementation only injects the EventBus into the SessionManager if the SessionManager
instance implements the <code>EventBusAware</code> interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.3</dd>
</dl>
</li>
</ul>
<a id="start(org.apache.shiro.session.mgt.SessionContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;<a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.151">start</a>&#8203;(<a href="../session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a>&nbsp;context)
throws <a href="../authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../session/mgt/SessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">SessionManager</a></code></span></div>
<div class="block">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.
<p/>
This method is mainly used in framework development, as the implementation will often relay the argument
to an underlying <a href="../session/mgt/SessionFactory.html" title="interface in org.apache.shiro.session.mgt"><code>SessionFactory</code></a> which could use the context to construct the internal Session
instance in a specific manner. This allows pluggable <a href="../session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> creation
logic by simply injecting a <code>SessionFactory</code> into the <code>SessionManager</code> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the contextual initialization data that can be used by the implementation or underlying
<a href="../session/mgt/SessionFactory.html" title="interface in org.apache.shiro.session.mgt"><code>SessionFactory</code></a> when instantiating the internal <code>Session</code> instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the newly created session.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../session/mgt/SessionFactory.html#createSession(org.apache.shiro.session.mgt.SessionContext)"><code>SessionFactory.createSession(SessionContext)</code></a></dd>
</dl>
</li>
</ul>
<a id="getSession(org.apache.shiro.session.mgt.SessionKey)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre class="methodSignature">public&nbsp;<a href="../session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.155">getSession</a>&#8203;(<a href="../session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a>&nbsp;key)
throws <a href="../session/SessionException.html" title="class in org.apache.shiro.session">SessionException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../session/mgt/SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">SessionManager</a></code></span></div>
<div class="block">Retrieves the session corresponding to the specified contextual data (such as a session ID if applicable), or
<code>null</code> if no Session could be found. If a session is found but invalid (stopped or expired), a
<a href="../session/SessionException.html" title="class in org.apache.shiro.session"><code>SessionException</code></a> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the Session key to use to look-up the Session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Session</code> instance corresponding to the given lookup key or <code>null</code> if no session
could be acquired.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../session/SessionException.html" title="class in org.apache.shiro.session">SessionException</a></code> - if a session was found but it was invalid (stopped/expired).</dd>
</dl>
</li>
</ul>
<a id="destroy()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>destroy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/SessionsSecurityManager.html#line.159">destroy</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="CachingSecurityManager.html#destroy()">CachingSecurityManager</a></code></span></div>
<div class="block">Destroys the <a href="CachingSecurityManager.html#getCacheManager()"><code>cacheManager</code></a> via <code>LifecycleUtils.destroy</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>destroy</code>&nbsp;in interface&nbsp;<code>org.apache.shiro.util.Destroyable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AuthorizingSecurityManager.html#destroy()">destroy</a></code>&nbsp;in class&nbsp;<code><a href="AuthorizingSecurityManager.html" title="class in org.apache.shiro.mgt">AuthorizingSecurityManager</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SessionsSecurityManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>