Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / org / apache / shiro / mgt / DefaultSessionStorageEvaluator.html
blob: 515ae8285db4242950ab0eb39cda4fa44e142d7c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:25 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DefaultSessionStorageEvaluator (Apache Shiro 1.2.1 API)</title>
<meta name="date" content="2013-05-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultSessionStorageEvaluator (Apache Shiro 1.2.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultSessionStorageEvaluator.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">
<li><a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html" target="_top">Frames</a></li>
<li><a href="DefaultSessionStorageEvaluator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></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>
</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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.shiro.mgt</div>
<h2 title="Class DefaultSessionStorageEvaluator" class="title">Class DefaultSessionStorageEvaluator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.mgt.DefaultSessionStorageEvaluator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html" title="interface in org.apache.shiro.mgt">SessionStorageEvaluator</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/shiro/web/mgt/DefaultWebSessionStorageEvaluator.html" title="class in org.apache.shiro.web.mgt">DefaultWebSessionStorageEvaluator</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../src-html/org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#line.30">DefaultSessionStorageEvaluator</a>
extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html" title="interface in org.apache.shiro.mgt">SessionStorageEvaluator</a></pre>
<div class="block">A Default <code>SessionStorageEvaluator</code> that provides reasonable control over if and how Sessions may be used for
storing Subject state. See the <a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled(org.apache.shiro.subject.Subject)"><code>isSessionStorageEnabled(org.apache.shiro.subject.Subject)</code></a>
method for exact behavior.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#DefaultSessionStorageEvaluator()">DefaultSessionStorageEvaluator</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled()">isSessionStorageEnabled</a></strong>()</code>
<div class="block">Returns <code>true</code> if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state,
<code>false</code> otherwise.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled(org.apache.shiro.subject.Subject)">isSessionStorageEnabled</a></strong>(<a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject)</code>
<div class="block">This implementation functions as follows:
If the specified Subject already has an existing <code>Session</code> (typically because an application developer
has called <code>subject.getSession()</code> already), Shiro will use that existing session to store subject state.
If a Subject does not yet have a Session, this implementation checks the
<a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled()"><code>sessionStorageEnabled</code></a> property:
If <code>sessionStorageEnabled</code> is true (the default setting), a new session may be created to persist
Subject state if necessary.
If <code>sessionStorageEnabled</code> is <code>false</code>, a new session will <em>not</em> be created to persist
session state.
Most applications use Sessions and are OK with the default <code>true</code> setting for <code>sessionStorageEnabled</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#setSessionStorageEnabled(boolean)">setSessionStorageEnabled</a></strong>(boolean&nbsp;sessionStorageEnabled)</code>
<div class="block">Sets if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultSessionStorageEvaluator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultSessionStorageEvaluator</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#line.30">DefaultSessionStorageEvaluator</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isSessionStorageEnabled(org.apache.shiro.subject.Subject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSessionStorageEnabled</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#line.62">isSessionStorageEnabled</a>(<a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject)</pre>
<div class="block">This implementation functions as follows:
<ul>
<li>If the specified Subject already has an existing <code>Session</code> (typically because an application developer
has called <code>subject.getSession()</code> already), Shiro will use that existing session to store subject state.</li>
<li>If a Subject does not yet have a Session, this implementation checks the
<a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled()"><code>sessionStorageEnabled</code></a> property:
<ul>
<li>If <code>sessionStorageEnabled</code> is true (the default setting), a new session may be created to persist
Subject state if necessary.</li>
<li>If <code>sessionStorageEnabled</code> is <code>false</code>, a new session will <em>not</em> be created to persist
session state.</li>
</ul></li>
</ul>
Most applications use Sessions and are OK with the default <code>true</code> setting for <code>sessionStorageEnabled</code>.
<p/>
However, if your application is a purely 100% stateless application that never uses sessions,
you will want to set <code>sessionStorageEnabled</code> to <code>false</code>. Realize that a <code>false</code> value will
ensure that any subject login only retains the authenticated identity for the duration of a request. Any other
requests, invocations or messages will not be authenticated.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html#isSessionStorageEnabled(org.apache.shiro.subject.Subject)">isSessionStorageEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/mgt/SessionStorageEvaluator.html" title="interface in org.apache.shiro.mgt">SessionStorageEvaluator</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>subject</code> - the <code>Subject</code> for which session state persistence may be enabled</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of <a href="../../../../org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#isSessionStorageEnabled()"><code>isSessionStorageEnabled()</code></a> and ignores the <code>Subject</code> argument.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/subject/Subject.html#getSession()"><code>Subject.getSession()</code></a>,
<a href="../../../../org/apache/shiro/subject/Subject.html#getSession(boolean)"><code>Subject.getSession(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="isSessionStorageEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSessionStorageEnabled</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#line.78">isSessionStorageEnabled</a>()</pre>
<div class="block">Returns <code>true</code> if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state,
<code>false</code> otherwise. The default value is <code>true</code>.
<p/>
<b>N.B.</b> This is a global configuration setting; setting this value to <code>false</code> will disable sessions
to persist Subject state for all Subjects that do not already have a Session. It should typically only be set
to <code>false</code> for 100% stateless applications (e.g. when sessions aren't used or when remote clients
authenticate on every request).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state,
<code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="setSessionStorageEnabled(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSessionStorageEnabled</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html#line.93">setSessionStorageEnabled</a>(boolean&nbsp;sessionStorageEnabled)</pre>
<div class="block">Sets if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state. The
default value is <code>true</code>.
<p/>
<b>N.B.</b> This is a global configuration setting; setting this value to <code>false</code> will disable sessions
to persist Subject state for all Subjects that do not already have a Session. It should typically only be set
to <code>false</code> for 100% stateless applications (e.g. when sessions aren't used or when remote clients
authenticate on every request).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionStorageEnabled</code> - if any Subject's <code>Session</code> may be used to persist that <code>Subject</code>'s state.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultSessionStorageEvaluator.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">
<li><a href="../../../../org/apache/shiro/mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/shiro/mgt/DefaultSubjectDAO.html" title="class in org.apache.shiro.mgt"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/mgt/DefaultSessionStorageEvaluator.html" target="_top">Frames</a></li>
<li><a href="DefaultSessionStorageEvaluator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>
</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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>