Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / src-html / org / apache / shiro / web / filter / authz / HttpMethodPermissionFilter.html
blob: 201d567560dc30615d8fd800a33d1243cba1050b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.web.filter.authz;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.util.StringUtils;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.slf4j.Logger;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.LoggerFactory;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.servlet.ServletRequest;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.servlet.ServletResponse;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.servlet.http.HttpServletRequest;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.IOException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.HashMap;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * A filter that translates an HTTP Request's Method (eg GET, POST, etc)<a name="line.33"></a>
<span class="sourceLineNo">034</span> * into an corresponding action (verb) and uses that verb to construct a permission that will be checked to determine<a name="line.34"></a>
<span class="sourceLineNo">035</span> * access.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p/&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * This Filter is primarily provided to support REST environments where the type (Method)<a name="line.37"></a>
<span class="sourceLineNo">038</span> * of request translates to an action being performed on one or more resources. This paradigm works well with Shiro's<a name="line.38"></a>
<span class="sourceLineNo">039</span> * concepts of using permissions for access control and can be leveraged to easily perform permission checks.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p/&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * This filter functions as follows:<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;ol&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;li&gt;The incoming HTTP request's Method (GET, POST, PUT, DELETE, etc) is discovered.&lt;/li&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;li&gt;The Method is translated into a more 'application friendly' verb, such as 'create', edit', 'delete', etc.&lt;/li&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;li&gt;The verb is appended to any configured permissions for the<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link org.apache.shiro.web.filter.PathMatchingFilter currently matching path}.&lt;/li&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;li&gt;If the current {@code Subject} {@link org.apache.shiro.subject.Subject#isPermitted(String) isPermitted} to<a name="line.47"></a>
<span class="sourceLineNo">048</span> * perform the resolved action, the request is allowed to continue.&lt;/li&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;/ol&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;p/&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * For example, if the following filter chain was defined, where 'rest' was the name given to a filter instance of<a name="line.51"></a>
<span class="sourceLineNo">052</span> * this class:<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;pre&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * /user/** = rest[user]&lt;/pre&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * Then an HTTP {@code GET} request to {@code /user/1234} would translate to the constructed permission<a name="line.55"></a>
<span class="sourceLineNo">056</span> * {@code user:read} (GET is mapped to the 'read' action) and execute the permission check<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;code&gt;Subject.isPermitted(&amp;quot;user:read&amp;quot;)&lt;/code&gt; in order to allow the request to continue.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;p/&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Similarly, an HTTP {@code POST} to {@code /user} would translate to the constructed permission<a name="line.59"></a>
<span class="sourceLineNo">060</span> * {@code user:create} (POST is mapped to the 'create' action) and execute the permission check<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;code&gt;Subject.isPermitted(&amp;quot;user:create&amp;quot;)&lt;/code&gt; in order to allow the request to continue.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;p/&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;h3&gt;Method To Verb Mapping&lt;/h3&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * The following table represents the default HTTP Method-to-action verb mapping:<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;table&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;tr&gt;&lt;th&gt;HTTP Method&lt;/th&gt;&lt;th&gt;Mapped Action&lt;/th&gt;&lt;th&gt;Example Permission&lt;/th&gt;&lt;th&gt;Runtime Check&lt;/th&gt;&lt;/tr&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;tr&gt;&lt;td&gt;head&lt;/td&gt;&lt;td&gt;read&lt;/td&gt;&lt;td&gt;perm1&lt;/td&gt;&lt;td&gt;perm1:read&lt;/td&gt;&lt;/tr&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;tr&gt;&lt;td&gt;get&lt;/td&gt;&lt;td&gt;read&lt;/td&gt;&lt;td&gt;perm2&lt;/td&gt;&lt;td&gt;perm2:read&lt;/td&gt;&lt;/tr&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;tr&gt;&lt;td&gt;put&lt;/td&gt;&lt;td&gt;update&lt;/td&gt;&lt;td&gt;perm3&lt;/td&gt;&lt;td&gt;perm3:update&lt;/td&gt;&lt;/tr&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;tr&gt;&lt;td&gt;post&lt;/td&gt;&lt;td&gt;create&lt;/td&gt;&lt;td&gt;perm4&lt;/td&gt;&lt;td&gt;perm4:create&lt;/td&gt;&lt;/tr&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;tr&gt;&lt;td&gt;mkcol&lt;/td&gt;&lt;td&gt;create&lt;/td&gt;&lt;td&gt;perm5&lt;/td&gt;&lt;td&gt;perm5:create&lt;/td&gt;&lt;/tr&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;tr&gt;&lt;td&gt;options&lt;/td&gt;&lt;td&gt;read&lt;/td&gt;&lt;td&gt;perm6&lt;/td&gt;&lt;td&gt;perm6:read&lt;/td&gt;&lt;/tr&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;tr&gt;&lt;td&gt;trace&lt;/td&gt;&lt;td&gt;read&lt;/td&gt;&lt;td&gt;perm7&lt;/td&gt;&lt;td&gt;perm7:read&lt;/td&gt;&lt;/tr&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;/table&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> *<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @since 1.0<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span>public class HttpMethodPermissionFilter extends PermissionsAuthorizationFilter {<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * This class's private logger.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> private static final Logger log = LoggerFactory.getLogger(HttpMethodPermissionFilter.class);<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
<span class="sourceLineNo">086</span> * Map that contains a mapping between http methods to permission actions (verbs)<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> private final Map&lt;String, String&gt; httpMethodActions = new HashMap&lt;String, String&gt;();<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> //Actions representing HTTP Method values (GET -&gt; read, POST -&gt; create, etc)<a name="line.90"></a>
<span class="sourceLineNo">091</span> private static final String CREATE_ACTION = "create";<a name="line.91"></a>
<span class="sourceLineNo">092</span> private static final String READ_ACTION = "read";<a name="line.92"></a>
<span class="sourceLineNo">093</span> private static final String UPDATE_ACTION = "update";<a name="line.93"></a>
<span class="sourceLineNo">094</span> private static final String DELETE_ACTION = "delete";<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Enum of constants for well-defined mapping values. Used in the Filter's constructor to perform the map instance<a name="line.97"></a>
<span class="sourceLineNo">098</span> * used at runtime.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> private static enum HttpMethodAction {<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> DELETE(DELETE_ACTION),<a name="line.102"></a>
<span class="sourceLineNo">103</span> GET(READ_ACTION),<a name="line.103"></a>
<span class="sourceLineNo">104</span> HEAD(READ_ACTION),<a name="line.104"></a>
<span class="sourceLineNo">105</span> MKCOL(CREATE_ACTION), //webdav, but useful here<a name="line.105"></a>
<span class="sourceLineNo">106</span> OPTIONS(READ_ACTION),<a name="line.106"></a>
<span class="sourceLineNo">107</span> POST(CREATE_ACTION),<a name="line.107"></a>
<span class="sourceLineNo">108</span> PUT(UPDATE_ACTION),<a name="line.108"></a>
<span class="sourceLineNo">109</span> TRACE(READ_ACTION);<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> private final String action;<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> private HttpMethodAction(String action) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> this.action = action;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> public String getAction() {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return this.action;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * Creates the filter instance with default method-to-action values in the instance's<a name="line.123"></a>
<span class="sourceLineNo">124</span> * {@link #getHttpMethodActions() http method actions map}.<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> public HttpMethodPermissionFilter() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> for (HttpMethodAction methodAction : HttpMethodAction.values()) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> httpMethodActions.put(methodAction.name().toLowerCase(), methodAction.getAction());<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * Returns the HTTP Method name (key) to action verb (value) mapping used to resolve actions based on an<a name="line.133"></a>
<span class="sourceLineNo">134</span> * incoming {@code HttpServletRequest}. All keys and values are lower-case. The<a name="line.134"></a>
<span class="sourceLineNo">135</span> * default key/value pairs are defined in the top class-level JavaDoc.<a name="line.135"></a>
<span class="sourceLineNo">136</span> *<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @return the HTTP Method lower-case name (key) to lower-case action verb (value) mapping<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> protected Map&lt;String, String&gt; getHttpMethodActions() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return this.httpMethodActions;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
<span class="sourceLineNo">144</span> * Determines the action (verb) attempting to be performed on the filtered resource by the current request.<a name="line.144"></a>
<span class="sourceLineNo">145</span> * &lt;p/&gt;<a name="line.145"></a>
<span class="sourceLineNo">146</span> * This implementation expects the incoming request to be an {@link HttpServletRequest} and returns a mapped<a name="line.146"></a>
<span class="sourceLineNo">147</span> * action based on the HTTP request {@link javax.servlet.http.HttpServletRequest#getMethod() method}.<a name="line.147"></a>
<span class="sourceLineNo">148</span> *<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param request to pull the method from.<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @return The string equivalent verb of the http method.<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> protected String getHttpMethodAction(ServletRequest request) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> String method = ((HttpServletRequest) request).getMethod();<a name="line.153"></a>
<span class="sourceLineNo">154</span> return getHttpMethodAction(method);<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> /**<a name="line.157"></a>
<span class="sourceLineNo">158</span> * Determines the corresponding application action that will be performed on the filtered resource based on the<a name="line.158"></a>
<span class="sourceLineNo">159</span> * specified HTTP method (GET, POST, etc).<a name="line.159"></a>
<span class="sourceLineNo">160</span> *<a name="line.160"></a>
<span class="sourceLineNo">161</span> * @param method to be translated into the verb.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @return The string equivalent verb of the method.<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> protected String getHttpMethodAction(String method) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> String lc = method.toLowerCase();<a name="line.165"></a>
<span class="sourceLineNo">166</span> String resolved = getHttpMethodActions().get(lc);<a name="line.166"></a>
<span class="sourceLineNo">167</span> return resolved != null ? resolved : method;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Returns a collection of String permissions with which to perform a permission check to determine if the filter<a name="line.171"></a>
<span class="sourceLineNo">172</span> * will allow the request to continue.<a name="line.172"></a>
<span class="sourceLineNo">173</span> * &lt;p/&gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span> * This implementation merely delegates to {@link #buildPermissions(String[], String)} and ignores the inbound<a name="line.174"></a>
<span class="sourceLineNo">175</span> * HTTP servlet request, but it can be overridden by subclasses for more complex request-specific building logic<a name="line.175"></a>
<span class="sourceLineNo">176</span> * if necessary.<a name="line.176"></a>
<span class="sourceLineNo">177</span> *<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @param request the inbound HTTP request - ignored in this implementation, but available to<a name="line.178"></a>
<span class="sourceLineNo">179</span> * subclasses for more complex construction building logic if necessary<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @param configuredPerms any url-specific permissions mapped to this filter in the URL rules mappings.<a name="line.180"></a>
<span class="sourceLineNo">181</span> * @param action the application-friendly action (verb) resolved based on the HTTP Method name.<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @return a collection of String permissions with which to perform a permission check to determine if the filter<a name="line.182"></a>
<span class="sourceLineNo">183</span> * will allow the request to continue.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> protected String[] buildPermissions(HttpServletRequest request, String[] configuredPerms, String action) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return buildPermissions(configuredPerms, action);<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> /**<a name="line.189"></a>
<span class="sourceLineNo">190</span> * Builds a new array of permission strings based on the original argument, appending the specified action verb<a name="line.190"></a>
<span class="sourceLineNo">191</span> * to each one per {@link org.apache.shiro.authz.permission.WildcardPermission WildcardPermission} conventions. The<a name="line.191"></a>
<span class="sourceLineNo">192</span> * built permission strings will be the ones used at runtime during the permission check that determines if filter<a name="line.192"></a>
<span class="sourceLineNo">193</span> * access should be allowed to continue or not.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * &lt;p/&gt;<a name="line.194"></a>
<span class="sourceLineNo">195</span> * For example, if the {@code configuredPerms} argument contains the following 3 permission strings:<a name="line.195"></a>
<span class="sourceLineNo">196</span> * &lt;p/&gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span> * &lt;ol&gt;<a name="line.197"></a>
<span class="sourceLineNo">198</span> * &lt;li&gt;permission:one&lt;/li&gt;<a name="line.198"></a>
<span class="sourceLineNo">199</span> * &lt;li&gt;permission:two&lt;/li&gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span> * &lt;li&gt;permission:three&lt;/li&gt;<a name="line.200"></a>
<span class="sourceLineNo">201</span> * &lt;/ol&gt;<a name="line.201"></a>
<span class="sourceLineNo">202</span> * And the action is {@code read}, then the return value will be:<a name="line.202"></a>
<span class="sourceLineNo">203</span> * &lt;ol&gt;<a name="line.203"></a>
<span class="sourceLineNo">204</span> * &lt;li&gt;permission:one:read&lt;/li&gt;<a name="line.204"></a>
<span class="sourceLineNo">205</span> * &lt;li&gt;permission:two:read&lt;/li&gt;<a name="line.205"></a>
<span class="sourceLineNo">206</span> * &lt;li&gt;permission:three:read&lt;/li&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span> * &lt;/ol&gt;<a name="line.207"></a>
<span class="sourceLineNo">208</span> * per {@link org.apache.shiro.authz.permission.WildcardPermission WildcardPermission} conventions. Subclasses<a name="line.208"></a>
<span class="sourceLineNo">209</span> * are of course free to override this method or the<a name="line.209"></a>
<span class="sourceLineNo">210</span> * {@link #buildPermissions(javax.servlet.http.HttpServletRequest, String[], String) buildPermissions} request<a name="line.210"></a>
<span class="sourceLineNo">211</span> * variant for custom building logic or with different permission formats.<a name="line.211"></a>
<span class="sourceLineNo">212</span> *<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @param configuredPerms list of configuredPerms to be converted.<a name="line.213"></a>
<span class="sourceLineNo">214</span> * @param action the resolved action based on the request method to be appended to permission strings.<a name="line.214"></a>
<span class="sourceLineNo">215</span> * @return an array of permission strings with each element appended with the action.<a name="line.215"></a>
<span class="sourceLineNo">216</span> */<a name="line.216"></a>
<span class="sourceLineNo">217</span> protected String[] buildPermissions(String[] configuredPerms, String action) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> if (configuredPerms == null || configuredPerms.length &lt;= 0 || !StringUtils.hasText(action)) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return configuredPerms;<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span><a name="line.221"></a>
<span class="sourceLineNo">222</span> String[] mappedPerms = new String[configuredPerms.length];<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> // loop and append :action<a name="line.224"></a>
<span class="sourceLineNo">225</span> for (int i = 0; i &lt; configuredPerms.length; i++) {<a name="line.225"></a>
<span class="sourceLineNo">226</span> mappedPerms[i] = configuredPerms[i] + ":" + action;<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> if (log.isTraceEnabled()) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> StringBuilder sb = new StringBuilder();<a name="line.230"></a>
<span class="sourceLineNo">231</span> for (int i = 0; i &lt; mappedPerms.length; i++) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> if (i &gt; 0) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> sb.append(", ");<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span> sb.append(mappedPerms[i]);<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> log.trace("MAPPED '{}' action to permission(s) '{}'", action, sb);<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> return mappedPerms;<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span> /**<a name="line.243"></a>
<span class="sourceLineNo">244</span> * Resolves an 'application friendly' action verb based on the {@code HttpServletRequest}'s method, appends that<a name="line.244"></a>
<span class="sourceLineNo">245</span> * action to each configured permission (the {@code mappedValue} argument is a {@code String[]} array), and<a name="line.245"></a>
<span class="sourceLineNo">246</span> * delegates the permission check for the newly constructed permission(s) to the superclass<a name="line.246"></a>
<span class="sourceLineNo">247</span> * {@link PermissionsAuthorizationFilter#isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}<a name="line.247"></a>
<span class="sourceLineNo">248</span> * implementation to perform the actual permission check.<a name="line.248"></a>
<span class="sourceLineNo">249</span> *<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @param request the inbound {@code ServletRequest}<a name="line.250"></a>
<span class="sourceLineNo">251</span> * @param response the outbound {@code ServletResponse}<a name="line.251"></a>
<span class="sourceLineNo">252</span> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.<a name="line.252"></a>
<span class="sourceLineNo">253</span> * @return {@code true} if the request should proceed through the filter normally, {@code false} if the<a name="line.253"></a>
<span class="sourceLineNo">254</span> * request should be processed by this filter's<a name="line.254"></a>
<span class="sourceLineNo">255</span> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object)} method instead.<a name="line.255"></a>
<span class="sourceLineNo">256</span> * @throws IOException<a name="line.256"></a>
<span class="sourceLineNo">257</span> */<a name="line.257"></a>
<span class="sourceLineNo">258</span> @Override<a name="line.258"></a>
<span class="sourceLineNo">259</span> public boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws IOException {<a name="line.259"></a>
<span class="sourceLineNo">260</span> String[] perms = (String[]) mappedValue;<a name="line.260"></a>
<span class="sourceLineNo">261</span> // append the http action to the end of the permissions and then back to super<a name="line.261"></a>
<span class="sourceLineNo">262</span> String action = getHttpMethodAction(request);<a name="line.262"></a>
<span class="sourceLineNo">263</span> String[] resolvedPerms = buildPermissions(perms, action);<a name="line.263"></a>
<span class="sourceLineNo">264</span> return super.isAccessAllowed(request, response, resolvedPerms);<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span>}<a name="line.266"></a>
</pre>
</div>
</body>
</html>