| <!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>AuthorizationFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/filter/authz/AuthorizationFilter.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.authz; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.filter.AccessControlFilter; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.IOException; |
| <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"> * Superclass for authorization-related filters. If an request is unauthorized, response handling is delegated to the</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse) onAccessDenied} method, which</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * provides reasonable handling for most applications.</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @see #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="39" href="#39">39</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/authz/AuthorizationFilter.html">AuthorizationFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/web/filter/AccessControlFilter.html">AccessControlFilter</a> { |
| <a name="40" href="#40">40</a> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The URL to which users should be redirected if they are denied access to an underlying path or resource,</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * {@code null} by default which will issue a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * (401 Unauthorized).</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> String unauthorizedUrl; |
| <a name="47" href="#47">47</a> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Returns the URL to which users should be redirected if they are denied access to an underlying path or resource,</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * or {@code null} if a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response should be issued (401 Unauthorized).</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * The default is {@code null}, ensuring default web server behavior. Override this default by calling the</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * {@link #setUnauthorizedUrl(String) setUnauthorizedUrl} method with a meaningful path within your application</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * if you would like to show the user a 'nice' page in the event of unauthorized access.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @return the URL to which users should be redirected if they are denied access to an underlying path or resource,</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * or {@code null} if a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response should be issued (401 Unauthorized).</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> String getUnauthorizedUrl() { |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">return</strong> unauthorizedUrl; |
| <a name="61" href="#61">61</a> } |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Sets the URL to which users should be redirected if they are denied access to an underlying path or resource.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * If the value is {@code null} a raw {@link HttpServletResponse#SC_UNAUTHORIZED} response will</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * be issued (401 Unauthorized), retaining default web server behavior.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Unless overridden by calling this method, the default value is {@code null}. If desired, you can specify a</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * meaningful path within your application if you would like to show the user a 'nice' page in the event of</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * unauthorized access.</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param unauthorizedUrl the URL to which users should be redirected if they are denied access to an underlying</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * path or resource, or {@code null} to a ensure raw {@link HttpServletResponse#SC_UNAUTHORIZED} response is</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * issued (401 Unauthorized).</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUnauthorizedUrl(String unauthorizedUrl) { |
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">this</strong>.unauthorizedUrl = unauthorizedUrl; |
| <a name="79" href="#79">79</a> } |
| <a name="80" href="#80">80</a> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Handles the response when access has been denied. It behaves as follows:</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <li>If the {@code Subject} is unknown<sup><a href="#known">[1]</a></sup>:</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * <ol><li>The incoming request will be saved and they will be redirected to the login page for authentication</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * (via the {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * method).</li></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <li>Once successfully authenticated, they will be redirected back to the originally attempted page.</li></ol></em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * </li></em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <li>If the Subject is known:</li></em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <li>The HTTP {@link HttpServletResponse#SC_UNAUTHORIZED} header will be set (401 Unauthorized)</li></em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <li>If the {@link #getUnauthorizedUrl() unauthorizedUrl} has been configured, a redirect will be issued to that</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * URL. Otherwise the 401 response is rendered normally</li></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <code><a name="known">[1]</a></code>: A {@code Subject} is 'known' when</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * <code>subject.{@link org.apache.shiro.subject.Subject#getPrincipal() getPrincipal()}</code> is not {@code null},</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * which implicitly means that the subject is either currently authenticated or they have been remembered via</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * 'remember me' services.</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param response the outgoing <code>ServletResponse</code></em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @return {@code false} always for this implementation.</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @throws IOException if there is any servlet error.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onAccessDenied(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> IOException { |
| <a name="107" href="#107">107</a> |
| <a name="108" href="#108">108</a> <a href="../../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = getSubject(request, response); |
| <a name="109" href="#109">109</a> <em class="jxr_comment">// If the subject isn't identified, redirect to login URL</em> |
| <a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (subject.getPrincipal() == <strong class="jxr_keyword">null</strong>) { |
| <a name="111" href="#111">111</a> saveRequestAndRedirectToLogin(request, response); |
| <a name="112" href="#112">112</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="113" href="#113">113</a> <em class="jxr_comment">// If subject is known but not authorized, redirect to the unauthorized URL if there is one</em> |
| <a name="114" href="#114">114</a> <em class="jxr_comment">// If no unauthorized URL is specified, just return an unauthorized HTTP status code</em> |
| <a name="115" href="#115">115</a> String unauthorizedUrl = getUnauthorizedUrl(); |
| <a name="116" href="#116">116</a> <em class="jxr_comment">//SHIRO-142 - ensure that redirect _or_ error code occurs - both cannot happen due to response commit:</em> |
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (StringUtils.hasText(unauthorizedUrl)) { |
| <a name="118" href="#118">118</a> WebUtils.issueRedirect(request, response, unauthorizedUrl); |
| <a name="119" href="#119">119</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="120" href="#120">120</a> WebUtils.toHttp(response).sendError(HttpServletResponse.SC_UNAUTHORIZED); |
| <a name="121" href="#121">121</a> } |
| <a name="122" href="#122">122</a> } |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="124" href="#124">124</a> } |
| <a name="125" href="#125">125</a> |
| <a name="126" href="#126">126</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |