Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.1 / apidocs / org / apache / shiro / web / subject / WebSubject.html
blob: 3c091ee74478143ea6bae114386016c9590dcf80 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_201) on Wed May 01 07:16:45 RET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WebSubject (Apache Shiro 1.4.1 API)</title>
<meta name="date" content="2019-05-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WebSubject (Apache Shiro 1.4.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/web/subject/WebSubject.html" target="_top">Frames</a></li>
<li><a href="WebSubject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.web.subject</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><a href="../../../../../org/apache/shiro/web/util/RequestPairSource.html" title="interface in org.apache.shiro.web.util">RequestPairSource</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/shiro/web/subject/support/WebDelegatingSubject.html" title="class in org.apache.shiro.web.subject.support">WebDelegatingSubject</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.html#line.37">WebSubject</a>
extends <a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>, <a href="../../../../../org/apache/shiro/web/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
<code>ServletRequest</code>.</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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a></span></code>
<div class="block">A <code>WebSubject.Builder</code> performs the same function as a <code>Subject.Builder</code>, 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>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>javax.servlet.ServletRequest</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/subject/WebSubject.html#getServletRequest--">getServletRequest</a></span>()</code>
<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>javax.servlet.ServletResponse</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/subject/WebSubject.html#getServletResponse--">getServletResponse</a></span>()</code>
<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 name="methods.inherited.from.class.org.apache.shiro.subject.Subject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.shiro.subject.<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></h3>
<code><a href="../../../../../org/apache/shiro/subject/Subject.html#associateWith-java.util.concurrent.Callable-">associateWith</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#associateWith-java.lang.Runnable-">associateWith</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkPermission-org.apache.shiro.authz.Permission-">checkPermission</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkPermission-java.lang.String-">checkPermission</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkPermissions-java.util.Collection-">checkPermissions</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkPermissions-java.lang.String...-">checkPermissions</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkRole-java.lang.String-">checkRole</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkRoles-java.util.Collection-">checkRoles</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#checkRoles-java.lang.String...-">checkRoles</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#execute-java.util.concurrent.Callable-">execute</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#execute-java.lang.Runnable-">execute</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#getPreviousPrincipals--">getPreviousPrincipals</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#getPrincipal--">getPrincipal</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#getPrincipals--">getPrincipals</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#getSession--">getSession</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#getSession-boolean-">getSession</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#hasAllRoles-java.util.Collection-">hasAllRoles</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#hasRole-java.lang.String-">hasRole</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#hasRoles-java.util.List-">hasRoles</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isAuthenticated--">isAuthenticated</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermitted-java.util.List-">isPermitted</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermitted-org.apache.shiro.authz.Permission-">isPermitted</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermitted-java.lang.String...-">isPermitted</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermitted-java.lang.String-">isPermitted</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermittedAll-java.util.Collection-">isPermittedAll</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isPermittedAll-java.lang.String...-">isPermittedAll</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isRemembered--">isRemembered</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#isRunAs--">isRunAs</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#login-org.apache.shiro.authc.AuthenticationToken-">login</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#logout--">logout</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#releaseRunAs--">releaseRunAs</a>, <a href="../../../../../org/apache/shiro/subject/Subject.html#runAs-org.apache.shiro.subject.PrincipalCollection-">runAs</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getServletRequest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletRequest</h4>
<pre>javax.servlet.ServletRequest&nbsp;<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="../../../../../org/apache/shiro/web/util/RequestPairSource.html#getServletRequest--">getServletRequest</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/web/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 name="getServletResponse--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getServletResponse</h4>
<pre>javax.servlet.ServletResponse&nbsp;<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="../../../../../org/apache/shiro/web/util/RequestPairSource.html#getServletResponse--">getServletResponse</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/shiro/web/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>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/web/subject/WebSubject.html" target="_top">Frames</a></li>
<li><a href="WebSubject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>