| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.authz.permission;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authz.Permission;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * A {@code PermisisonResolver} resolves a String value and converts it into a</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * {@link org.apache.shiro.authz.Permission Permission} instance.</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * <p/></a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * The default {@link WildcardPermissionResolver} should be</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * suitable for most purposes, which constructs {@link WildcardPermission} objects.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * However, any resolver may be configured if an application wishes to use different</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * {@link org.apache.shiro.authz.Permission} implementations.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * <p/></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * A {@code PermissionResolver} is used by many Shiro components such as annotations, property file</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * configuration, URL configuration, etc. It is useful whenever a String representation of a permission is specified</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * and that String needs to be converted to a Permission instance before executing a security check.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p/></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Shiro chooses to support {@link WildcardPermission Wildcardpermission}s by default in almost all components and</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * we do that in the form of the {@link WildcardPermissionResolver WildcardPermissionResolver}. One of the nice</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * things about {@code WildcardPermission}s being supported by default is that it makes it very easy to</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * store complex permissions in the database - and also makes it very easy to represent permissions in JSP files,</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * annotations, etc., where a simple string representation is useful.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * <p/></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * Although this happens to be the Shiro default, you are of course free to provide custom</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * String-to-Permission conversion by providing Shiro components any instance of this interface.</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> *</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @see org.apache.shiro.authz.ModularRealmAuthorizer#setPermissionResolver(PermissionResolver) ModularRealmAuthorizer.setPermissionResolver</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @see org.apache.shiro.realm.AuthorizingRealm#setPermissionResolver(PermissionResolver) AuthorizingRealm.setPermissionResolver</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @see PermissionResolverAware PermissionResolverAware</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @since 0.9</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> */</a> |
| <span class="sourceLineNo">050</span><a id="line.50">public interface PermissionResolver {</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> /**</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * Resolves a Permission based on the given String representation.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param permissionString the String representation of a permission.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @return A Permission object that can be used internally to determine a subject's permissions.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * @throws InvalidPermissionStringException</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * if the permission string is not valid for this resolver.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> */</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> Permission resolvePermission(String permissionString);</a> |
| <span class="sourceLineNo">061</span><a id="line.61"></a> |
| <span class="sourceLineNo">062</span><a id="line.62">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
