| <!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>AccessControlFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/web/filter/AccessControlFilter.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.filter; |
| <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.subject.Subject; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Superclass for any filter that controls access to a resource and may redirect the user to the login page</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * if they are not authenticated. This superclass provides the method</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * which is used by many subclasses as the behavior when a user is unauthenticated.</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 0.9</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">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/web/filter/AccessControlFilter.html">AccessControlFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/web/filter/PathMatchingFilter.html">PathMatchingFilter</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"> * Simple default login URL equal to <code>/login.jsp</code>, which can be overridden by calling the</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link #setLoginUrl(String) setLoginUrl} method.</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_LOGIN_URL = <span class="jxr_string">"/login.jsp"</span>; |
| <a name="44" href="#44">44</a> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Constant representing the HTTP 'GET' request method, equal to <code>GET</code>.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String GET_METHOD = <span class="jxr_string">"GET"</span>; |
| <a name="49" href="#49">49</a> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Constant representing the HTTP 'POST' request method, equal to <code>POST</code>.</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String POST_METHOD = <span class="jxr_string">"POST"</span>; |
| <a name="54" href="#54">54</a> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The login url to used to authenticate a user, used when redirecting users if authentication is required.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> String loginUrl = DEFAULT_LOGIN_URL; |
| <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"> * Returns the login URL used to authenticate a user.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Most Shiro filters use this url</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * as the location to redirect a user when the filter requires authentication. Unless overridden, the</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * {@link #DEFAULT_LOGIN_URL DEFAULT_LOGIN_URL} is assumed, which can be overridden via</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * {@link #setLoginUrl(String) setLoginUrl}.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return the login URL used to authenticate a user, used when redirecting users if authentication is required.</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> String getLoginUrl() { |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">return</strong> loginUrl; |
| <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"> * Sets the login URL used to authenticate a user.</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Most Shiro filters use this url as the location to redirect a user when the filter requires</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * authentication. Unless overridden, the {@link #DEFAULT_LOGIN_URL DEFAULT_LOGIN_URL} is assumed.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param loginUrl the login URL used to authenticate a user, used when redirecting users if authentication is required.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLoginUrl(String loginUrl) { |
| <a name="83" href="#83">83</a> <strong class="jxr_keyword">this</strong>.loginUrl = loginUrl; |
| <a name="84" href="#84">84</a> } |
| <a name="85" href="#85">85</a> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * Convenience method that acquires the Subject associated with the request.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * The default implementation simply returns</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.SecurityUtils#getSubject() SecurityUtils.getSubject()}.</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @return the Subject associated with the request.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> getSubject(ServletRequest request, ServletResponse response) { |
| <a name="97" href="#97">97</a> <strong class="jxr_keyword">return</strong> SecurityUtils.getSubject(); |
| <a name="98" href="#98">98</a> } |
| <a name="99" href="#99">99</a> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if the request is allowed to proceed through the filter normally, or <code>false</code></em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * if the request should be handled by the</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object) onAccessDenied(request,response,mappedValue)}</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * method instead.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the request should proceed through the filter normally, <code>false</code> if the</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * request should be processed by this filter's</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object)} method instead.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs during processing.</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception; |
| <a name="115" href="#115">115</a> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Processes requests where the subject was denied access as determined by the</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * method, retaining the {@code mappedValue} that was used during configuration.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * This method immediately delegates to {@link #onAccessDenied(ServletRequest,ServletResponse)} as a</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * convenience in that most post-denial behavior does not need the mapped config again.</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param mappedValue the config specified for the filter in the matching request's filter chain.</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the request should continue to be processed; false if the subclass will</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * handle/render the response directly.</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @throws Exception if there is an error processing the request.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @since 1.0</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> <strong class="jxr_keyword">boolean</strong> onAccessDenied(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong> onAccessDenied(request, response); |
| <a name="134" href="#134">134</a> } |
| <a name="135" href="#135">135</a> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Processes requests where the subject was denied access as determined by the</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * method.</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the request should continue to be processed; false if the subclass will</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * handle/render the response directly.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @throws Exception if there is an error processing the request.</em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="147" href="#147">147</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> onAccessDenied(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception; |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * {@link #isAccessAllowed(ServletRequest,ServletResponse,Object) isAccessAllowed(Request,Response,Object)},</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * otherwise returns the result of</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object) onAccessDenied(Request,Response,Object)}.</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed},</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * otherwise returns the result of</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse) onAccessDenied}.</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @throws Exception if an error occurs.</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="161" href="#161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">return</strong> isAccessAllowed(request, response, mappedValue) || onAccessDenied(request, response, mappedValue); |
| <a name="163" href="#163">163</a> } |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * Returns <code>true</code> if the incoming request is a login request, <code>false</code> otherwise.</em> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * The default implementation merely returns <code>true</code> if the incoming request matches the configured</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * {@link #getLoginUrl() loginUrl} by calling</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * <code>{@link #pathsMatch(String, String) pathsMatch(loginUrl, request)}</code>.</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the incoming request is a login request, <code>false</code> otherwise.</em> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="176" href="#176">176</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginRequest(ServletRequest request, ServletResponse response) { |
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> pathsMatch(getLoginUrl(), request); |
| <a name="178" href="#178">178</a> } |
| <a name="179" href="#179">179</a> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * Convenience method for subclasses to use when a login redirect is required.</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * This implementation simply calls {@link #saveRequest(javax.servlet.ServletRequest) saveRequest(request)}</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * and then {@link #redirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse) redirectToLogin(request,response)}.</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs.</em> |
| <a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="190" href="#190">190</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> saveRequestAndRedirectToLogin(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> IOException { |
| <a name="191" href="#191">191</a> saveRequest(request); |
| <a name="192" href="#192">192</a> redirectToLogin(request, response); |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * Convenience method merely delegates to</em> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * {@link WebUtils#saveRequest(javax.servlet.ServletRequest) WebUtils.saveRequest(request)} to save the request</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * state for reuse later. This is mostly used to retain user request state when a redirect is issued to</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * return the user to their originally requested url/resource.</em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * If you need to save and then immediately redirect the user to login, consider using</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * saveRequestAndRedirectToLogin(request,response)} directly.</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest to save for re-use later (for example, after a redirect).</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="207" href="#207">207</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> saveRequest(ServletRequest request) { |
| <a name="208" href="#208">208</a> WebUtils.saveRequest(request); |
| <a name="209" href="#209">209</a> } |
| <a name="210" href="#210">210</a> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * Convenience method for subclasses that merely acquires the {@link #getLoginUrl() getLoginUrl} and redirects</em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * the request to that url.</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * <b>N.B.</b> If you want to issue a redirect with the intention of allowing the user to then return to their</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * originally requested URL, don't use this method directly. Instead you should call</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * saveRequestAndRedirectToLogin(request,response)}, which will save the current request state so that it can</em> |
| <a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * be reconstructed and re-used after a successful login.</em> |
| <a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @throws IOException if an error occurs.</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="225" href="#225">225</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> redirectToLogin(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> IOException { |
| <a name="226" href="#226">226</a> String loginUrl = getLoginUrl(); |
| <a name="227" href="#227">227</a> WebUtils.issueRedirect(request, response, loginUrl); |
| <a name="228" href="#228">228</a> } |
| <a name="229" href="#229">229</a> |
| <a name="230" href="#230">230</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
