Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.7.0 / shiro-core / apidocs / org / apache / shiro / subject / class-use / Subject.Builder.html
blob: 42aa745b941f84c5cfe9d8be1e63afcc096e7358 [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>Uses of Class org.apache.shiro.subject.Subject.Builder (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="Uses of Class org.apache.shiro.subject.Subject.Builder (Apache Shiro :: Core 1.7.0 API)";
}
}
catch(err) {
}
//-->
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><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<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>
<main role="main">
<div class="header">
<h2 title="Uses of Class org.apache.shiro.subject.Subject.Builder" class="title">Uses of Class<br>org.apache.shiro.subject.Subject.Builder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.subject">org.apache.shiro.subject</a></th>
<td class="colLast">
<div class="block">Components supporting the <a href="../Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> interface, the most important concept in
Shiro's API.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.shiro.subject">
<!-- -->
</a>
<h3>Uses of <a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a> in <a href="../package-summary.html">org.apache.shiro.subject</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.shiro.subject</a> that return <a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#authenticated(boolean)">authenticated</a></span>&#8203;(boolean&nbsp;authenticated)</code></th>
<td class="colLast">
<div class="block">Ensures the <code>Subject</code> being built will be considered
<a href="../Subject.html#isAuthenticated()"><code>authenticated</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#contextAttribute(java.lang.String,java.lang.Object)">contextAttribute</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;attributeKey,
<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>&nbsp;attributeValue)</code></th>
<td class="colLast">
<div class="block">Allows custom attributes to be added to the underlying context <code>Map</code> used to construct the
<a href="../Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#host(java.lang.String)">host</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;host)</code></th>
<td class="colLast">
<div class="block">Ensures the <code>Subject</code> being built will reflect the specified host name or IP as its originating
location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#principals(org.apache.shiro.subject.PrincipalCollection)">principals</a></span>&#8203;(<a href="../PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</a>&nbsp;principals)</code></th>
<td class="colLast">
<div class="block">Ensures the <code>Subject</code> being built will reflect the specified principals (aka identity).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#session(org.apache.shiro.session.Session)">session</a></span>&#8203;(<a href="../../session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</code></th>
<td class="colLast">
<div class="block">Ensures the <code>Subject</code> being built will use the specified <a href="../../session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#sessionCreationEnabled(boolean)">sessionCreationEnabled</a></span>&#8203;(boolean&nbsp;enabled)</code></th>
<td class="colLast">
<div class="block">Configures whether or not the created Subject instance can create a new <code>Session</code> if one does not
already exist.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Subject.Builder.</span><code><span class="memberNameLink"><a href="../Subject.Builder.html#sessionId(java.io.Serializable)">sessionId</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>&nbsp;sessionId)</code></th>
<td class="colLast">
<div class="block">Enables building a <a href="../Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> instance that owns the <a href="../../session/Session.html" title="interface in org.apache.shiro.session"><code>Session</code></a> with the
specified <code>sessionId</code>.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<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><a href="../Subject.Builder.html" title="class in org.apache.shiro.subject">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<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>