| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>WebSubject xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/subject/WebSubject.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.subject; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.mgt.SecurityManager; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SubjectContext; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.subject.support.DefaultWebSubjectContext; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.RequestPairSource; |
| <a name="27" href="#27">27</a> |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="30" href="#30">30</a> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * A {@code WebSubject} represents a Subject instance that was acquired as a result of an incoming</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * {@link ServletRequest}.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html">WebSubject</a> <strong class="jxr_keyword">extends</strong> Subject, <a href="../../../../../org/apache/shiro/web/util/RequestPairSource.html">RequestPairSource</a> { |
| <a name="38" href="#38">38</a> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Returns the {@code ServletRequest} accessible when the Subject instance was created.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @return the {@code ServletRequest} accessible when the Subject instance was created.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="44" href="#44">44</a> ServletRequest getServletRequest(); |
| <a name="45" href="#45">45</a> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Returns the {@code ServletResponse} accessible when the Subject instance was created.</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @return the {@code ServletResponse} accessible when the Subject instance was created.</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="51" href="#51">51</a> ServletResponse getServletResponse(); |
| <a name="52" href="#52">52</a> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * A {@code WebSubject.Builder} performs the same function as a {@link Subject.Builder Subject.Builder}, but</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * additionally ensures that the Servlet request/response pair that is triggering the Subject instance's creation</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * is retained for use by internal Shiro components as necessary.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Builder</a> <strong class="jxr_keyword">extends</strong> Subject.Builder { |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Constructs a new {@code Web.Builder} instance using the {@link SecurityManager SecurityManager} obtained by</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * calling {@code SecurityUtils.}{@link SecurityUtils#getSecurityManager() getSecurityManager()}. If you want</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * to specify your own SecurityManager instance, use the</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * {@link #Builder(SecurityManager, ServletRequest, ServletResponse)} constructor instead.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest that will be associated with the built {@code WebSubject} instance.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletRequest paired with the ServletRequest that will be associated with the</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * built {@code WebSubject} instance.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Builder</a>(ServletRequest request, ServletResponse response) { |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">this</strong>(SecurityUtils.getSecurityManager(), request, response); |
| <a name="72" href="#72">72</a> } |
| <a name="73" href="#73">73</a> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Constructs a new {@code Web.Builder} instance using the specified {@code SecurityManager} instance to</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * create the {@link WebSubject WebSubject} instance.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param securityManager the {@code SecurityManager SecurityManager} instance to use to build the</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * {@code WebSubject} instance.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest that will be associated with the built {@code WebSubject}</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * instance.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletRequest paired with the ServletRequest that will be associated</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * with the built {@code WebSubject} instance.</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Builder</a>(<a href="../../../../../org/apache/shiro/mgt/SecurityManager.html">SecurityManager</a> securityManager, ServletRequest request, ServletResponse response) { |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">super</strong>(securityManager); |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (request == <strong class="jxr_keyword">null</strong>) { |
| <a name="88" href="#88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ServletRequest argument cannot be null."</span>); |
| <a name="89" href="#89">89</a> } |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> (response == <strong class="jxr_keyword">null</strong>) { |
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ServletResponse argument cannot be null."</span>); |
| <a name="92" href="#92">92</a> } |
| <a name="93" href="#93">93</a> setRequest(request); |
| <a name="94" href="#94">94</a> setResponse(response); |
| <a name="95" href="#95">95</a> } |
| <a name="96" href="#96">96</a> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Overrides the parent implementation to return a new instance of a</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * {@link DefaultWebSubjectContext DefaultWebSubjectContext} to account for the additional request/response</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * pair.</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @return a new instance of a {@link DefaultWebSubjectContext DefaultWebSubjectContext} to account for the</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * additional request/response pair.</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="105" href="#105">105</a> @Override |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/SubjectContext.html">SubjectContext</a> newSubjectContextInstance() { |
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/web/subject/support/DefaultWebSubjectContext.html">DefaultWebSubjectContext</a>(); |
| <a name="108" href="#108">108</a> } |
| <a name="109" href="#109">109</a> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Called by the {@code WebSubject.Builder} constructor, this method places the request object in the</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * context map for later retrieval.</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest that triggered the creation of the {@code WebSubject} instance.</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @return 'this' for method chaining.</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Builder</a> setRequest(ServletRequest request) { |
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">if</strong> (request != <strong class="jxr_keyword">null</strong>) { |
| <a name="119" href="#119">119</a> ((<a href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html">WebSubjectContext</a>) getSubjectContext()).setServletRequest(request); |
| <a name="120" href="#120">120</a> } |
| <a name="121" href="#121">121</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="122" href="#122">122</a> } |
| <a name="123" href="#123">123</a> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * Called by the {@code WebSubject.Builder} constructor, this method places the response object in the</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * context map for later retrieval.</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @param response the outgoing ServletRequest paired with the ServletRequest that triggered the creation of</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * the {@code WebSubject} instance.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @return 'this' for method chaining.</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Builder</a> setResponse(ServletResponse response) { |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> (response != <strong class="jxr_keyword">null</strong>) { |
| <a name="134" href="#134">134</a> ((<a href="../../../../../org/apache/shiro/web/subject/WebSubjectContext.html">WebSubjectContext</a>) getSubjectContext()).setServletResponse(response); |
| <a name="135" href="#135">135</a> } |
| <a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>; |
| <a name="137" href="#137">137</a> } |
| <a name="138" href="#138">138</a> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * Returns {@link #buildSubject() super.buildSubject()}, but additionally ensures that the returned instance</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * is an {@code instanceof} {@link WebSubject WebSubject} and to support a type-safe method so a caller</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * does not have to cast. Per the parent class's method JavaDoc, this method will return a new instance</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * each time it is called.</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return a new {@link WebSubject WebSubject} instance built by this {@code Builder}.</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/web/subject/WebSubject.html">WebSubject</a> buildWebSubject() { |
| <a name="148" href="#148">148</a> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = <strong class="jxr_keyword">super</strong>.buildSubject(); |
| <a name="149" href="#149">149</a> <strong class="jxr_keyword">if</strong> (!(subject instanceof WebSubject)) { |
| <a name="150" href="#150">150</a> String msg = <span class="jxr_string">"Subject implementation returned from the SecurityManager was not a "</span> + |
| <a name="151" href="#151">151</a> WebSubject.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">" implementation. Please ensure a Web-enabled SecurityManager "</span> + |
| <a name="152" href="#152">152</a> <span class="jxr_string">"has been configured and made available to this builder."</span>; |
| <a name="153" href="#153">153</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="154" href="#154">154</a> } |
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> (WebSubject) subject; |
| <a name="156" href="#156">156</a> } |
| <a name="157" href="#157">157</a> } |
| <a name="158" href="#158">158</a> |
| <a name="159" href="#159">159</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
