src/site/assets/static/1.6.0/apidocs/org/apache/shiro/SecurityUtils.html - shiro-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.7) on Mon Aug 17 10:30:05 EDT 2020 -->
 <title>SecurityUtils (Apache Shiro 1.6.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-08-17">
 <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="SecurityUtils (Apache Shiro 1.6.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":9,"i1":9,"i2":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SecurityUtils.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</a></div>
 <h2 title="Class SecurityUtils" class="title">Class SecurityUtils</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>org.apache.shiro.SecurityUtils</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <pre>public abstract class <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.31">SecurityUtils</a>
 extends <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></pre>
 <div class="block">Accesses the currently accessible <code>Subject</code> for the calling code depending on runtime environment.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.2</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()">SecurityUtils</a></span>()</code></th>
 <td class="colLast">&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecurityManager()">getSecurityManager</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the SecurityManager accessible to the calling code.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubject()">getSubject</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the currently accessible <code>Subject</code> available to the calling code depending on
  runtime environment.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>static void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecurityManager(org.apache.shiro.mgt.SecurityManager)">setSecurityManager</a></span>&#8203;(<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&nbsp;securityManager)</code></th>
 <td class="colLast">
 <div class="block">Sets a VM (static) singleton SecurityManager, specifically for transparent use in the
  <a href="#getSubject()"><code>getSubject()</code></a> implementation.</div>
 </td>
 </tr>
 </table>
 <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>
 </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>SecurityUtils</h4>
 <pre>public&nbsp;<a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.31">SecurityUtils</a>()</pre>
 </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="getSubject()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSubject</h4>
 <pre class="methodSignature">public static&nbsp;<a href="subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;<a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.53">getSubject</a>()</pre>
 <div class="block">Returns the currently accessible <code>Subject</code> available to the calling code depending on
  runtime environment.
  <p/>
  This method is provided as a way of obtaining a <code>Subject</code> without having to resort to
  implementation-specific methods.  It also allows the Shiro team to change the underlying implementation of
  this method in the future depending on requirements/updates without affecting your code that uses it.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the currently accessible <code>Subject</code> accessible to the calling code.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if no <a href="subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance or
                                <a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> instance is available with which to obtain
                                a <code>Subject</code>, which which is considered an invalid application configuration
                                - a Subject should <em>always</em> be available to the caller.</dd>
 </dl>
 </li>
 </ul>
 <a id="setSecurityManager(org.apache.shiro.mgt.SecurityManager)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSecurityManager</h4>
 <pre class="methodSignature">public static&nbsp;void&nbsp;<a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.94">setSecurityManager</a>&#8203;(<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&nbsp;securityManager)</pre>
 <div class="block">Sets a VM (static) singleton SecurityManager, specifically for transparent use in the
  <a href="#getSubject()"><code>getSubject()</code></a> implementation.
  <p/>
  <b>This method call exists mainly for framework development support.  Application developers should rarely,
  if ever, need to call this method.</b>
  <p/>
  The Shiro development team prefers that SecurityManager instances are non-static application singletons
  and <em>not</em> VM static singletons.  Application singletons that do not use static memory require some sort
  of application configuration framework to maintain the application-wide SecurityManager instance for you
  (for example, Spring or EJB3 environments) such that the object reference does not need to be static.
  <p/>
  In these environments, Shiro acquires Subject data based on the currently executing Thread via its own
  framework integration code, and this is the preferred way to use Shiro.
  <p/>
  However in some environments, such as a standalone desktop application or Applets that do not use Spring or
  EJB or similar config frameworks, a VM-singleton might make more sense (although the former is still preferred).
  In these environments, setting the SecurityManager via this method will automatically enable the
  <a href="#getSubject()"><code>getSubject()</code></a> call to function with little configuration.
  <p/>
  For example, in these environments, this will work:
  <pre>
  DefaultSecurityManager securityManager = new <a href="mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt"><code>DefaultSecurityManager</code></a>();
  securityManager.setRealms( ... ); //one or more Realms
  <b>SecurityUtils.setSecurityManager( securityManager );</b></pre>
  <p/>
  And then anywhere in the application code, the following call will return the application's Subject:
  <pre>
  Subject currentUser = SecurityUtils.getSubject();</pre></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>securityManager</code> - the securityManager instance to set as a VM static singleton.</dd>
 </dl>
 </li>
 </ul>
 <a id="getSecurityManager()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getSecurityManager</h4>
 <pre class="methodSignature">public static&nbsp;<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&nbsp;<a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.114">getSecurityManager</a>()
                                           throws <a href="UnavailableSecurityManagerException.html" title="class in org.apache.shiro">UnavailableSecurityManagerException</a></pre>
 <div class="block">Returns the SecurityManager accessible to the calling code.
  <p/>
  This implementation favors acquiring a thread-bound <code>SecurityManager</code> if it can find one.  If one is
  not available to the executing thread, it will attempt to use the static singleton if available (see the
  <a href="#setSecurityManager(org.apache.shiro.mgt.SecurityManager)"><code>setSecurityManager</code></a> method for more on the static singleton).
  <p/>
  If neither the thread-local or static singleton instances are available, this method throws an
  <code>UnavailableSecurityManagerException</code> to indicate an error - a SecurityManager should always be accessible
  to calling code in an application. If it is not, it is likely due to a Shiro configuration problem.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the SecurityManager accessible to the calling code.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="UnavailableSecurityManagerException.html" title="class in org.apache.shiro">UnavailableSecurityManagerException</a></code> - if there is no <code>SecurityManager</code> instance available to the
           calling code, which typically indicates an invalid application configuration.</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/SecurityUtils.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>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (11.0.7) on Mon Aug 17 10:30:05 EDT 2020 -->
	<title>SecurityUtils (Apache Shiro 1.6.0 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="dc.created" content="2020-08-17">
	<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="SecurityUtils (Apache Shiro 1.6.0 API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":9,"i1":9,"i2":9};
	var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SecurityUtils.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 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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"> </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> <a href="package-summary.html">org.apache.shiro</a></div>
	<h2 title="Class SecurityUtils" class="title">Class SecurityUtils</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>org.apache.shiro.SecurityUtils</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<pre>public abstract class <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.31">SecurityUtils</a>
	extends <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></pre>
	<div class="block">Accesses the currently accessible <code>Subject</code> for the calling code depending on runtime environment.</div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>0.2</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"> </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()">SecurityUtils</a></span>()</code></th>
	<td class="colLast"> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecurityManager()">getSecurityManager</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the SecurityManager accessible to the calling code.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>static <a href="subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubject()">getSubject</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the currently accessible <code>Subject</code> available to the calling code depending on
	runtime environment.</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>static void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecurityManager(org.apache.shiro.mgt.SecurityManager)">setSecurityManager</a></span>(<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager)</code></th>
	<td class="colLast">
	<div class="block">Sets a VM (static) singleton SecurityManager, specifically for transparent use in the
	<a href="#getSubject()"><code>getSubject()</code></a> implementation.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class 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>
	</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="<init>()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>SecurityUtils</h4>
	<pre>public <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.31">SecurityUtils</a>()</pre>
	</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="getSubject()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getSubject</h4>
	<pre class="methodSignature">public static <a href="subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a> <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.53">getSubject</a>()</pre>
	<div class="block">Returns the currently accessible <code>Subject</code> available to the calling code depending on
	runtime environment.
	<p/>
	This method is provided as a way of obtaining a <code>Subject</code> without having to resort to
	implementation-specific methods. It also allows the Shiro team to change the underlying implementation of
	this method in the future depending on requirements/updates without affecting your code that uses it.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the currently accessible <code>Subject</code> accessible to the calling code.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if no <a href="subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance or
	<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> instance is available with which to obtain
	a <code>Subject</code>, which which is considered an invalid application configuration
	- a Subject should <em>always</em> be available to the caller.</dd>
	</dl>
	</li>
	</ul>
	<a id="setSecurityManager(org.apache.shiro.mgt.SecurityManager)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>setSecurityManager</h4>
	<pre class="methodSignature">public static void <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.94">setSecurityManager</a>(<a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager)</pre>
	<div class="block">Sets a VM (static) singleton SecurityManager, specifically for transparent use in the
	<a href="#getSubject()"><code>getSubject()</code></a> implementation.
	<p/>
	<b>This method call exists mainly for framework development support. Application developers should rarely,
	if ever, need to call this method.</b>
	<p/>
	The Shiro development team prefers that SecurityManager instances are non-static application singletons
	and <em>not</em> VM static singletons. Application singletons that do not use static memory require some sort
	of application configuration framework to maintain the application-wide SecurityManager instance for you
	(for example, Spring or EJB3 environments) such that the object reference does not need to be static.
	<p/>
	In these environments, Shiro acquires Subject data based on the currently executing Thread via its own
	framework integration code, and this is the preferred way to use Shiro.
	<p/>
	However in some environments, such as a standalone desktop application or Applets that do not use Spring or
	EJB or similar config frameworks, a VM-singleton might make more sense (although the former is still preferred).
	In these environments, setting the SecurityManager via this method will automatically enable the
	<a href="#getSubject()"><code>getSubject()</code></a> call to function with little configuration.
	<p/>
	For example, in these environments, this will work:
	<pre>
	DefaultSecurityManager securityManager = new <a href="mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt"><code>DefaultSecurityManager</code></a>();
	securityManager.setRealms( ... ); //one or more Realms
	<b>SecurityUtils.setSecurityManager( securityManager );</b></pre>
	<p/>
	And then anywhere in the application code, the following call will return the application's Subject:
	<pre>
	Subject currentUser = SecurityUtils.getSubject();</pre></div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>securityManager</code> - the securityManager instance to set as a VM static singleton.</dd>
	</dl>
	</li>
	</ul>
	<a id="getSecurityManager()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>getSecurityManager</h4>
	<pre class="methodSignature">public static <a href="mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> <a href="../../../src-html/org/apache/shiro/SecurityUtils.html#line.114">getSecurityManager</a>()
	throws <a href="UnavailableSecurityManagerException.html" title="class in org.apache.shiro">UnavailableSecurityManagerException</a></pre>
	<div class="block">Returns the SecurityManager accessible to the calling code.
	<p/>
	This implementation favors acquiring a thread-bound <code>SecurityManager</code> if it can find one. If one is
	not available to the executing thread, it will attempt to use the static singleton if available (see the
	<a href="#setSecurityManager(org.apache.shiro.mgt.SecurityManager)"><code>setSecurityManager</code></a> method for more on the static singleton).
	<p/>
	If neither the thread-local or static singleton instances are available, this method throws an
	<code>UnavailableSecurityManagerException</code> to indicate an error - a SecurityManager should always be accessible
	to calling code in an application. If it is not, it is likely due to a Shiro configuration problem.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the SecurityManager accessible to the calling code.</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="UnavailableSecurityManagerException.html" title="class in org.apache.shiro">UnavailableSecurityManagerException</a></code> - if there is no <code>SecurityManager</code> instance available to the
	calling code, which typically indicates an invalid application configuration.</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/SecurityUtils.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 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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 © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>