| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.authz;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import java.io.Serializable;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.util.Collection;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> /**<a name="line.24"></a> |
| <FONT color="green">025</FONT> * <code>AuthorizationInfo</code> represents a single Subject's stored authorization data (roles, permissions, etc)<a name="line.25"></a> |
| <FONT color="green">026</FONT> * used during authorization (access control) checks only.<a name="line.26"></a> |
| <FONT color="green">027</FONT> * <p/><a name="line.27"></a> |
| <FONT color="green">028</FONT> * Roles are represented as a <code>Collection</code> of Strings<a name="line.28"></a> |
| <FONT color="green">029</FONT> * ({@link java.util.Collection Collection}<{@link String String}>), typically each element being the Role name.<a name="line.29"></a> |
| <FONT color="green">030</FONT> * <p/><a name="line.30"></a> |
| <FONT color="green">031</FONT> * {@link Permission Permission}s are provided in two ways:<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <ul><a name="line.32"></a> |
| <FONT color="green">033</FONT> * <li>A <code>Collection</code> of Strings, where each String can usually be converted into <code>Permission</code><a name="line.33"></a> |
| <FONT color="green">034</FONT> * objects by a <code>Realm</code>'s<a name="line.34"></a> |
| <FONT color="green">035</FONT> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}</li><a name="line.35"></a> |
| <FONT color="green">036</FONT> * <li>A <code>Collection</code> of {@link Permission Permission} objects</li><a name="line.36"></a> |
| <FONT color="green">037</FONT> * </ul><a name="line.37"></a> |
| <FONT color="green">038</FONT> * Both permission collections together represent the total aggregate collection of permissions. You may use one<a name="line.38"></a> |
| <FONT color="green">039</FONT> * or both depending on your preference and needs.<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p/><a name="line.40"></a> |
| <FONT color="green">041</FONT> * Because the act of authorization (access control) is orthoganal to authentication (log-in), this interface is<a name="line.41"></a> |
| <FONT color="green">042</FONT> * intended to represent only the account data needed by Shiro during an access control check<a name="line.42"></a> |
| <FONT color="green">043</FONT> * (role, permission, etc). Shiro also has a parallel<a name="line.43"></a> |
| <FONT color="green">044</FONT> * {@link org.apache.shiro.authc.AuthenticationInfo AuthenticationInfo} interface for use during the authentication<a name="line.44"></a> |
| <FONT color="green">045</FONT> * process that represents identity data such as principals and credentials.<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <p/><a name="line.46"></a> |
| <FONT color="green">047</FONT> * Because many if not most {@link org.apache.shiro.realm.Realm Realm}s store both sets of data for a Subject, it might be<a name="line.47"></a> |
| <FONT color="green">048</FONT> * convenient for a <code>Realm</code> implementation to utilize an implementation of the<a name="line.48"></a> |
| <FONT color="green">049</FONT> * {@link org.apache.shiro.authc.Account Account} interface instead, which is a convenience interface that combines both<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <code>AuthenticationInfo</code> and <code>AuthorizationInfo</code>. Whether you choose to implement these two<a name="line.50"></a> |
| <FONT color="green">051</FONT> * interfaces separately or implement the one <code>Account</code> interface for a given <code>Realm</code> is<a name="line.51"></a> |
| <FONT color="green">052</FONT> * entirely based on your application's needs or your preferences.<a name="line.52"></a> |
| <FONT color="green">053</FONT> *<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @see org.apache.shiro.authc.AuthenticationInfo AuthenticationInfo<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @see org.apache.shiro.authc.Account<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @since 0.9<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> public interface AuthorizationInfo extends Serializable {<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * Returns the names of all roles assigned to a corresponding Subject.<a name="line.61"></a> |
| <FONT color="green">062</FONT> *<a name="line.62"></a> |
| <FONT color="green">063</FONT> * @return the names of all roles assigned to a corresponding Subject.<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> Collection<String> getRoles();<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> /**<a name="line.67"></a> |
| <FONT color="green">068</FONT> * Returns all string-based permissions assigned to the corresponding Subject. The permissions here plus those<a name="line.68"></a> |
| <FONT color="green">069</FONT> * returned from {@link #getObjectPermissions() getObjectPermissions()} represent the total set of permissions<a name="line.69"></a> |
| <FONT color="green">070</FONT> * assigned. The aggregate set is used to perform a permission authorization check.<a name="line.70"></a> |
| <FONT color="green">071</FONT> * <p/><a name="line.71"></a> |
| <FONT color="green">072</FONT> * This method is a convenience mechanism that allows Realms to represent permissions as Strings if they choose.<a name="line.72"></a> |
| <FONT color="green">073</FONT> * When performing a security check, a <code>Realm</code> usually converts these strings to object<a name="line.73"></a> |
| <FONT color="green">074</FONT> * {@link Permission Permission}s via an internal<a name="line.74"></a> |
| <FONT color="green">075</FONT> * {@link org.apache.shiro.authz.permission.PermissionResolver PermissionResolver}<a name="line.75"></a> |
| <FONT color="green">076</FONT> * in order to perform the actual permission check. This is not a requirement of course, since <code>Realm</code>s<a name="line.76"></a> |
| <FONT color="green">077</FONT> * can perform security checks in whatever manner deemed necessary, but this explains the conversion mechanism that<a name="line.77"></a> |
| <FONT color="green">078</FONT> * most Shiro Realms execute for string-based permission checks.<a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @return all string-based permissions assigned to the corresponding Subject.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> Collection<String> getStringPermissions();<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> /**<a name="line.84"></a> |
| <FONT color="green">085</FONT> * Returns all type-safe {@link Permission Permission}s assigned to the corresponding Subject. The permissions<a name="line.85"></a> |
| <FONT color="green">086</FONT> * returned from this method plus any returned from {@link #getStringPermissions() getStringPermissions()}<a name="line.86"></a> |
| <FONT color="green">087</FONT> * represent the total set of permissions. The aggregate set is used to perform a permission authorization check.<a name="line.87"></a> |
| <FONT color="green">088</FONT> *<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @return all type-safe {@link Permission Permission}s assigned to the corresponding Subject.<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> Collection<Permission> getObjectPermissions();<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
