| <!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:27 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>WebSubject.Builder (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="WebSubject.Builder (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/WebSubject.Builder.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/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/subject/WebSubject.Builder.html" target="_top">Frames</a></li> |
| <li><a href="WebSubject.Builder.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: </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 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="Class WebSubject.Builder" class="title">Class WebSubject.Builder</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><a href="../../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject">org.apache.shiro.subject.Subject.Builder</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.subject.WebSubject.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject">WebSubject</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.html#line.58">WebSubject.Builder</a> |
| extends <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></pre> |
| <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> |
| </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"> </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/web/subject/WebSubject.Builder.html#WebSubject.Builder(org.apache.shiro.mgt.SecurityManager, javax.servlet.ServletRequest, javax.servlet.ServletResponse)">WebSubject.Builder</a></strong>(<a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Constructs a new <code>Web.Builder</code> instance using the specified <code>SecurityManager</code> instance to |
| create the <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html#WebSubject.Builder(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">WebSubject.Builder</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Constructs a new <code>Web.Builder</code> instance using the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> obtained by |
| calling <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSecurityManager()"><code>getSecurityManager()</code></a>.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </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><a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject">WebSubject</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html#buildWebSubject()">buildWebSubject</a></strong>()</code> |
| <div class="block">Returns <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#buildSubject()"><code>super.buildSubject()</code></a>, but additionally ensures that the returned instance |
| is an <code>instanceof</code> <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> and to support a type-safe method so a caller |
| does not have to cast.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html#newSubjectContextInstance()">newSubjectContextInstance</a></strong>()</code> |
| <div class="block">Overrides the parent implementation to return a new instance of a |
| <a href="../../../../../org/apache/shiro/web/subject/support/DefaultWebSubjectContext.html" title="class in org.apache.shiro.web.subject.support"><code>DefaultWebSubjectContext</code></a> to account for the additional request/response |
| pair.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html#setRequest(javax.servlet.ServletRequest)">setRequest</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</code> |
| <div class="block">Called by the <code>WebSubject.Builder</code> constructor, this method places the request object in the |
| context map for later retrieval.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html#setResponse(javax.servlet.ServletResponse)">setResponse</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</code> |
| <div class="block">Called by the <code>WebSubject.Builder</code> constructor, this method places the response object in the |
| context map for later retrieval.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.subject.Subject.Builder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.subject.<a href="../../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></h3> |
| <code><a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#authenticated(boolean)">authenticated</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#buildSubject()">buildSubject</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#contextAttribute(java.lang.String, java.lang.Object)">contextAttribute</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#getSubjectContext()">getSubjectContext</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#host(java.lang.String)">host</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#principals(org.apache.shiro.subject.PrincipalCollection)">principals</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#session(org.apache.shiro.session.Session)">session</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#sessionCreationEnabled(boolean)">sessionCreationEnabled</a>, <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#sessionId(java.io.Serializable)">sessionId</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="WebSubject.Builder(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSubject.Builder</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.70">WebSubject.Builder</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">Constructs a new <code>Web.Builder</code> instance using the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> obtained by |
| calling <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSecurityManager()"><code>getSecurityManager()</code></a>. If you want |
| to specify your own SecurityManager instance, use the |
| <code>#Builder(SecurityManager, ServletRequest, ServletResponse)</code> constructor instead.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the incoming ServletRequest that will be associated with the built <code>WebSubject</code> instance.</dd><dd><code>response</code> - the outgoing ServletRequest paired with the ServletRequest that will be associated with the |
| built <code>WebSubject</code> instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="WebSubject.Builder(org.apache.shiro.mgt.SecurityManager, javax.servlet.ServletRequest, javax.servlet.ServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSubject.Builder</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.85">WebSubject.Builder</a>(<a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a> securityManager, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">Constructs a new <code>Web.Builder</code> instance using the specified <code>SecurityManager</code> instance to |
| create the <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>securityManager</code> - the <code>SecurityManager SecurityManager</code> instance to use to build the |
| <code>WebSubject</code> instance.</dd><dd><code>request</code> - the incoming ServletRequest that will be associated with the built <code>WebSubject</code> |
| instance.</dd><dd><code>response</code> - the outgoing ServletRequest paired with the ServletRequest that will be associated |
| with the built <code>WebSubject</code> instance.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newSubjectContextInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSubjectContextInstance</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject">SubjectContext</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.106">newSubjectContextInstance</a>()</pre> |
| <div class="block">Overrides the parent implementation to return a new instance of a |
| <a href="../../../../../org/apache/shiro/web/subject/support/DefaultWebSubjectContext.html" title="class in org.apache.shiro.web.subject.support"><code>DefaultWebSubjectContext</code></a> to account for the additional request/response |
| pair.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#newSubjectContextInstance()">newSubjectContextInstance</a></code> in class <code><a href="../../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject">Subject.Builder</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new instance of a <a href="../../../../../org/apache/shiro/web/subject/support/DefaultWebSubjectContext.html" title="class in org.apache.shiro.web.subject.support"><code>DefaultWebSubjectContext</code></a> to account for the |
| additional request/response pair.</dd></dl> |
| </li> |
| </ul> |
| <a name="setRequest(javax.servlet.ServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequest</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.117">setRequest</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</pre> |
| <div class="block">Called by the <code>WebSubject.Builder</code> constructor, this method places the request object in the |
| context map for later retrieval.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the incoming ServletRequest that triggered the creation of the <code>WebSubject</code> instance.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>'this' for method chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="setResponse(javax.servlet.ServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResponse</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/web/subject/WebSubject.Builder.html" title="class in org.apache.shiro.web.subject">WebSubject.Builder</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.132">setResponse</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response)</pre> |
| <div class="block">Called by the <code>WebSubject.Builder</code> constructor, this method places the response object in the |
| context map for later retrieval.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code> - the outgoing ServletRequest paired with the ServletRequest that triggered the creation of |
| the <code>WebSubject</code> instance.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>'this' for method chaining.</dd></dl> |
| </li> |
| </ul> |
| <a name="buildWebSubject()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>buildWebSubject</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject">WebSubject</a> <a href="../../../../../src-html/org/apache/shiro/web/subject/WebSubject.Builder.html#line.147">buildWebSubject</a>()</pre> |
| <div class="block">Returns <a href="../../../../../org/apache/shiro/subject/Subject.Builder.html#buildSubject()"><code>super.buildSubject()</code></a>, but additionally ensures that the returned instance |
| is an <code>instanceof</code> <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> and to support a type-safe method so a caller |
| does not have to cast. Per the parent class's method JavaDoc, this method will return a new instance |
| each time it is called.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><code>WebSubject</code></a> instance built by this <code>Builder</code>.</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/WebSubject.Builder.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/web/subject/WebSubject.html" title="interface in org.apache.shiro.web.subject"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/subject/WebSubject.Builder.html" target="_top">Frames</a></li> |
| <li><a href="WebSubject.Builder.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: </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 name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |