| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Mon Aug 17 10:30:05 EDT 2020 --> |
| <title>WebSubject (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="WebSubject (Apache Shiro 1.6.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/WebSubject.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.web.subject</a></div> |
| <h2 title="Interface WebSubject" class="title">Interface WebSubject</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../util/RequestPairSource.html" title="interface in org.apache.shiro.web.util">RequestPairSource</a></code>, <code><a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="support/WebDelegatingSubject.html" title="class in org.apache.shiro.web.subject.support">WebDelegatingSubject</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.html#line.37">WebSubject</a> |
| extends <a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>, <a href="../util/RequestPairSource.html" title="interface in org.apache.shiro.web.util">RequestPairSource</a></pre> |
| <div class="block">A <code>WebSubject</code> represents a Subject instance that was acquired as a result of an incoming |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink"><code>ServletRequest</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A <code>WebSubject.Builder</code> performs the same function as a <a href="../../subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><code>Subject.Builder</code></a>, but |
| additionally ensures that the Servlet request/response pair that is triggering the Subject instance's creation |
| is retained for use by internal Shiro components as necessary.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletRequest()">getServletRequest</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>ServletRequest</code> accessible when the Subject instance was created.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletResponse()">getServletResponse</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>ServletResponse</code> accessible when the Subject instance was created.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.subject.Subject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.subject.<a href="../../subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></h3> |
| <code><a href="../../subject/Subject.html#associateWith(java.lang.Runnable)">associateWith</a>, <a href="../../subject/Subject.html#associateWith(java.util.concurrent.Callable)">associateWith</a>, <a href="../../subject/Subject.html#checkPermission(java.lang.String)">checkPermission</a>, <a href="../../subject/Subject.html#checkPermission(org.apache.shiro.authz.Permission)">checkPermission</a>, <a href="../../subject/Subject.html#checkPermissions(java.lang.String...)">checkPermissions</a>, <a href="../../subject/Subject.html#checkPermissions(java.util.Collection)">checkPermissions</a>, <a href="../../subject/Subject.html#checkRole(java.lang.String)">checkRole</a>, <a href="../../subject/Subject.html#checkRoles(java.lang.String...)">checkRoles</a>, <a href="../../subject/Subject.html#checkRoles(java.util.Collection)">checkRoles</a>, <a href="../../subject/Subject.html#execute(java.lang.Runnable)">execute</a>, <a href="../../subject/Subject.html#execute(java.util.concurrent.Callable)">execute</a>, <a href="../../subject/Subject.html#getPreviousPrincipals()">getPreviousPrincipals</a>, <a href="../../subject/Subject.html#getPrincipal()">getPrincipal</a>, <a href="../../subject/Subject.html#getPrincipals()">getPrincipals</a>, <a href="../../subject/Subject.html#getSession()">getSession</a>, <a href="../../subject/Subject.html#getSession(boolean)">getSession</a>, <a href="../../subject/Subject.html#hasAllRoles(java.util.Collection)">hasAllRoles</a>, <a href="../../subject/Subject.html#hasRole(java.lang.String)">hasRole</a>, <a href="../../subject/Subject.html#hasRoles(java.util.List)">hasRoles</a>, <a href="../../subject/Subject.html#isAuthenticated()">isAuthenticated</a>, <a href="../../subject/Subject.html#isPermitted(java.lang.String)">isPermitted</a>, <a href="../../subject/Subject.html#isPermitted(java.lang.String...)">isPermitted</a>, <a href="../../subject/Subject.html#isPermitted(java.util.List)">isPermitted</a>, <a href="../../subject/Subject.html#isPermitted(org.apache.shiro.authz.Permission)">isPermitted</a>, <a href="../../subject/Subject.html#isPermittedAll(java.lang.String...)">isPermittedAll</a>, <a href="../../subject/Subject.html#isPermittedAll(java.util.Collection)">isPermittedAll</a>, <a href="../../subject/Subject.html#isRemembered()">isRemembered</a>, <a href="../../subject/Subject.html#isRunAs()">isRunAs</a>, <a href="../../subject/Subject.html#login(org.apache.shiro.authc.AuthenticationToken)">login</a>, <a href="../../subject/Subject.html#logout()">logout</a>, <a href="../../subject/Subject.html#releaseRunAs()">releaseRunAs</a>, <a href="../../subject/Subject.html#runAs(org.apache.shiro.subject.PrincipalCollection)">runAs</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getServletRequest()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletRequest</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.html#line.44">getServletRequest</a>()</pre> |
| <div class="block">Returns the <code>ServletRequest</code> accessible when the Subject instance was created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/RequestPairSource.html#getServletRequest()">getServletRequest</a></code> in interface <code><a href="../util/RequestPairSource.html" title="interface in org.apache.shiro.web.util">RequestPairSource</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>ServletRequest</code> accessible when the Subject instance was created.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServletResponse()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getServletResponse</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.html#line.51">getServletResponse</a>()</pre> |
| <div class="block">Returns the <code>ServletResponse</code> accessible when the Subject instance was created.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/RequestPairSource.html#getServletResponse()">getServletResponse</a></code> in interface <code><a href="../util/RequestPairSource.html" title="interface in org.apache.shiro.web.util">RequestPairSource</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>ServletResponse</code> accessible when the Subject instance was created.</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/WebSubject.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
